VLConstraintBodyC - Logical constraint

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

VLSymb

Derived Classes:

VLConstraintSetBodyC

Variables:

BooleanT isSimple;

Methods:

VLConstraintBodyC(): Default constructor.
BooleanT IsSimple(void) const: Does this symb contain any variables, (in Expressions or MinTerms.)
void SetSimple(BooleanT val): Set simple flag.

#include "amma/Logic2/LSymb.hh"

void SetVar(BooleanT Val): Make this Symb a variable.
BooleanT IsVar(void) const: Is this symb a variable ?
BooleanT IsSimple(void) const: Does this symb contain any variables, (in Expressions or MinTerms.)
BooleanT IsEqual(const VLSymb & Other) const: Is this equal to another Symb ?
BooleanT operator==(const VLSymb & Oth) const: Is this equal to another Symb ?
VLSymbC Subst(const VLBindLst & Bnds) const: Substitute binds.
VLSymbC Subst(const VLSubstBaseC & Subs) const: Substitute one set of symbols for another.
VLSymbC NewVarDup(VLSubstBaseC & Subst) const: Create subsitutions for variables as needed.
unsigned int Hash(void) const: Get ID usefull for hashing.
BooleanT Unify(const VLSymb & other,VLBindLst & sF) const: Unify, with binds.
BooleanT Unify2(const VLSymb & other,VLBindLst & sF) const: Second stage of unification.
use to make sure both Symbols have a chance to override the default unification process. There is no need to overide this method unless doing something special like implementing contraints.
All variable subsitutions should be done by the time this is called.
BooleanT Unify(const VLSymb & other) const: Unify, with hidden binds.
StringC GetName(StringC Buff = StringC()) const: Get the name of this Symbol, if an unamed object one will be generated.
Obsolete use Name().
StringC Name() const: Get name of object.
This get a short text description of the symbol.
void Dump(void) const: Dump info about this object to stdout.
BooleanT Test(const VLSpace & State,VLBindLst & Bnd,VLSymbIterC & iter) const: Test if this symbol is true in a given state.
If there are several bindings which make it true make Iter point to an iterator which will change the passed Bnd's appropriatly. NB. any changes made to 'Bnd' after an 'Iter' is generated will be undone when the 'Iter.Next()' or 'Iter.First()' is called. Deleting the 'Iter' should NOT effect the bindings.
BooleanT Test(const VLSpace & State,VLBindLst & Bnd) const: If you only wish to use the first solution found use this function.
BooleanT Test(const VLSpace & state) const: Is a solution possible ?
VLSymbC SymbCopy(void) const: Make a copy of this object on the heap.

#include "amma/BRefCntV.hh"

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.

#include "amma/BRefCnt.hh"

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.
void SetUndeletable(): Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.
void ReportInvalidObject(char * Msg = 0) const: Tell user about validation failure.

#include "amma/RefCBase.hh"

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.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

VLConstraintBodyC

Logical constraint

include	"amma/Logic2/Constraint.hh"
User Level:	Default
Library:	VLBasic
Example:	exIndex.cc
Section:	default.Charles Galambos
In Scope:	std