VLExprC - Symbolic Expression

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

VLSymbC

Methods:

VLExprC(): Default constructor.
VLExprC(const VLExprC & oth): Copy constructor.
VLExprC Copy() const: Copy object.
BooleanT IsExpr(const VLSymbC & oth): Test if 'oth' is an expression.
VLExprC(const VLSymbC & oth): Base constructor.
Creates an invalid handle it 'oth' is not an expression.
const VLExprC & operator=(const VLSymbC & oth): Assigment from a symb.
VLExprC(const VLExprTypeC & nEType): Construct from a type.
IntT Arity() const: Get arity of expression.
VLExprC(StringC name,const VLExprTypeC & nEType): Create a named expression with 0 args.
VLExprC(const VLExprTypeC & nEType,const VLSymbC & a1): Construct from a type and 1 arg.
VLExprC(const VLExprTypeC & nEType,const VLSymbC & a1,const VLSymbC & a2): Construct from a type and 2 args.
VLExprC(const VLExprTypeC & nEType,const VLSymbC & a1,const VLSymbC & a2,const VLSymbC & a3): Construct from a type and 3 args.
VLExprC(const VLExprTypeC & nEType,const VLSymbC & a1,const VLSymbC & a2,const VLSymbC & a3,const VLSymbC & a4): Construct from a type and 4 args.
VLExprC(IntT nargs): Construct a anonymous expression witn 'nargs' aguments.
VLExprC(IntT nargs,const VLSymbC & a2): Construct a anonymous expression witn 'nargs' aguments, setting the first arg.
VLExprC(IntT nargs,const VLSymbC & a1,const VLSymbC & a2): Construct a anonymous expression witn 'nargs' aguments, setting the first two args.
VLExprC(IntT nargs,const VLSymbC & a1,const VLSymbC & a2,const VLSymbC & a3): Construct a anonymous expression witn 'nargs' aguments, setting the first three args.
VLExprC(IntT nargs,const VLSymbC & a1,const VLSymbC & a2,const VLSymbC & a3,const VLSymbC & a4): Construct a anonymous expression witn 'nargs' aguments, setting the first four args.
VLExpr & Body(): Access expression.
const VLExpr & Body() const: Constant access to expression.
const VLSymbC & GetTerm(const VLExprLabelC & lab) const: Get term of expression by labeled field.
const VLSymbC & operator[](const VLExprLabelC & lab) const: Access a term by label.
NB. This is read-only.
const VLSymbC & GetTerm(UIntT i) const: Get term by indexed field.
const VLSymbC & operator[](UIntT i) const: Access a term by index.
NB. This is read-only.
VLSymbC & operator[](UIntT i): Access a term by index.
NB. This is read-only.
const VLSymbC & operator[](IndexT i) const: Access a term by index.
NB. This is read-only.
VLSymbC & operator[](IndexT i): Access a term by index.
NB. This is read-only.
BooleanT SetTerm(UIntT i,const VLSymbC & Value): Set term by indexed field.
BooleanT SetTerm(const VLExprLabelC & Lab,const VLSymbC & Value): Set term of expression by labeled field.
BooleanT SetTerm(StringC LabName,const VLSymbC & Value): Set term of expression by named field.
VLExprTypeC ExprType(void) const: What type of expression is this ?
void Dummy(void): Dummy.

#include "amma/Logic2/LSymb.hh"

explicit VLSymbC(BooleanT actual): Constructor.
acutal = True, create an actual symbol.
VLSymbC Copy() const: Make a copy of this object.
BooleanT IsVar() const: Is this symb a variable ?
void SetVar(BooleanT Val = TRUE): Make this Symb a variable.
BooleanT IsSimple(void) const: Does this symb contain any variables, (in Expressions or MinTerms.)
BooleanT operator==(const VLSymbC & Oth) const: Is this equal to another Symb ?
BooleanT operator!=(const VLSymbC & Oth) const: Is this equal to another Symb ?
unsigned int Hash(void) const: Get ID usefull for hashing.
BooleanT Unify(const VLSymbC & oth,VLBindLst & bnds) const: Unify with another symbol.
BooleanT Unify(const VLSymbC & oth) const: Unify with another symbol.
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: If you only wish to use the first solution found use this function.
BooleanT Test(const VLSpaceC & State,VLBindLst & Bnd,VLSymbIterC & Iter) const: See above.
BooleanT Test(const VLSpaceC & State,VLBindLst & Bnd) const: If you only wish to use the first solution found use this function.
BooleanT Test(const VLSpaceC & state) const: If you only wish to use the first solution found use this function.
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.
StringC GetName(StringC buff = StringC()) const: Get full name of object.
StringC Name() const: Get name of object.
inline StringC GetBaseName() const { return Body().GetBaseName(); } Get base name of object.
void Dump(void) const: Dump to stdout.
protected: Should be protected but too many things need to convert to the internal representation.
VLSymb & Body(): INTERNAL USE ONLY!
const VLSymb & Body() const: INTERNAL USE ONLY!
VLSymbC & operator=(const VLSymb & s): Assignment.
HashARC<StringC,VLSymbC> & GlobalMap(): FIXME :- If we want the logic library to be multi-threaded then this needs a semaphore.

#include "amma/RCHandleA.hh"

RCAbstractC Abstract(): Create an abstract handle to this object.
BooleanT IsHandleType(const DT &) const: Is handle of given type ?
void CheckHandleType(const DT & dummy) const: Check handle type. Throw an expception if not.
BooleanT Save(ostream & out) const: Save to ostream.
RCHandleAC<VLSymb> Copy() const: Creat a deep copy of this object.
protected:

#include "amma/RCHandle.hh"

BooleanT IsValid() const: Check its a valid handle.
BooleanT IsValidObject() const: Check its a valid handle, and that the object is pointed to is also valid.
RCHandleC<VLSymb> & operator=(const RCHandleC<VLSymb> & oth): Assignment.
BooleanT operator==(const RCHandleC<VLSymb> & oth) const: Comparison operator.
BooleanT operator!=(const RCHandleC<VLSymb> & oth) const: Comparison operator.
UIntT Hash() const: Hash function.x
BooleanT IsConst() const: Is object constant ?
BooleanT IsNotConst() const: Is object not constant ?
void SetConst(void) const: Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:
void Invalidate(): Turn this into an invalid handle.
VLSymb & Body(): Direct access to body.
const VLSymb & Body() const: Constant access to body.

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

VLExprC

Symbolic Expression

include	"amma/Logic2/LExpr.hh"
User Level:	Default
Library:	VLBasic
Example:	SockServer.cc
Section:	Logic.Basic
In Scope:	std