Index

フェーズ: Using

• - getCollection
  getCollectionはインデックスが参照するコレクションを返します。このコレクションは、そのインデックスが存続する間、変更されることはありません。

• - next
  nextメッセージは、現在位置の次にある有効なメンバあるいはすべての有効なメンバの後ろの特別な位置にインデックスを位置づけます。どちらの場合でも、インデックスを位置づけた後、位置づけられた新しいメンバ値を返し、あるいはそのようなメンバが存在しないときはnilを返します。

• - prev
  prevメッセージもnextと似たような動作をしますが、現在位置の前の有効なメンバ、あるいはすべての有効なメンバの前の特別な位置に、インデックスを位置づけます。

• - findNext: anObject
  findNext:は、インデックスのメンバ値が引数にマッチするまでnextを繰り返します。引数にマッチしないまま有効なメンバの終端に達すると、nilが返ります。

• - findPrev: anObject
  findPrev:は、インデックスのメンバ値が引数にマッチするまでprevを繰り返します。引数にマッチしないままインデックスが有効なメンバの先頭に達すると、nilが返ります。

• - get
  getはインデックスが現在位置づけられているメンバ値を返します。インデックスがメンバに位置づけられていない場合はnilを返します。
  getメッセージは、コレクションをトラバースするループの中で現在のメンバ値を取得する代替方法です。戻り値は、nextやprevが新しいメンバの最初の位置づけで返すものと同じです。

• - put: anObject
  put:メッセージは、現在のインデックス位置のメンバの値をその引数で置き換えます。インデックスが現在のメンバに位置づけられていない場合、InvalidIndexLocエラーが生じます。

• - remove
  removeメッセージはインデックスの現在の位置のメンバを削除し、削除されたメンバ値を返します。インデックス位置は、削除されたメンバの後ろのメンバと前のメンバの間の特別な位置にセットされます。続くメンバや先のメンバがないときは、すべてのメンバの終端の後ろ、あるいは開始位置の前の特別な位置にセットされます。現在のメンバが削除されると、現在のインデックス位置にメンバはいなくなりますが、それに続くnextまたはprevメッセージは、現在のメンバが削除されていないかのように動作します。インデックスが現在のメンバに位置づけられていないと、InvalidIndexLocが生じます。

• - getLoc
  getLocメッセージは、インデックスが現在位置づけられている位置の型を示すシンボル定数を返します。このインデックス位置シンボルは、Start、End、
  Memberのどれかを持ちます。
  Startシンボルは、そのコレクションの列挙シーケンスにあるすべてのメンバの前の特別な位置を示します。つまり、インデックスが最初に作成されたときの位置です。Endシンボルはそのコレクションのすべてのメンバに続く特別な位置、つまりnextメッセージによって最後のメンバを越えて移動し、nilが返されたときのインデックスの位置を示します。Memberシンボルは、コレクションの列挙シーケンス内の、ある現在のメンバに位置づけられていることを示します。
  nil値を持つメンバが存在するはずのコレクションをトラバースするときは、getLocメッセージが必要になります。getLocを使わないとnextが返したnil値が有効なメンバ値なのか、あるいはメンバの終端で返された特別な値なのか区別する方法はありません。getLocを使えば、コレクションをトラバースするループにメンバの終端(または開始位置)をテストするルーチンを加えることができます。

  Example collections/Index/-getLoc/1.

  以下はその利用法を示すシンプルなループです:

  { id <Index> index = [aCollection begin: aZone]; id member; for (member = [index next]; [index getLoc] == Member; member = [index next]) { // そのメンバで何か作業をする ... } [index drop]; }

• - (void)setLoc: locSymbol
  setLoc:メッセージは、インデックスの現在位置をStartかEndにリセットするのに使用します。このメッセージは、コレクションの中間のメンバに位置づけられたインデックスを初期位置に戻して、再処理するのに使用できます。また、prevでメンバを逆順にトラバースするのに先立って、すべてのメンバの終端にインデックスを位置づけるのにも使用できます。
  setLoc:はStartとEndに加え、BetweenAfterとBetweenBeforeというシンボルが定義される特別な引数値を受けつけます。これらの引数値はインデックスが現在のメンバに位置づけられている場合にのみ有効で、現在のメンバとその直後または直前のメンバの間の特別な位置にインデックスを位置づけます。

• - (int)getOffset
  計算上の犠牲が大きくならなければ、インデックスは、コレクションの列挙シーケンスにおける現在のメンバのオフセットを整数で管理します。これらの整数オフセット値は、CollectionのatOffset:メッセージのそれと同じ定義を持っています。getOffsetメッセージは、この現在のオフセット値を返します。現在のインデックスがStartやEndに位置づけられているならgetOffsetは-1を返し、Betweenに位置づけらていれば直前のメンバのオフセットを返します。また、現在そのインデックスからオフセットが利用できないなら、getOffsetは特別な値UnknownOffsetを返します。この値はマクロに定義されるもので、32-bitの2の補数表現による負数を最大に取ります。
  最初のStartやEnd位置から繰り返された操作によって現在のインデックスの位置に至っており、その基礎となるコレクションに他の変更が無かった場合、常にそのインデックスからオフセットが利用できます。しかし、いくつかのインデックス型がサポートする直接的なメンバアクセス操作では、結果的に利用できない整数オフセットをもたらすものもあります。これらの制限については個々のindex型で説明します。

• - setOffset: (int)offset
  setOffset:メッセージを使うと、その列挙シーケンス内のメンバのオフセットを使って、そのメンバに直接的にインデックスが位置づけられます。この操作の処理速度は、CollectionのatOffset:メッセージで説明したように、コレクションの型に依存します。最悪の場合この処理速度はオフセットの大きさに比例します。

• - (int)compare: anIndex
  compare:メッセージは、1つのインデックスの現在の位置と、その引数として渡された別のインデックスの現在の位置を比較します。2つのインデックスが同じ位置にあればcompare:はゼロを返し、そうでなければそのコレクションの列挙シーケンスにおいて、引数のインデックスが受け取り側インデックスの前にあるか後ろにあるかに応じ、+1または-1を返します。2つのインデックスのどちらかのオフセットが未知であるとき、他方のインデックスの位置がStartやEnd以外、あるいはメンバの直近にあれば、compare:はUnknownOffset整数値を返します。