org.abora.white.collection.tables
Class ActualIntegerTable

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.ActualIntegerTable

public class ActualIntegerTable

extends OberIntegerTable

The IntegerTable class is intended to provide an integer indexed table which is not constrained to be zero based.

Field Summary

protected boolean	domainIsSimple
protected int	elemCount
protected PtrArray	elements
protected int	firstElem
protected int	lastElem
protected IntegerValue	start
protected int	tally

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

myNextCOW

Constructor Summary

ActualIntegerTable()
The optional argument just hints at the number of elements to eventually be added.

ActualIntegerTable(IntegerValue size)
The optional argument just hints at the number of elements to eventually be added.

ActualIntegerTable(IntegerValue begin, IntegerValue end)
Hint at the domain to be accessed (inclusive, exclusive).

ActualIntegerTable(PtrArray array, IntegerValue begin, int count, int first, int last, int aTally, boolean simple)

ActualIntegerTable(Rcvr receiver)

Method Summary

Heaper	atIntStore(IntegerValue index, Heaper value) Unboxed version.
Heaper	atStore(Position key, Heaper value) Associate value with key, whether or not there is a previous association.
void	becomeCloneOnWrite(Heaper where)
IntegerRegion	contigDomainStarting(int anIdx)
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()
void	destruct()
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
void	enlargeAfter(IntegerValue toMinimum) Enlarge the receiver to contain more slots filled with nil.
void	enlargeBefore(IntegerValue toMinimum) Enlarge the receiver to contain more slots filled with nil.
int	fastHash()
Heaper	fetch(Position key) Return the range element at the domain position key.
int	firstElemAfter(int index) This method returns the first table entry that is not NULL after index.
IntegerRegion	generateDomain()
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 index) Unboxed version.
boolean	intWipe(IntegerValue index) Unboxed version.
boolean	isEmpty() Is there anything in the table? 'table->isEmpty()' iff 'table->domain()->isEmpty()'.
int	lastElemBefore(int index) This method returns the first table entry that is not NULL after index.
IntegerValue	lowestIndex() Given that the table is non-empty, 'intTab->lowestIndex()' is equivalent to 'CAST(IntegerRegion,intTab->domain())->lowerBound()'.
int	maxElements() return the size of the elements array for rapid processing
IntegerRegion	nullDomainStarting(int anIdx)
ScruTable	offsetSubTableBetween(IntegerValue startIndex, IntegerValue stopIndex, IntegerValue firstIndex) Copy the given range into a new IntegerTable.
void	printOn(java.io.PrintWriter aStream) This should rarely be overridden.
XnRegion	runAt(Position anIdx) Return the length of the run starting at position key.
XnRegion	runAtInt(IntegerValue anIdx) Unboxed version.
void	sendSelfTo(Xmtr xmtr)
IntegerValue	startIndex() return the size of the elements array for rapid processing
int	startOffset() return the size of the elements array for rapid processing
TableStepper	stepper(OrderSpec order) ignore order spec for now
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
Heaper	theOne() Iff I contain exactly one range element, return it.
boolean	wipe(Position key) Remove a key->value association from the table.

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

aboutToWrite, 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, printOnWithSimpleSyntax, printOnWithSyntax, range, stepper, transformedBy

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

equals, hashForEqual, printContentsOn, toString

Methods inherited from class java.lang.Object

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

Field Detail

elements

protected PtrArray elements

start

protected IntegerValue start

elemCount

protected int elemCount

firstElem

protected int firstElem

lastElem

protected int lastElem

tally

protected int tally

domainIsSimple

protected boolean domainIsSimple

Constructor Detail

ActualIntegerTable

public ActualIntegerTable()

The optional argument just hints at the number of elements to eventually be added. It makes no difference semantically.

ActualIntegerTable

public ActualIntegerTable(IntegerValue size)

The optional argument just hints at the number of elements to eventually be added. It makes no difference semantically.

ActualIntegerTable

public ActualIntegerTable(IntegerValue begin,
                          IntegerValue end)

Hint at the domain to be accessed (inclusive, exclusive).

ActualIntegerTable

public ActualIntegerTable(PtrArray array,
                          IntegerValue begin,
                          int count,
                          int first,
                          int last,
                          int aTally,
                          boolean simple)

ActualIntegerTable

public ActualIntegerTable(Rcvr receiver)

Method Detail

fastHash

public int fastHash()

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

atIntStore

public Heaper atIntStore(IntegerValue index,
                         Heaper value)

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 index)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Specified by:

intFetch in class OberIntegerTable

intWipe

public boolean intWipe(IntegerValue index)

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

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()

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)

Copy the given range into a new IntegerTable. The range is startIndex (inclusive) to stopIndex (exclusive) The first element in the sub table will be at firstIndex

Specified by:

offsetSubTableBetween 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

subTableBetween

public ScruTable subTableBetween(IntegerValue startIndex,
                                 IntegerValue stopIndex)

Hack for C++ overloading problem

Specified by:

subTableBetween in class OberIntegerTable

runAtInt

public XnRegion runAtInt(IntegerValue anIdx)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Specified by:

runAtInt in class OberIntegerTable

printOn

public void printOn(java.io.PrintWriter aStream)

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

stepper

public TableStepper stepper(OrderSpec order)

ignore order spec for now

Specified by:

stepper in class OberIntegerTable

theOne

public Heaper theOne()

Description copied from class: ScruTable

Iff I contain exactly one range element, return it. Otherwise BLAST. The idea for this message is taken from the THE function of ONTIC (reference McAllester)

Overrides:

theOne in class ScruTable

contigDomainStarting

public IntegerRegion contigDomainStarting(int anIdx)

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

enlargeAfter

public void enlargeAfter(IntegerValue toMinimum)

Enlarge the receiver to contain more slots filled with nil.

enlargeBefore

public void enlargeBefore(IntegerValue toMinimum)

Enlarge the receiver to contain more slots filled with nil.

firstElemAfter

public int firstElemAfter(int index)

This method returns the first table entry that is not NULL after index.

generateDomain

public IntegerRegion generateDomain()

lastElemBefore

public int lastElemBefore(int index)

This method returns the first table entry that is not NULL after index.

maxElements

public int maxElements()

return the size of the elements array for rapid processing

nullDomainStarting

public IntegerRegion nullDomainStarting(int anIdx)

startIndex

public IntegerValue startIndex()

return the size of the elements array for rapid processing

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

destruct

public void destruct()

Overrides:

destruct in class Heaper

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 anIdx)

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