org.abora.white.collection.tables
Class OffsetScruArray

java.lang.Object
  |
  +--org.abora.white.xpp.basic.Heaper
        |
        +--org.abora.white.collection.tables.ScruTable
              |
              +--org.abora.white.collection.tables.OffsetScruArray

public class OffsetScruArray

extends ScruTable

Field Summary

protected MuArray	myArray
protected Dsp	myDsp

Constructor Summary

protected	OffsetScruArray(MuArray array, Dsp dsp)
protected	OffsetScruArray(Rcvr receiver)

Method Summary

int	actualHashForEqual() See ScruTable::isEqual
ImmuTable	asImmuTable() Return a side-effect-free snapshot of my current contents.
MuTable	asMuTable() Return a side-effectable version of the same table.
CoordinateSpace	coordinateSpace() The kind of elements used to index into the table are Positions of this coordinate space.
ScruTable	copy() A new one whose initial state is my current state, but that doesn't track changes.
IntegerValue	count() Return the number of domain elements, which is to say, the number of associations.
XnRegion	domain() Return an XuRegion representing a snapshot of the current domain.
ScruTable	empty()
ScruTable	emptySize(IntegerValue size) Return an empty table just like the current one.
Heaper	fetch(Position anIndex) Return the range element at the domain position key.
boolean	includesIntKey(IntegerValue aKey) Unboxed version.
boolean	includesKey(Position aKey) includesKey is used to test for the presence of a key->value pair in the table.
MuArray	innerArray()
Dsp	innerDsp()
Heaper	intFetch(IntegerValue idx) Unboxed version.
boolean	isEmpty() Is there anything in the table? 'table->isEmpty()' iff 'table->domain()->isEmpty()'.
boolean	isEqual(Heaper other) All MuTable subclasses have equality based on identity (now and forever equal.
static OffsetScruArray	make(MuArray array, Dsp dsp)
void	printOn(java.io.PrintWriter oo) This should rarely be overridden.
XnRegion	runAt(Position key) Return the length of the run starting at position key.
XnRegion	runAtInt(IntegerValue anIdx) Unboxed version.
void	sendSelfTo(Xmtr xmtr)
TableStepper	stepper() implement default argument of NULL
TableStepper	stepper(OrderSpec order) Return a TableStepper which will enumerate my key->value mappings.
ScruTable	subTable(XnRegion encl) Return a table which contains only the intersection of this table's domain and the domain specified by 'region'.
ScruTable	subTableBetween(IntegerValue startLoc, IntegerValue endLoc)
ScruTable	transformedBy(Dsp dsp) Return a ScruTable with the domain of the receiver transformed by the Dsp.

Methods inherited from class org.abora.white.collection.tables.ScruTable

backfollowFrom, contentsEqual, contentsHash, get, intGet, printOnWithSimpleSyntax, printOnWithSyntax, problems, range, theOne

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

destroy, destruct, equals, hashForEqual, printContentsOn, toString

Methods inherited from class java.lang.Object

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

Field Detail

myArray

protected MuArray myArray

myDsp

protected Dsp myDsp

Constructor Detail

OffsetScruArray

protected OffsetScruArray(MuArray array,
                          Dsp dsp)

OffsetScruArray

protected OffsetScruArray(Rcvr receiver)

Method Detail

make

public static OffsetScruArray make(MuArray array,
                                   Dsp dsp)

coordinateSpace

public CoordinateSpace coordinateSpace()

Description copied from class: ScruTable

The kind of elements used to index into the table are Positions of this coordinate space. Therefore, the domain of this table is an XuRegion in this coordinate space.

Specified by:

coordinateSpace in class ScruTable

count

public IntegerValue count()

Description copied from class: ScruTable

Return the number of domain elements, which is to say, the number of associations. 'table->count()' should be equivalent to 'table->domain()->count()'. Used to say: 'Return the number of range elements'. This seems clearly wrong.

Specified by:

count in class ScruTable

domain

public XnRegion domain()

Description copied from class: ScruTable

Return an XuRegion representing a snapshot of the current domain. 'table->domain()->hasMember(p)' iff 'table->fetch(p) !!= NULL'.

Specified by:

domain in class ScruTable

fetch

public Heaper fetch(Position anIndex)

Description copied from class: ScruTable

Return the range element at the domain position key. The routine will return NULL if the position is not in the table.

Specified by:

fetch in class ScruTable

intFetch

public Heaper intFetch(IntegerValue idx)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Overrides:

intFetch in class ScruTable

subTable

public ScruTable subTable(XnRegion encl)

Description copied from class: ScruTable

Return a table which contains only the intersection of this table's domain and the domain specified by 'region'. table->subTable(r)->domain()->isEqual( table->domain()->intersect(r) ). It is unspecified whether the resulting table starts as a snapshot of a subset of me, after which we go our own ways; or whether the resulting table is a view onto a subset of me, such that changes to me are also visible to him. Of course, subclasses may specify more. If you want to ensure snapshot behavior, do 'table->subTable(r)->asImmuTable()'. NOTE: In the future we may specify snapshot behavior or we may specify view behavior. As a client this shouldn't effect you. However, if you implement a new kind of ScruTable, please let us know. Also, if you have an opinion as to which way you'd like the specification tightened up, please tell us.

Specified by:

subTable in class ScruTable

subTableBetween

public ScruTable subTableBetween(IntegerValue startLoc,
                                 IntegerValue endLoc)

transformedBy

public ScruTable transformedBy(Dsp dsp)

Description copied from class: ScruTable

Return a ScruTable with the domain of the receiver transformed by the Dsp. 'table->transformedBy(d)->fetch(p)' is equivalent to 'table->fetch(d->of(p))'. See ScruTable::subTable for caveats regarding whether we return a snapshot or a view. All the same caveats apply.

Overrides:

transformedBy in class ScruTable

runAt

public XnRegion runAt(Position key)

Description copied from class: ScruTable

Return the length of the run starting at position key. A run is defined as a contiguous (charming) sequence of domain positions mapping to equal (isEqual) objects. Charming is defined as: Given a charming region R, for all a,c which are elements of R and a >= b >= c, b is an element of R. Where '>=' is according to the 'isGE' message. NOTE: We may retire the above definition of charming. The possible changes will only effect spaces which aren't fully ordered. OrderedRegions, TreeRegions, and IntegerRegions will be unaffected, as any future definition of 'runAt' will be equivalent for them.

Specified by:

runAt in class ScruTable

runAtInt

public XnRegion runAtInt(IntegerValue anIdx)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Overrides:

runAtInt in class ScruTable

actualHashForEqual

public int actualHashForEqual()

Description copied from class: ScruTable

See ScruTable::isEqual

Overrides:

actualHashForEqual in class ScruTable

includesIntKey

public boolean includesIntKey(IntegerValue aKey)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Overrides:

includesIntKey in class ScruTable

includesKey

public boolean includesKey(Position aKey)

Description copied from class: ScruTable

includesKey is used to test for the presence of a key->value pair in the table. This routine returns true if there is a value present at the specified key, and false otherwise. 'table->includesKey(p)' iff 'table->domain()->hasMember(p)'.

Overrides:

includesKey in class ScruTable

isEmpty

public boolean isEmpty()

Description copied from class: ScruTable

Is there anything in the table? 'table->isEmpty()' iff 'table->domain()->isEmpty()'.

Specified by:

isEmpty in class ScruTable

isEqual

public boolean isEqual(Heaper other)

Description copied from class: ScruTable

All MuTable subclasses have equality based on identity (now and forever equal. Many ScruTable subclasses will represent an aspect of another table. Therefore they have hashForEqual and isEqual: based on both their contained table, and the aspect that they represent. Thus, two similar views onto the same MuTable are now (and forever) equal. The hashForEqual: must use exactly the same aspects for the hash as get used for isEqual:. ImmuTables all use contentBased comparison operations.

Specified by:

isEqual in class ScruTable

printOn

public void printOn(java.io.PrintWriter oo)

Description copied from class: Heaper

This should rarely be overridden. In Tofu, it prints ClassName(...), where ... is either produced by printInsideOn or is ??? if printInsideOn it not overridden.

Overrides:

printOn in class ScruTable

copy

public ScruTable copy()

Description copied from class: ScruTable

A new one whose initial state is my current state, but that doesn't track changes. Note that there is no implication that these can be 'destroy'ed separately, because (for example) an ImmuTable just returns itself

Specified by:

copy in class ScruTable

empty

public ScruTable empty()

emptySize

public ScruTable emptySize(IntegerValue size)

Description copied from class: ScruTable

Return an empty table just like the current one. The 'size' argument is a hint about how big the count of the table will probably become (so that the new table can be prepared to grow to that size efficiently).

Specified by:

emptySize in class ScruTable

asImmuTable

public ImmuTable asImmuTable()

Description copied from class: ScruTable

Return a side-effect-free snapshot of my current contents. See ScruSet::asImmuSet.

Specified by:

asImmuTable in class ScruTable

asMuTable

public MuTable asMuTable()

Description copied from class: ScruTable

Return a side-effectable version of the same table. See ScruSet::asMuSet.

Specified by:

asMuTable in class ScruTable

stepper

public TableStepper stepper()

Description copied from class: ScruTable

implement default argument of NULL

Overrides:

stepper in class ScruTable

stepper

public TableStepper stepper(OrderSpec order)

Description copied from class: ScruTable

Return a TableStepper which will enumerate my key->value mappings. The Stepper component of the TableStepper protocol will just enumerate my values (as that is what I'm a container *of*--the keys are simply how I organize my contents). TableStepper provides additional protocol to ascetain the current key. See TableStepper and XuRegion::stepper. The TableStepper I produce given an order must enumerate keys according to the same rules which specify how XuRegion::stepper must enumerate positions. I am not asserting that the actual orders are the same, only that the correctness criteria on the allowable orders are the same. Keeping in mind that we are talking about equivalence of specification and not equivalence of particular behavior, the following two statements are equivalent: { SPTR(TableStepper) stomp = table->stepper(o); SPTR(Position) key; FOR_EACH(Heaper,val,stomp, { key = stomp->key(); doSomethingWith(key, val); }); } and { SPTR(Heaper) val; SPTR(ImmuTable) snapShot = table->asImmuTable(); FOR_EACH(Position,key,(snapShot->domain()->stepper(o)), { val = snapShot->get (key); doSomethingWith(key, val); }); }

Specified by:

stepper in class ScruTable

innerArray

public MuArray innerArray()

innerDsp

public Dsp innerDsp()

sendSelfTo

public void sendSelfTo(Xmtr xmtr)

Overrides:

sendSelfTo in class Heaper