org.abora.white.arrange
Class Arrangement

java.lang.Object
  |
  +--org.abora.white.xpp.basic.Heaper
        |
        +--org.abora.white.arrange.Arrangement

Direct Known Subclasses:

ExplicitArrangement, IntegerArrangement

public abstract class Arrangement

extends Heaper

Generally represents a pair of an OrderSpec and a Region. Arrangements map between regions and primArrays.

Constructor Summary

protected	Arrangement()
protected	Arrangement(Rcvr receiver)

Method Summary

int	actualHashForEqual() Defined by subclasses to produce the value returned by hashForEqual.
void	copyElements(PrimArray toArray, Dsp toDsp, PrimArray fromArray, Arrangement fromArrange, XnRegion fromRegion) Copy elements into toArray arranged according to the receiver.
abstract IntegerValue	indexOf(Position position) Return the index of position into my Region according to my OrderSpec.
abstract IntegerRegion	indicesOf(XnRegion region) Return the region of all the indices corresponding to positions in region.
abstract XnRegion	keysOf(int start, int stop) Return the region that corresponds to a range of indices.
abstract XnRegion	region() The region of positions in the arrangement
void	sendSelfTo(Xmtr xmtr)

Methods inherited from class org.abora.white.xpp.basic.Heaper

destroy, destruct, equals, hashForEqual, isEqual, printContentsOn, printOn, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Arrangement

protected Arrangement()

Arrangement

protected Arrangement(Rcvr receiver)

Method Detail

copyElements

public void copyElements(PrimArray toArray,
                         Dsp toDsp,
                         PrimArray fromArray,
                         Arrangement fromArrange,
                         XnRegion fromRegion)

Copy elements into toArray arranged according to the receiver. Copy them from fromArray arranged according to fromArrange. The source region is fromRegion. It gets tranformed by toDsp into the toArray.

indexOf

public abstract IntegerValue indexOf(Position position)

Return the index of position into my Region according to my OrderSpec.

indicesOf

public abstract IntegerRegion indicesOf(XnRegion region)

Return the region of all the indices corresponding to positions in region.

keysOf

public abstract XnRegion keysOf(int start,
                                int stop)

Return the region that corresponds to a range of indices.

region

public abstract XnRegion region()

The region of positions in the arrangement

actualHashForEqual

public int actualHashForEqual()

Description copied from class: Heaper

Defined by subclasses to produce the value returned by hashForEqual.

Overrides:

actualHashForEqual in class Heaper

sendSelfTo

public void sendSelfTo(Xmtr xmtr)

Overrides:

sendSelfTo in class Heaper