org.abora.white.collection.tables
Class COWIntegerTable

java.lang.Object
  |
  +--org.abora.white.xpp.basic.Heaper
        |
        +--org.abora.white.collection.tables.ScruTable
              |
              +--org.abora.white.collection.tables.MuTable
                    |
                    +--org.abora.white.collection.tables.IntegerTable
                          |
                          +--org.abora.white.collection.tables.OberIntegerTable
                                |
                                +--org.abora.white.collection.tables.COWIntegerTable

public class COWIntegerTable

extends OberIntegerTable

Field Summary

protected OberIntegerTable	myPrev
protected OberIntegerTable	myTable

Fields inherited from class org.abora.white.collection.tables.OberIntegerTable

myNextCOW

Constructor Summary

protected	COWIntegerTable(OberIntegerTable table)
protected	COWIntegerTable(Rcvr receiver)

Method Summary

void	aboutToWrite()
Heaper	atIntStore(IntegerValue aKey, Heaper anObject) Unboxed version.
Heaper	atStore(Position key, Heaper value) Associate value with key, whether or not there is a previous association.
void	becomeCloneOnWrite(Heaper where)
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.
void	destroy() only recover these during GC.
XnRegion	domain() Return an XuRegion representing a snapshot of the current domain.
PtrArray	elementsArray() return the elements array for rapid processing
ScruTable	emptySize(IntegerValue size) Return an empty table just like the current one.
int	endOffset() return the size of the elements array for rapid processing
Heaper	fetch(Position key) Return the range element at the domain position key.
OberIntegerTable	getPrev()
IntegerValue	highestIndex() Given that the table is non-empty, 'intTab->highestIndex()' is equivalent to 'CAST(IntegerRegion,intTab->domain())->upperBound() -1'.
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.
Heaper	intFetch(IntegerValue key) Unboxed version.
boolean	intWipe(IntegerValue anIdx) Unboxed version.
boolean	isEmpty() Is there anything in the table? 'table->isEmpty()' iff 'table->domain()->isEmpty()'.
IntegerValue	lowestIndex() Given that the table is non-empty, 'intTab->lowestIndex()' is equivalent to 'CAST(IntegerRegion,intTab->domain())->lowerBound()'.
ScruTable	offsetSubTableBetween(IntegerValue startIndex, IntegerValue stopIndex, IntegerValue firstIndex) Return a table which contains the elements from start to stop, starting at firstIndex.
XnRegion	runAt(Position key) Return the length of the run starting at position key.
XnRegion	runAtInt(IntegerValue index) Unboxed version.
void	sendSelfTo(Xmtr xmtr)
void	setMuTable(OberIntegerTable table)
void	setPrev(OberIntegerTable set)
IntegerValue	startIndex()
int	startOffset() return the size of the elements array for rapid processing
TableStepper	stepper(OrderSpec order) Return a TableStepper which will enumerate my key->value mappings.
ScruTable	subTable(XnRegion reg) Return a table which contains only the intersection of this table's domain and the domain specified by 'region'.
ScruTable	subTableBetween(IntegerValue startIndex, IntegerValue stopIndex) Hack for C++ overloading problem
boolean	wipe(Position key) Remove a key->value association from the table.

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

getNextCOW, setNextCOW

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

atIntIntroduce, atIntReplace, atIntroduce, atReplace, intRemove, make, make, make, make, remove

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

actualHashForEqual, asImmuTable, asMuTable, introduceAll, introduceAll, introduceAll, isEqual, make, make, problems, removeAll, replaceAll, replaceAll, replaceAll, storeAll, storeAll, storeAll, wipeAll

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

backfollowFrom, contentsEqual, contentsHash, get, intGet, printOn, printOnWithSimpleSyntax, printOnWithSyntax, range, stepper, theOne, transformedBy

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

destruct, equals, hashForEqual, printContentsOn, toString

Methods inherited from class java.lang.Object

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

Field Detail

myPrev

protected OberIntegerTable myPrev

myTable

protected OberIntegerTable myTable

Constructor Detail

COWIntegerTable

protected COWIntegerTable(OberIntegerTable table)

COWIntegerTable

protected COWIntegerTable(Rcvr receiver)

Method Detail

atIntStore

public Heaper atIntStore(IntegerValue aKey,
                         Heaper anObject)

Description copied from class: MuTable

Unboxed version. See class comment for XuInteger

Specified by:

atIntStore in class OberIntegerTable

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.

Overrides:

coordinateSpace in class OberIntegerTable

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 OberIntegerTable

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 OberIntegerTable

highestIndex

public IntegerValue highestIndex()

Description copied from class: OberIntegerTable

Given that the table is non-empty, 'intTab->highestIndex()' is equivalent to 'CAST(IntegerRegion,intTab->domain())->upperBound() -1'. The reason for the '-1' is that the 'upperBound' is an exclusive upper bound (see IntegerRegion::upperBound), whereas 'highestIndex' is the highest index which is in my domain. I need to here specify what 'highestIndex' does if I am empty.

Specified by:

highestIndex in class OberIntegerTable

intFetch

public Heaper intFetch(IntegerValue key)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Specified by:

intFetch in class OberIntegerTable

intWipe

public boolean intWipe(IntegerValue anIdx)

Description copied from class: MuTable

Unboxed version. See class comment for XuInteger

Specified by:

intWipe in class OberIntegerTable

lowestIndex

public IntegerValue lowestIndex()

Description copied from class: OberIntegerTable

Given that the table is non-empty, 'intTab->lowestIndex()' is equivalent to 'CAST(IntegerRegion,intTab->domain())->lowerBound()'. 'lowestIndex' is the lowest index which is in my domain. I need to here specify what 'lowestIndex' does if I am empty.

Specified by:

lowestIndex in class OberIntegerTable

subTable

public ScruTable subTable(XnRegion reg)

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 OberIntegerTable

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 OberIntegerTable

destroy

public void destroy()

only recover these during GC. otherwise crashes occur

Overrides:

destroy in class Heaper

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 OberIntegerTable

offsetSubTableBetween

public ScruTable offsetSubTableBetween(IntegerValue startIndex,
                                       IntegerValue stopIndex,
                                       IntegerValue firstIndex)

Description copied from class: OberIntegerTable

Return a table which contains the elements from start to stop, starting at firstIndex. Zero-based subclasses will blast if firstIndex is non-zero

Specified by:

offsetSubTableBetween in class OberIntegerTable

subTableBetween

public ScruTable subTableBetween(IntegerValue startIndex,
                                 IntegerValue stopIndex)

Description copied from class: OberIntegerTable

Hack for C++ overloading problem

Specified by:

subTableBetween in class OberIntegerTable

runAtInt

public XnRegion runAtInt(IntegerValue index)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Specified by:

runAtInt in class OberIntegerTable

includesIntKey

public boolean includesIntKey(IntegerValue aKey)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Specified by:

includesIntKey in class OberIntegerTable

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 OberIntegerTable

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 OberIntegerTable

getPrev

public OberIntegerTable getPrev()

setMuTable

public void setMuTable(OberIntegerTable table)

setPrev

public void setPrev(OberIntegerTable set)

elementsArray

public PtrArray elementsArray()

return the elements array for rapid processing

Specified by:

elementsArray in class OberIntegerTable

endOffset

public int endOffset()

return the size of the elements array for rapid processing

Specified by:

endOffset in class OberIntegerTable

startIndex

public IntegerValue startIndex()

Specified by:

startIndex in class OberIntegerTable

startOffset

public int startOffset()

return the size of the elements array for rapid processing

Specified by:

startOffset in class OberIntegerTable

aboutToWrite

public void aboutToWrite()

Overrides:

aboutToWrite in class OberIntegerTable

becomeCloneOnWrite

public void becomeCloneOnWrite(Heaper where)

Specified by:

becomeCloneOnWrite in class OberIntegerTable

atStore

public Heaper atStore(Position key,
                      Heaper value)

Description copied from class: MuTable

Associate value with key, whether or not there is a previous association. Return the old range element if the position was previously occupied, NULL otherwise

Overrides:

atStore in class OberIntegerTable

fetch

public Heaper fetch(Position key)

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.

Overrides:

fetch in class OberIntegerTable

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 OberIntegerTable

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.

Overrides:

runAt in class OberIntegerTable

wipe

public boolean wipe(Position key)

Description copied from class: MuTable

Remove a key->value association from the table. Do not blast (or do anything else) if the key is not in my current domain. Return TRUE if the association was present and removed, Return FALSE if the association was not there

Overrides:

wipe in class OberIntegerTable

sendSelfTo

public void sendSelfTo(Xmtr xmtr)

Overrides:

sendSelfTo in class MuTable