org.abora.gold.collection.grand
Class GrandHashTable

java.lang.Object
  |
  +--org.abora.gold.java.AboraHeaper
        |
        +--org.abora.gold.xpp.basic.Heaper
              |
              +--org.abora.gold.collection.tables.ScruTable
                    |
                    +--org.abora.gold.collection.tables.MuTable
                          |
                          +--org.abora.gold.collection.grand.GrandHashTable

public class GrandHashTable

extends MuTable

Field Summary

protected int	cacheHash
protected Position	cacheKey
protected Heaper	cacheValue
protected PtrArray	grandNodes
protected CoordinateSpace	myCs
protected Counter	myDoublingFrontIndex
protected Counter	myDoublingPasses
protected IntegerVar	myOutstandingSteppers
protected Counter	myTally
protected int	nodeIndexShift
protected int	numNodes

Fields inherited from class org.abora.gold.collection.tables.MuTable

AlreadyInTableSignal, NotInDomainSignal, NullInsertionSignal

Fields inherited from class org.abora.gold.collection.tables.ScruTable

NotInTableSignal, WrongCoordSpaceSignal

Fields inherited from class org.abora.gold.xpp.basic.Heaper

AllBlasts, BecomeMap, GarbageCount, InGC, InitializedClasses, InitializingClasses, LastMemory, NextClientRequestNumber, NotOneElementSignal, PackageTable, PromiseNameTable, StringHashSBoxes

Fields inherited from class org.abora.gold.java.AboraHeaper

ActiveClubs, CurrentAuthor, CurrentBertCanopyCache, CurrentBertCrum, CurrentChunk, CurrentGrandMap, CurrentKeyMaster, CurrentPacker, CurrentSensorCanopyCache, CurrentServer, CurrentSession, CurrentSessions, CurrentTrace, InitialEditClub, InitialOwner, InitialReadClub, InitialSponsor, InsideTransactionFlag

Constructor Summary

GrandHashTable(CoordinateSpace cs, int nNodes)

GrandHashTable(Rcvr receiver)

Method Summary

ImmuTable	asImmuTable() Return a side-effect-free snapshot of my current contents. See ScruSet::asImmuSet.
MuTable	asMuTable() Note that muTable->asMuTable() returns a copy of the original.
Heaper	atStore(Position aKey, Heaper aHeaper) 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
void	checkSteppers()
void	considerNeedForDoubling() Compute location of doubling front from tally.
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.
IntegerVar	count() 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'.
void	destruct() Classes should implement this message rather than a destructor.
XnRegion	domain() Return an XuRegion representing a snapshot of the current domain. 'table->domain()->hasMember(p)' iff 'table->fetch(p) !!= NULL'.
ScruTable	emptySize(IntegerVar size) Return an empty table just like the current one.
Heaper	fetch(Position key) Return the range element at the domain position key.
void	fewerSteppers()
boolean	includesIntKey(IntegerVar aKey) Unboxed version.
boolean	includesKey(Position aKey) includesKey is used to test for the presence of a key->value pair in the table.
static void	initTimeNonInherited() GrandHashTable initTimeNonInherited
void	inspect()
static void	inspectPieces()
void	invalidateCache()
boolean	isEmpty() Is there anything in the table? 'table->isEmpty()' iff 'table->domain()->isEmpty()'.
static Heaper	make(CoordinateSpace cs) A new empty MuTable whose domain space is 'cs'.
static Heaper	make(CoordinateSpace cs, int nNodes)
void	moreSteppers()
GrandNode	nodeAt(IntegerVar idx)
IntegerVar	nodeCount()
void	printOn(java.io.PrintWriter aStream)
void	restartGrandHashTable(Rcvr trans) re-initialize the non-persistent part
XnRegion	runAt(Position index) Return the length of the run starting at position key.
XnRegion	runAtInt(IntegerVar index) Unboxed version.
void	sendSelfTo(Xmtr xmtr) do nothing
TableStepper	stepper(OrderSpec order) Return a TableStepper which will enumerate my key->value mappings.
ScruTable	subTable(XnRegion region) 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.
boolean	wipe(Position aKey) 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

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

actualHashForEqual, atIntIntroduce, atIntReplace, atIntroduce, atIntStore, atReplace, intFetch, intRemove, introduceAll, introduceAll, introduceAll, intWipe, isEqual, make, problems, remove, removeAll, replaceAll, replaceAll, replaceAll, storeAll, storeAll, storeAll, test, wipeAll

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

asOrderedCollection, backfollowFrom, contentsEqual, contentsHash, dox, get, intGet, isEqual, printOnWithSimpleSyntax, printOnWithSyntax, range, stepper, theOne, transformedBy

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

abstractDeclarationFor, abstractTypeFor, addMethodAttributeToInOf, addPackage, addPackageCategory, allClientProtocolOn, argumentTypesFor, arrow, blast, blast, BLAST, cachePromiseNameTable, cachePromiseNameTableIn, canYouBecome, cast, cleanPromiseClasses, cleanupGarbage, clientClassesDo, clientFunctionsOn, clientMethodsOn, clientProtocol, clientProtocolDo, clientProtocolOn, clientProtocolOn, collectibleClasses, compare, compileClientSubclasses, compileConstantPromiseMethods, compileCreateFromRcvr, compileEQ, compileGeneratedClassMethod, compileGeneratedMethod, compileHook, compilePromise, compilePromiseDefaultMethods, compilePromiseFluidDeclarations, compilePromiseHandlers, compilePromiseMethods, compileRequestCreateMsgInArguments, compileRequestEvaluateMsgInReturningArguments, compileRPCSpecialistEvaluateMsgForReturningArguments, compileSendSelfTo, compileSendSelfToSendHook, compileStubbleMethods, compileSubclassStubbleMethods, computeMangle, computePreorder, constantTypeValue, convert, convertCopyDeclarations, convertDeferredDeclarations, convertProxyDeclarations, convertSubclassCopyDeclarations, convertSubclassDeferredDeclarations, convertSubclassProxyDeclarations, copyReferencesToType, create, create, create, create, create, create, create, create, create, create, createRequestClassArguments, definesProxyMethods, delete, deref, destroy, destructor, enum, enumFlags, equals, exportName, fetchAttribute, fetchPackage, fetchSuperCategory, fileOutClientProtocol, findCategory, findSenderAndReceiverMethods, findTailInto, flushPromiseNameTable, foo, freezeClientClasses, freezeClientProtocol, freezeStProtocol, frozenClasses, garbageCollect, garbageCollectFrom, gcOpportunity, gcOpportunity, generatedCategory, generatePromiseNames, getCategory, getOrMakePackage, getSuperCategory, handlerSignaturesFrom, hash, hashForEqual, hasProxyMethods, info_clientClasses, info_clientSideClasses, info_promiseClasses, info_stProtocol, inGC, initializedClasses, initializingClasses, initPackages, initStringHashSBoxes, instanceSize, IntegerVar, isByProxy, isConstructed, isDestructed, isEqualOrSubclassOf, isGenerated, isIntType, isKindOf, isRawType, isUnlocked, linkTimeNonInherited, make, makeClassTable, makeFillTable, makeRequestTable, mangle, markChildren, markCount, markInstances, mayBecome, mayBecomeAnySubclassOf, new1, newX, nonCopyVariables, notWorking, pack, packageClasses, packagingCategory, parseExportName, passe, pointerToStaticMember, pointerToStaticMember, pointerToVirtualMember, preorderMax, preorderNumber, PROBLEM, promiseClass, promiseDefaultValue, promiseName, promiseNameTable, promiseToAbstract, registerPackageCategory, removeGeneratedCode, removeStubbleMethods, removeSubclassGeneratedCode, removeSubclassStubbleMethods, requestProcedure, requestProceduresFrom, returnTypeFor, rootName, scheduleTermination, sendProxyTo, serverNameFor, setGC, signal, signals, smalltalkSelector, stClientProtocol, stubbleSelectorTokenReturnsArguments, subclassNonCopyVariables, takeOop, togglePromiseName, togglePromiseOfParse, unimplemented, unmangle, verifyFreeze, wipeStubble

Methods inherited from class org.abora.gold.java.AboraHeaper

asOop, basicInspect, displayString, error, hack, halt, knownBug, mightNotImplement, REQUIRES, shouldImplement, shouldNotImplement, stubbleForSubclassResponsibility, thingToDo, willNotImplement

Methods inherited from class java.lang.Object

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

Field Detail

grandNodes

protected PtrArray grandNodes

numNodes

protected int numNodes

nodeIndexShift

protected int nodeIndexShift

myTally

protected Counter myTally

myDoublingFrontIndex

protected Counter myDoublingFrontIndex

myDoublingPasses

protected Counter myDoublingPasses

myCs

protected CoordinateSpace myCs

cacheHash

protected int cacheHash

cacheKey

protected Position cacheKey

cacheValue

protected Heaper cacheValue

myOutstandingSteppers

protected IntegerVar myOutstandingSteppers

Constructor Detail

GrandHashTable

public GrandHashTable(CoordinateSpace cs,
                      int nNodes)

GrandHashTable

public GrandHashTable(Rcvr receiver)

Method Detail

atStore

public Heaper atStore(Position aKey,
                      Heaper aHeaper)

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 MuTable

wipe

public boolean wipe(Position aKey)

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 MuTable

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 MuTable

count

public IntegerVar 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.

Overrides:

count in class MuTable

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

Overrides:

domain in class MuTable

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 MuTable

subTable

public ScruTable subTable(XnRegion region)

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.

Overrides:

subTable in class MuTable

includesIntKey

public boolean includesIntKey(IntegerVar aKey)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Overrides:

includesIntKey in class MuTable

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 MuTable

isEmpty

public boolean isEmpty()

Description copied from class: ScruTable

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

Overrides:

isEmpty in class MuTable

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

Overrides:

copy in class MuTable

emptySize

public ScruTable emptySize(IntegerVar 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).

Overrides:

emptySize in class MuTable

printOn

public void printOn(java.io.PrintWriter aStream)

Overrides:

printOn in class ScruTable

runAt

public XnRegion runAt(Position index)

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 MuTable

runAtInt

public XnRegion runAtInt(IntegerVar index)

Description copied from class: ScruTable

Unboxed version. See class comment for XuInteger

Overrides:

runAtInt in class MuTable

checkSteppers

public void checkSteppers()

fewerSteppers

public void fewerSteppers()

moreSteppers

public void moreSteppers()

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);
});
}

Overrides:

stepper in class MuTable

destruct

public void destruct()

Description copied from class: Heaper

Classes should implement this message rather than a destructor. We use this so
the destruction behavior implemented in abstract superclasses can access the
vtable of the concrete run-time type in C++. Using a message makes C++
parallel the Smalltalk semantics for delete. Destroy will actually call the destructor.

Overrides:

destruct in class Heaper

considerNeedForDoubling

public void considerNeedForDoubling()

Compute location of doubling front from tally. If front crosses a node boundary

invalidateCache

public void invalidateCache()

restartGrandHashTable

public void restartGrandHashTable(Rcvr trans)

re-initialize the non-persistent part

nodeAt

public GrandNode nodeAt(IntegerVar idx)

nodeCount

public IntegerVar nodeCount()

inspect

public void inspect()

Overrides:

inspect in class AboraHeaper

inspectPieces

public static void inspectPieces()

asImmuTable

public ImmuTable asImmuTable()

Description copied from class: ScruTable

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

Overrides:

asImmuTable in class MuTable

asMuTable

public MuTable asMuTable()

Description copied from class: MuTable

Note that muTable->asMuTable() returns a copy of the original. The two
are now free to change independently.

Overrides:

asMuTable in class MuTable

sendSelfTo

public void sendSelfTo(Xmtr xmtr)

Description copied from class: Heaper

do nothing

Overrides:

sendSelfTo in class MuTable

make

public static Heaper make(CoordinateSpace cs)

Description copied from class: MuTable

A new empty MuTable whose domain space is 'cs'.

make

public static Heaper make(CoordinateSpace cs,
                          int nNodes)

initTimeNonInherited

public static void initTimeNonInherited()

GrandHashTable initTimeNonInherited