Полное руководство. С# 4.0
Шрифт:
Ниже приведена общая форма одномерного индексатора: тип_элемента this[int индекс] { // Аксессор для получения данных. get { // Возврат значения, которое определяет индекс. } // Аксессор для установки данных. set { // Установка значения, которое определяет индекс. } }
где типэлемента обозначает конкретный тип элемента индексатора. Следовательно, у каждого элемента, доступного с помощью индексатора, должен быть определенный типэлемента. Этот тип соответствует типу элемента массива. Параметр индекс по лучает конкретный индекс элемента, к которому осуществляется доступ. Формально этот параметр совсем не обязательно должен иметь тип int, но поскольку индексато ры, как правило, применяются для индексирования массивов, то чаще всего использу ется целочисленный тип данного параметра.
В теле индексатора определены два аксессора (т.е. средства доступа к данным): get и set. Аксессор подобен методу, за исключением того, что в нем не объявляется тип возвращаемого значения или параметры. Аксессоры вызываются автоматически при использовании индексатора, и оба
Преимущество индексатора заключается, в частности, в том, что он позволяет пол ностью управлять доступом к массиву, избегая нежелательного доступа. В качестве примера рассмотрим программу, в которой создается класс FailSoftArray, реали зующий массив для выявления ошибок нарушения границ массива, а следовательно, для предотвращения исключительных ситуаций, возникающих во время выполнения в связи с индексированием массива за его границами. Для этого массив инкапсулиру ется в качестве закрытого члена класса, а доступ к нему осуществляется только с помо щью индексатора. При таком подходе исключается любая попытка получить доступ к массиву за его границами, причем эта попытка пресекается без катастрофических последствий для программы. А поскольку в классе FailSoftArray используется ин дексатор, то к массиву можно обращаться с помощью обычной формы записи. // Использовать индексатор для создания отказоустойчивого массива. using System; class FailSoftArray { int[] a; // ссылка на базовый массив public int Length; // открытая переменная длины массива public bool ErrFlag; // обозначает результат последней операции // Построить массив заданного размера. public FailSoftArray(int size) { a = new int[size]; Length = size; } // Это индексатор для класса FailSoftArray. public int this[int index] { // Это аксессор get. get { if(ok(index)) { ErrFlag = false; return a[index]; } else { ErrFlag = true; return 0; } } // Это аксессор set. set { if(ok(index)) { a[index] = value; ErrFlag = false; } else ErrFlag = true; } } // Возвратить логическое значение true, если // индекс находится в установленных границах. private bool ok(int index) { if(index >= 0 & index < Length) return true; return false; } } // Продемонстрировать применение отказоустойчивого массива. class FSDemo { static void Main { FailSoftArray fs = new FailSoftArray(5); int x; // Выявить скрытые сбои. Console.WriteLine("Скрытый сбой."); for(int i=0; i < (fs.Length * 2); i++) fs[i] = i*10; for(int i=0; i < (fs.Length * 2); i++) { x = fs[i]; if(x != -1) Console.Write(x + " "); } Console.WriteLine; // А теперь показать сбои. Console.WriteLine("\nСбой с уведомлением об ошибках."); for (int i=0; i < (fs.Length * 2); i++) { fs[i] = i * 10; if(fs.ErrFlag) Console.WriteLine("fs[" + i + "] вне границ"); } for(int i=0; i < (fs.Length * 2); i++) { x = fs[i]; if(!fs.ErrFlag) Console.Write(x + " "); else Console.WriteLine("fs[" + i + "] вне границ"); } } }
Вот к какому результату приводит выполнение этой программы. Скрытый сбой. 0 10 20 30 40 0 0 0 0 0 Сбой с уведомлением об ошибках. fs[5] вне границ fs[6] вне границ fs[7] вне границ fs[8] вне границ fs[9] вне границ 0 10 20 30 40 fs[5] вне границ fs[6] вне границ fs[7] вне границ fs[8] вне границ fs[9] вне границ
Индексатор препятствует нарушению границ массива. Внимательно проанализи руем каждую часть кода индексатора. Он начинается со следующей строки. public int this[int index] {
В этой строке кода объявляется индексатор, оперирующий элементами типа int. Ему передается индекс в качестве параметра index. Кроме того, индексатор объявля ется открытым (public), что дает возможность использовать этот индексатор в коде за пределами его класса.
Рассмотрим следующий код аксессора get. get { if(ok(index)) { ErrFlag = false; return a[index]; } else { ErrFlag = true; return 0; } }
Аксессор get предотвращает ошибки нарушения границ массива, проверяя в пер вую очередь, находится ли индекс в установленных границах. Эта проверка границ вы полняется в методе ok, который возвращает логическое значение true, если индекс правильный, а иначе — логическое значение false. Так, если указанный индекс на ходится б установленных границах, то по этому индексу возвращается соответствую щий элемент. А если индекс оказывается вне установленных границ, то никаких опе раций не выполняется, но в то же время не возникает никаких ошибок переполнения. В данном варианте класса FailSoftArray переменная ErrFlag содержит результат каждой операции. Ее содержимое может быть проверено после каждой операции на предмет удачного или неудачного выполнения последней. (В главе 13 будет представ лен более совершенный способ обработки ошибок с помощью имеющейся в C# под системы обработки исключительных ситуаций, а до тех пор можно вполне обойтись установкой и проверкой признака ошибки.)
А теперь рассмотрим следующий код аксессора set, предотвращающего ошибки нарушения границ массива. set { if(ok(index)) { a[index] = value; ErrFlag = false; } else ErrFlag = true; }
Если параметр index метода ok находится в установленных пределах, то соот ветствующему элементу массива присваивается значение, передаваемое из параметра value. В противном случае устанавливается логическое значение true переменной ErrFlag. Напомним, что value в любом аксессорном методе является неявным пара метром,
содержащим присваиваемое значение. Его не нужно (да и нельзя) объявлять отдельно.Наличие обоих аксессоров, get и set, в индексаторе не является обязательным. Так, можно создать индексатор только для чтения, реализовав в нем один лишь аксес сор get, или же индексатор только для записи с единственным аксессором set. Перегрузка индексаторов
Индексатор может быть перегружен. В этом случае для выполнения выбирается тот вариант индексатора, в котором точнее соблюдается соответствие его параметра и аргумента, указываемого в качестве индекса. Ниже приведен пример программы, в ко торой индексатор массива класса FailSoftArray перегружается для индексов типа double. При этом индексатор типа double округляет свой индекс до ближайшего целого значения. // Перегрузить индексатор массива класса FailSoftArray. using System; class FailSoftArray { int[] a; // ссылка на базовый массив public int Length; // открытая переменная длины массива public bool ErrFlag; // обозначает результат последней операции // Построить массив заданного размера. public FailSoftArray(int size) { a = new int[size]; Length = size; } // Это индексатор типа int для массива FailSoftArray. public int this[int index] { // Это аксессор get. get { if(ok(index)) { ErrFlag = false; return a[index]; } else { ErrFlag = true; return 0; } } // Это аксессор set. set { if(ok(index)) { a[index] = value; ErrFlag = false; } else ErrFlag = true; } } /* Это еще один индексатор для массива FailSoftArray. Он округляет свой аргумент до ближайшего целого индекса. */ public int this[double idx] { // Это аксессор get. get { int index; // Округлить до ближайшего целого. if( (idx - (int) idx) < 0.5) index = (int) idx; else index = (int) idx + 1; if(ok(index)) { ErrFlag = false; return a[index]; } else { ErrFlag = true; return 0; } } // Это аксессор set. set { int index; // Округлить до ближайшего целого. if( (idx - (int) idx) < 0.5) index = (int) idx; else index = (int) idx + 1; if(ok(index)) { a[index] = value; ErrFlag = false; } else ErrFlag = true; } } // Возвратить логическое значение true, если // индекс находится в установленных границах. private bool ok(int index) { if (index >= 0 & index < Length) return true; return false; } } // Продемонстрировать применение отказоустойчивого массива. class FSDemo { static void Main { FailSoftArray fs = new FailSoftArray(5); // Поместить ряд значений в массив fs. for(int i=0; i < fs.Length; i++) fs[i] = i; // А теперь воспользоваться индексами // типа int и double для обращения к массиву. Console.WriteLine("fs[1] : " + fs[1]); Console.WriteLine("fs[2] : " + fs[2]); Console.WriteLine("fs[1.1]: " + fs[l.l]); Console.WriteLine("fs[1.6]: " + fs[1.6]); } }
При выполнении этой программы получается следующий результат. fs[1]: 1 fs[2]: 2 fs[1.1]: 1 fs[1.6]: 2
Как показывает приведенный выше результат, индексы типа double округляются до ближайшего целого значения. В частности, индекс 1.1 округляется до 1, а индекс 1.6 — до 2.
Представленный выше пример программы наглядно демонстрирует правомоч ность перегрузки индексаторов, но на практике она применяется нечасто. Как прави ло, индексаторы перегружаются для того, чтобы использовать объект определенного класса в качестве индекса, вычисляемого каким-то особым образом. Индексаторы без базового массива
Следует особо подчеркнуть, что индексатор совсем не обязательно должен опери ровать массивом. Его основное назначение — предоставить пользователю функцио нальные возможности, аналогичные массиву. В качестве примера в приведенной ниже программе демонстрируется индексатор, выполняющий роль массива только для чте ния, содержащего степени числа 2 от 0 до 15. Обратите внимание на то, что в этой программе отсутствует конкретный массив. Вместо этого индексатор просто вычисляет подходящее значение для заданного индекса. // Индексаторы совсем не обязательно должны оперировать отдельными массивами. using System; class PwrOfTwo { /* Доступ к логическому массиву, содержащему степени числа 2 от 0 до 15. */ public int this[int index] { // Вычислить и возвратить степень числа 2. get { if((index >= 0) && (index < 16)) return pwr(index); else return -1; } // Аксессор set отсутствует. } int pwr(int p) { int result = 1; for(int i=0; i < p; i++) result *= 2; return result; } } class UsePwrOfTwo { static void Main { PwrOfTwo pwr = new PwrOfTwo; Console.Write("Первые 8 степеней числа 2: "); for(int i=0; i < 8; i++) Console.Write(pwr[i] + " "); Console.WriteLine; Console.Write("А это некоторые ошибки: "); Console.Write(pwr[-1] + " " + pwr[17]); Console.WriteLine; } }
Вот к какому результату приводит выполнение этой программы. Первые 8 степеней числа 2: 1 2 4 8 16 32 64 128 А это некоторые ошибки: -1 -1
Обратите внимание на то, что в индексатор класса PwrOfTwo включен только аксес сор get, но в нем отсутствует аксессор set. Как пояснялось выше, такой индексатор служит только для чтения. Следовательно, объект класса PwrOfTwo может указываться только в правой части оператора присваивания, но не в левой его части. Например, попытка ввести следующую строку кода в приведенную выше программу не приведет к желаемому результату. pwr[0] = 11; // не подлежит компиляции
Такой оператор присваивания станет причиной появления ошибки во время ком пиляции, поскольку для индексатора не определен аксессор set.
На применение индексаторов накладываются два существенных ограничения. Во-первых, значение, выдаваемое индексатором, нельзя передавать методу в качестве параметра ref или out, поскольку в индексаторе не определено место в памяти для его хранения. И во-вторых, индексатор должен быть членом своего класса и поэтому не может быть объявлен как static. Многомерные индексаторы