C# для чайников

Термины итератор (iterator) и перечислитель (enumerator) являются синони­ мами. Термин итератор более распространен, несмотря на имя реализуемого им интерфейса. От обоих терминов можно произвести глагольную форму —вы можете итерировать контейнер, а можете перечислять. Другими подходами к решению этой же задачи являются индексаторы и новые блоки итераторов.

Доступ к коллекции: общая задача

Различные типы коллекций могут иметь разные схемы доступа. Не все виды коллекции могут быть эффективно доступны с использованием индексов наподобие массивов — та ков, например, связанный список. Различия между типами коллекций делают невозможным написание без специальных средств функции наподобие приведенной далее:

Коллекции каждого типа могут сами определять свои методы доступа (и делают это).

Более общий подход состоит в предоставлении для каждого класса коллекции от­ дельного так называемого класса итератора, который знает, как работать с конкретной коллекцией. Каждая коллекция X определяет свой собственный класс I t e r a t o r X . В от­ личие от X, I t e r a t o r X представляет общий интерфейс I E n u m e r a t o r , золотой стан­ дарт итерирования. Этот метод использует второй объект, именуемый итератором, в ка­ честве указателя внутрь коллекции.

Итератор (перечислитель) обладают следующими преимуществами.

Каждый класс коллекции может определить свой собственный класс итератора. Поскольку итератор реализует стандартный интерфейс I E n u m e r a t o r , с ним обычно легко работать.

Прикладной код не должен знать о внутреннем устройстве коллекций. Пока про­ граммист работает с итератором, тот берет на себя все заботы о деталях. Это — хорошая инкапсуляция.

Прикладной код может создать много независимых объектов-итераторов для од­ ной и той же коллекции. Поскольку итератор содержит информацию о своем соб­ ственном состоянии (знает, где он находится в процессе итерирования), каждый итератор может независимо проходить по коллекции. Вы можете одновременно выполнять несколько итераций, причем в один и тот же момент все они могут на­ ходиться в разных позициях.

Чтобы сделать возможным наличие цикла f o r e a c h , интерфейс I E n u m e r a t o r должен поддерживать различные типы коллекций — от массивов до связанных списков. Следова­ тельно, его методы должны быть максимально обобщенными, насколько это возможно. Например, нельзя использовать итератор для произвольного доступа к элементам коллек­ ции, поскольку большинство коллекций не обеспечивают подобного доступа.

Использование foreach

Методы I E n u m e r a t o r достаточно стандартны для того, чтобы С# использовали их автоматически для реализации конструкции f o r e a c h .

Цикл f o r e a c h может обращаться к любому классу, реализующему интерфейс I E n u m e r a b l e , как показано в приведенной обобщенной функции, которая может работать с любым классом — от массивов и связанных списков до стеков и очередей:

Класс реализует I E n u m e r a b l e путем определения метода G e t E n u m e r a t o r ( ) , который возвращает экземпляр I E n u m e r a t o r . Скрыто от посторонних глаз f o r e a c h вызывает метод G e t E n u m e r a t o r () для получения итератора. Цикл ис­ пользует этот итератор для обхода контейнера. Каждый выбираемый им элемент приводится к соответствующему типу перед тем, как продолжить выполнение тела

// ...

}

{

M o v e N e x t () для определения конца контейнера. M o v e N e x t () сам увеличивает указа­ тель, т.е. раздел инкремента цикла пуст. (Тем не менее, вам все равно следует указать точку с запятой после раздела условия, после которой не следует никакой код. В приве­ денном фрагменте исходного текста это точка с запятой после i . M o v e N e x t ().) В пер­ вой строке цикла выбирается очередной объект и преобразуется к i n t ( C u r r e n t всегда возвращает тип O b j e c t ) . Если возвращенный объект не является i n t , С# генерирует исключение неверного преобразования типа.

Обращение к элементам массива очень простое и понятное: команда c o n t a i n e r [п] обеспечивает обращение к и-му элементу массива c o n t a i n e r . Было бы хорошо, если бы так же просто можно было обращаться и к другим типам коллекций.

С# позволяет написать вам свою собственную реализацию операции индексирова­ ния. Вы можете обеспечить возможностью обращения через индекс коллекции, кото­ рые таким свойством изначально не обладают. Кроме того, вы можете индексировать с использованием в качестве индексов не только типа i n t , но и других типов, напри­ мер, s t r i n g .

Формат индексатора

Индексатор выглядит очень похоже на свойство, за тем исключением, что в нем вме­ сто имени свойства появляются ключевое слово t h i s и оператор индекса [ ] :

c l a s s MyArray

{

p u b l i c s t r i n g t h i s [ i n t i n d e x ] / / О б р а т и т е в н и м а н и е н а

вая ей значение индекса i. Выражение myAr r a y [ i ] = " с т р о к а " ; приводит к вызову функции доступа s e t , которой передаются индекс i и строка " с т р о к а " .

Пример программы с использованием индексатора

Индексы не ограничены типом i n t . Например, вы можете использовать для индек­ сирования коллекции домов имена их владельцев или адреса. Кроме того, свойство ин­ дексатора может быть перегружено для различных типов индекса.

Приведенная далее демонстрационная программа I n d e x e r генерирует класс виртуального массива K e y e d A r r a y , который выглядит и функциони­ рует точно так же, как и обычный массив, с тем исключением, что в качестве его индексов применяется значение типа s t r i n g .

/ / I n d e x e r - д а н н а я д е м о н с т р а ц и о н н а я п р о г р а м м а и л л ю с т р и р у е т / / и с п о л ь з о в а н и е о п е р а т о р а и н д е к с а д л я о б е с п е ч е н и я д о с т у п а к / / м а с с и в у с и с п о л ь з о в а н и е м с т р о к в к а ч е с т в е и н д е к с о в

/ / o b j e c t п р е д с т а в л я е т с о б о й р е а л ь н ы е д а н н ы е , с в я з а н н ы е

//с к л ю ч о м

}

}

r e t u r n - 1 ;

}

/ / F i n d E m p t y - п о и с к с в о б о д н о г о м е с т а в м а с с и в е д л я / / н о в о й з а п и с и

/ / и н д е к с а т о р public object this[string sKey]

{

s e t

{

/ / П р о в е р я е м , н е т л и т у ж е т а к о й с т р о к и i n t i n d e x = F i n d ( s K e y ) ;

i f ( i n d e x < 0 )

{

/ / Е с л и н е т - и щ е м н о в о е м е с т о i n d e x = F i n d E m p t y ( ) ;

s K e y s [ i n d e x ] = s K e y ;

}

{

{

/ / О ж и д а е м п о д т в е р ж д е н и я п о л ь з о в а т е л я

C o n s o l e . W r i t e L i n e ( " Н а ж м и т е < E n t e r > д л я " +

" з а в е р ш е н и я п р о г р а м м ы . . . " ) ;

C o n s o l e . R e a d ( ) ;

Класс K e y e d A r r a y включает два обычных массива. Массив o A r r a y E l e m e n t s со­ держит реальные данные K e y e d A r r a y . Строки, которые хранятся в массиве s K e y s , ра­ ботают в качестве идентификаторов массива объектов, г'-ый элемент s K e y s соответству­ ет /-ой записи o A r r a y E l e m e n t s . Это позволяет прикладной программе индексировать K e y e d A r r a y с п о м о щ ь ю индексов типа s t r i n g .

Индексы, не являющиеся целыми числами, известны как ключи (key). Кстати, можно реализовать K e y e d A r r a y с использованием L i s t < T > (см. гла ву 15, "Обобщенное программирование") вместо массива фиксированного размера. L i s t < T > индексируется, как и массив, так как они оба реализуют интерфейс I L i s t (или I L i s t < T > ) . Это позволит сделать KeyedArray обобщенным классом и получить большую гибкость, чем при использова­ нии внутреннего массива.

Индексатор s e t [ s t r i n g ] начинает с проверки, не имеется ли уже данного индекса

m e n t s . Ели F i n d () не может найти ключ, s e t [] вызывает F i n d E m p t y () для возвра­ та пустого элемента, где и будет сохранен переданный объект.

Функция g e t [] работает с индексом с применением аналогичной логики. Сначала она ищет определенный ключ с использованием метода F i n d О . Если F i n d () возвращает не­ отрицательный индекс, g e t [] возвращает соответствующий член o A r r a y E l e m e n t s , где хранятся запрошенные данные. Если же F i n d О возвращает -1, то метод g e t [] возвра­ щает значение n u l l , указывающее, что переданный ключ в списке отсутствует.

Метод F i n d () циклически проходит по всем элементам массива s K e y s в поисках элемента с тем же значением, что и переданное значение типа s t r i n g . Метод F i n d ( ) возвращает индекс найденного элемента (или значение -1, если элемент не найден). Функция F i n d E m p t y () возвращает индекс первого элемента, который не имеет связан­ ного ключевого элемента.

При написании методов F i n d ( ) и F i n d E m p t y () не ставилась цель повысить их эффективность, так что имеется множество возможностей сделать их быстрее, но все они не имеют никакого отношения к индексаторам.

Правда, было бы здорово добавить возможность индексирования к классу связанного списка L i n k e d L i s t ? Да, это можно сделать. Но вспомните, что даже в классе KeyedAr­ r a y требуется проход по массиву s K e y s для поиска определенного ключа, а значит, и функций F i n d () и F i n d E m p t y ( ) , которые этим занимаются. Точно так же при реа­ лизации индексатора для L i n k e d L i s t вам придется осуществлять проход по всему свя­ занному списку, и единственный способ сделать это — пройти по всему списку с исполь­ зованием итератора L i n k e d L i s t l t e r a t o r , следуя по ссылкам f o r w a r d от узла к уз­ лу. Индексатор окажется удобным, но очень медлительным.

Заметьте, что вы не можете удалять элементы посредством ключа n u l l . Как же реа­ лизовать удаление? Как часто говорится в учебниках — "данная задача остается читате­ лю в качестве домашнего упражнения".

Функция M a i n () демонстрирует применение индексатора. Сначала программа соз­ дает объект та типа K e y e d A r r a y длины 100 (т.е. со 100 свободными элементами). Да­ лее в этом объекте сохраняется возраст детей семьи Симпсонов с использованием имен в качестве индексов. И наконец, программа получает возраст Лизы с применением вы­ ражения ma [" L i s a " ] и выводит его на экран.

Обратите внимание, что программа должна выполнить преобразование типа для зна­ чения, возвращенного из та [ ] , так как K e y e d A r r a y написан таким образом, что может хранить объекты любого типа. Без такого преобразования типов можно обойтись, если индексатор написан так, что может работать только со значениями типа i n t , или если K e y e d A r r a y — обобщенный класс (см. главу 15, "Обобщенное программирование").

В создаваемых классах коллекций можно предоставить блок итератора (iterate block) вместо написания собственного класса итератора для поддержки коллекции.

Можно использовать блок итератора и для других рутинных работ.

Этот новый подход применяет блоки итераторов. Когда вы пишете класс коллекции, такой как K e y e d L i s t или P r i o r i t y Q u e u e — вы реализуете блок итератора вместо реализации интерфейса I E n u m e r a t o r . Затем пользователи этого класса могут просто итерировать коллекцию с помощью цикла f o r e a c h . Приготовьтесь расстаться с частью вашего драгоценного времени, чтобы ознакомиться с несколькими вариантами блоков итераторов.

Все примеры в этом разделе являются частью демонстрационной програм­ мы I t e r a t o r B l o c k s на прилагаемом компакт-диске.

/ / I t e r a t o r B l o c k s - д е м о н с т р а ц и я п р и м е н е н и я б л о к о в / / и т е р а т о р о в д л я н а п и с а н и я и т е р а т о р о в к о л л е к ц и й

u s i n g S y s t e m ;

c l a s s I t e r a t o r B l o c k s

{

/ / M a i n - д е м о н с т р а ц и я п я т и р а з л и ч н ы х п р и л о ж е н и й б л о к о в / / и т е р а т о р о в

s t a t i c v o i d M a i n ( s t r i n g [ ] a r g s )

{

/ / И т е р и р о в а н и е м е с я ц е в г о д а , в ы в о д к о л и ч е с т в а д н е й в / / к а ж д о м и з н и х

M o n t h D a y s m d = n e w M o n t h D a y s ( ) ; / / И т е р и р у е м

C o n s o l e . W r i t e L i n e ( " М е с я ц ы : \ n " ) ; f o r e a c h ( s t r i n g s M o n t h i n md)

{

C o n s o l e . W r i t e L i n e ( s M o n t h ) ;

}

/ / И т е р и р у е м к о л л е к ц и ю с т р о к

S t r i n g C h u n k s s c = n e w S t r i n g C h u n k s ( ) ;

/ / И т е р и р у е м - в ы в о д и м т е к с т , п о м е щ а я к а ж д ы й ф р а г м е н т / / в с в о е й с о б с т в е н н о й с т р о к е

C o n s o l e . W r i t e L i n e ( " \ С т р о к и : \ п " ) ; f o r e a c h ( s t r i n g s C h u n k i n s c )

{

C o n s o l e . W r i t e L i n e ( s C h u n k ) ;

}

/ / А т е п е р ь в ы в о д и м и х в о д н у с т р о к у

C o n s o l e . W r i t e L i n e ( " \ п В ы в о д в о д н у с т р о к у : \ п " ) ; f o r e a c h ( s t r i n g s C h u n k i n s c )

{

C o n s o l e . W r i t e ( s C h u n k ) ;

}

C o n s o l e . W r i t e L i n e ( ) ;

/ / И т е р и р у е м п р о с т ы е ч и с л а д о 1 3

/ / G e t E n u m e r a t o r - э т о и е с т ь и т е р а т о р

p u b l i c S y s t e m . C o l l e c t i o n s . I E n u m e r a t o r G e t E n u m e r a t o r ( )

{

f o r e a c h ( s t r i n g s M o n t h i n m o n t h s )

{

/ / G e t E n u m e r a t o r - и т е р а т о р . О б р а т и т е в н и м а н и е , к а к о н / / ( д в а ж д ы ) в ы з ы в а е т с я в M a i n