VLListIndexC<class T> - Sets indexed by Expressions.

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
Big object.

Parent Classes:

VLIndexC

Methods:

VLListIndexC(): Default constructor.
Creates an invalid handle.
VLListIndexC(BooleanT makeBod): Constructor.
VLListIndexC(const VLListIndexC<T> & Oth): Copy constructor.
BooleanT AddIndex(const VLSymbC & SymbC,const T & Data): Add single condition to index.
BooleanT DelIndex(const VLSymbC & SymbC,const T & Data): Delete single condition from index.
BooleanT AddIndex(const VLSymbSetC & Lst,const T & Obj): Add data indexed by a set of conditions.
BooleanT DelIndex(const VLSymbSetC & Lst,const T & Obj): Delete data indexed by a set of conditions.
BooleanT Intersect(const VLListIndexC<T> & Oth): Intersect this index with another.
BooleanT Union(const VLListIndexC<T> & Oth): Union this index with another.
BooleanT Disjunction(const VLListIndexC<T> & Oth): Disjoint section of this index and an another.
HSetC<T> & Find(const VLSymbC & Obj): Find data, using single symbol.
const HSetC<T> Find(const VLSymbC & Obj) const: Find data, using single symbol.
BooleanT Find(const VLSymbC & Obj,HSetC<T> & Set) const: Find data, replace paramiter 'Set' with result.
Ret: True = result non-empty.
BooleanT FindIntersect(const VLSymbC & Obj,HSetC<T> & Set) const: Find data, intersect result with 'Set'
Ret: True = result non-empty.
BooleanT Find(const VLSymbSetC & Lst,HSetC<T> & Set) const: Find data, replace paramiter 'Set' with result.
Ret: True = result non-empty.
BooleanT FindIntersect(const VLSymbSetC & Lst,HSetC<T> & Set) const: Find data, intersect result with 'Set'
Ret: True = result non-empty.
BooleanT UFind(const VLSymbC & Obj,VLListIndexC<T> & Res) const: Find data, looking for all Unifying matches.
replace paramiter 'Set' with result. Ret: True = result non-empty.
BooleanT UFindIntersect(const VLSymbC & Obj,VLListIndexC<T> & Res) const: Find data, looking for all Unifying matches.
interect result with 'Set' Ret: True = result non-empty.
BooleanT UFind(const VLSymbSetC & Lst,VLListIndexC<T> & Res) const: Find data, looking for all Unifying matches.
union paramiter 'Set' with result. Ret: True = result non-empty.
BooleanT UFindIntersect(const VLSymbSetC & Lst,VLListIndexC<T> & Res) const: Find data, looking for all Unifying matches.
interect result with 'Set' Ret: True = result non-empty.
BooleanT IsEmpty() const: Test if list is empty.

#include "amma/Logic2/LIndex.hh"

VLIndex<HSetC<T>> & Body(): Access body.
const VLIndex<HSetC<T>> & Body() const: Access body.
VLIndexC<HSetC<T>> Copy() const: Make a shallow copy of index.
Copy index itself but not the data or the keys.
BooleanT Add(const VLSymbC & cnd,const HSetC<T> & data): Add a new item to the index.
Ret:False = Not new item.
BooleanT Add(const VLExprC & cnd,const HSetC<T> & data): Add a new item to the index.
Ret:False = Not new item.
BooleanT Match(const VLExprC & sxpr,VLBindLst & bnd,HSetC<T> & data) const: Unify expression match.
BooleanT Match(const VLSymbC & symb,VLBindLst & bnd,HSetC<T> & data) const: Unify symbol match.
BooleanT Match(const VLSymbC & symb,HSetC<T> & data) const: Exact match !
HSetC<T> & operator[](const VLSymbC & cnd): Index operator.
HSetC<T> operator[](const VLSymbC & cnd) const: Index operator.
VLCIndex & Body(): Access body.
const VLCIndex & Body() const: Access body.
int Size(void) const: Get number of items in the index.
VLIndexBaseC Copy() const: Make a shallow copy of index.
Copy index itself but not the data or the keys.
void Empty(): Empty index.
BooleanT IsEmpty() const: Is index empty ?
BooleanT HasExpr() const: Does index have any expressions in it.
For debuging only
BooleanT Del(const VLSymbC & cnd): Delete an item to the index.
Ret:False = Not found.
RCWrapBaseC BaseMatch(const VLSymbC & symb) const: Exact match !
BooleanT IsMember(const VLSymbC & symb) const: Is symb in the index. ?
BooleanT IsMember(const VLSymbC & symb,VLBindLst & bnds) const: Is symb in the index. ?

#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<VLCIndex> & operator=(const RCHandleC<VLCIndex> & oth): Assignment.
BooleanT operator==(const RCHandleC<VLCIndex> & oth) const: Comparison operator.
BooleanT operator!=(const RCHandleC<VLCIndex> & 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.
VLCIndex & Body(): Direct access to body.
const VLCIndex & Body() const: Constant access to body.

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

VLListIndexC<class T>

Sets indexed by Expressions.

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