PUBLIC

VLCIndex::VLCIndex(void) VLCIndex::VLCIndex(const VLCIndex &) VLCIndex::~VLCIndex(void) VLCIndex::Add(const VLSymbC &,const RCWrapBaseC &) VLCIndex::Del(const VLSymbC &) VLCIndex::Match(const VLExprC &,VLBindLst &) const VLCIndex::Match(const VLSymbC &,VLBindLst &) const VLCIndex::Match(const VLSymbC &) const VLCIndex::Match(const VLExprC &) const VLCIndex::Size(void) const VLCIndex::IsEmpty(void) const VLCIndex::Empty(void) VLCIndex::HasExpr(void) const BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const RefCounterBaseC::Label(void) const

VLCIndex
Index of expressions.
include	"amma/Logic2/LCIndex.hh"
User Level:	Default
Library:	VLIndex
Example:	exIndex.cc
Section:	Logic.Index
In Scope:	std

Comments:
NB. Don't modify expression after they've been added to the index !! They are refrenced from the index, and are expected to have the same values as when they were added.

public BodyRefCounterVC

VLIndex

VLCIndex()

Default constructor.

VLCIndex(const VLCIndex & Oth)

Copy constructor.
This makes a shallow copy, it copies the index but not the keys or data.

~VLCIndex()

Destructor.

BooleanT Add(const VLSymbC & cnd,const RCWrapBaseC & data)

Add a new item to the index.
Return: TRUE if 'cnd' is new.

BooleanT Del(const VLSymbC & cnd)

Delete an item to the index.
Return: False = Not found.

RCWrapBaseC Match(const VLExprC & vle,VLBindLst & bnd) const

Unify match.

RCWrapBaseC Match(const VLSymbC & symb,VLBindLst & bnd) const

Unify match.

RCWrapBaseC Match(const VLSymbC & symb) const

Exact match !

RCWrapBaseC Match(const VLExprC & expr) const

Exact match !

IntT Size(void) const

Get number of items in the index.

BooleanT IsEmpty(void) const

Test if the index is empty.

void Empty(void)

Remove all data from index.

BooleanT HasExpr() const

Test if root is valid, for debuging

BodyRefCounterVC & Copy() const

Creat a copy of this object.

BooleanT operator==(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT operator!=(const BodyRefCounterVC & oth) const

Compair identitys.

BooleanT Save(ostream & out) const

Save to ostream.

void AddReference()

Another reference to the object has been created.

void RemoveReference()

One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.

void SetConst(void) const

This locks the object.
Often objects you wish to lock are already const.

void SetConst(void)

This locks the object.

BooleanT IsConst(void) const

Returns TRUE if the object is locked, ie. it is assumed to be constant.

BooleanT IsNotConst(void) const

Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------

BooleanT ToBeDeleted() const

Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.

BooleanT ToBeDeletedRemoveIgnoreNoRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object.

BooleanT ToBeDeletedRemove()

Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.

BooleanT BodyMightBeDeleted() const

Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .

BooleanT IsCountZero() const

Are there any refrences left ?

BooleanT BRCPtrCanDeleteObject() const

Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.

IntT Count() const

Returns the current state of the counter, ie. how many references to this object exist.

const BodyRefCounterC & operator=(const BodyRefCounterC & b)

It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.

BooleanT IsValidObject() const

Test if object is valid.
When amma check is disabled this always returns true.

BooleanT UserBitTest(IntT x) const

Test user flag.

void UserBitSet(IntT x,BooleanT setit = TRUE)

Test user flag.

void UserBitZero(IntT x)

Set bit to zero.

void ReportBRCError(char * Msg)

Report error, used in BRCPtrC.

UIntT Hash() const

Hash on address of object.

LabelT Label() const

Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.