Полное руководство. С# 4.0

В этой строке кода объявляется индексатор, оперирующий элементами типа 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]: 1fs[2]: 2fs[1.1]: 1fs[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.Многомерные индексаторы

Индексаторы можно создавать и для многомерных массивов. В качестве примераниже приведен двумерный отказоустойчивый массив. Обратите особое внимание наобъявление индексатора в этом примере.// Двумерный отказоустойчивый массив.using System;class FailSoftArray2D { int[,] a; // ссылка на базовый двумерный массив int rows, cols; // размеры массива public int Length; // открытая переменная длины массива public bool ErrFlag; // обозначает результат последней операции // Построить массив заданных размеров. public FailSoftArray2D(int r, int с) { rows = r; cols = с; а = new int[rows, cols]; Length = rows * cols; } // Это индексатор для класса FailSoftArray2D. public int this[int index1, int index2] { // Это аксессор get. get { if(ok(index1, index2)) { ErrFlag = false; return a[index1, index2]; } else { ErrFlag = true; return 0; } } // Это аксессор set. set { if(ok(index1, index2)) { a[index1, index2] = value; ErrFlag = false; } else ErrFlag = true; } } // Возвратить логическое значение true, если // индексы находятся в установленных пределах. private bool ok(int index1, int index2) { if (index1 >= 0 & index1 < rows & index2 >= 0 & index2 < cols) return true; return false; }}// Продемонстрировать применение двумерного индексатора.class TwoDIndexerDemo { static void Main() { FailSoftArray2D fs = new FailSoftArray2D(3, 5); int x; // Выявить скрытые сбои. Console.WriteLine("Скрытый сбой."); for (int i=0; i < 6; i++) fs[i, i] = i*10; for(int i=0; i < 6; i++) { x = fs[i,i]; if(x != -1) Console.Write(x + " "); } Console.WriteLine(); // А теперь показать сбои. Console.WriteLine("nСбой с уведомлением об ошибках."); for(int i=0; i < 6; i++) { fs[i,i] = i*10; if(fs.ErrFlag) Console.WriteLine("fs[" + i + ", " + i + "] вне границ"); } for(int i=0; i < 6; i++) { x = fs[i,i]; if(!fs.ErrFlag) Console.Write(x + " "); else Console.WriteLine("fs[" + i + ", " + i + "] вне границ"); } }}