Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Logic - Index - LiteralIndexBodyC<class DataT>
 

  PUBLIC
LiteralIndexBodyC::LiteralIndexBodyC(void)
LiteralIndexBodyC::NewLeaf(const LiteralC &)
LiteralIndexBodyC::Lookup(const LiteralC &,DataT &)
LiteralIndexBodyC::Insert(const LiteralC &,const DataT &)
LiteralIndexBodyC::Access(const LiteralC &)
LiteralIndexBaseBodyC::Lookup(const LiteralC &)
LiteralIndexBaseBodyC::Insert(const LiteralC &)
LiteralIndexBaseBodyC::NewLeaf(const LiteralC &)
LiteralIndexBaseBodyC::Del(const LiteralC &)
LiteralIndexBaseBodyC::Size(void) const
LiteralIndexBaseBodyC::Dump(ostream &,int) const
LiteralIndexBaseBodyC::PickNextTerm(const SArray1dC &,const LiteralC &)
RCBodyVC::Save(ostream &) const
RCBodyVC::Save(BinOStreamC &) const
RCBodyVC::Copy(void) const
RCBodyVC::DeepCopy(UIntT) const
RCBodyC::References(void) const
RCBodyC::Copy(void) const
RCBodyC::DeepCopy(UIntT) const
RCBodyC::IncRefCounter(void)
RCBodyC::DecRefCounter(void)

   LiteralIndexBodyC<class DataT>   
 
Literal index.
 
include "Ravl/Logic/LiteralIndex.hh"
Source file:Ravl/Logic/Index/LiteralIndex.hh
User Level:Develop
Library:RavlLogic
In Scope:RavlLogicN

Parent Classes: Methods:
LiteralIndexBodyC()
Default constructor.

LiteralIndexLeafC NewLeaf(const LiteralC & key)
Generate a new leaf.

bool Lookup(const LiteralC & key,DataT & val)
Lookup value associated with the key in the index.
if cound copy the value to 'val' and true is return.

bool Insert(const LiteralC & key,const DataT & data)
Insert data with given key into index.
Returns false if key already exists.

DataT & Access(const LiteralC & key)
Access data associated with a literal.

#include "Ravl/Logic/LiteralIndexBase.hh"
LiteralIndexLeafC Lookup(const LiteralC & key)
Lookup exact match in index.
returns an invalid handle if not found.

LiteralIndexLeafC Insert(const LiteralC & key)
Insert key into index.
Will return handle to leaf if key already exists.

LiteralIndexLeafC NewLeaf(const LiteralC & key)
Generate a new leaf.

bool Del(const LiteralC & key)
Delete key from index.
returns true if key existed, false otherwise.

SizeT Size() const
Get the number of elements in the index.

void Dump(ostream & out,int level = 0) const
Dump index in human readable form.

UIntT PickNextTerm(const SArray1dC<bool> & used,const LiteralC & key)
Pick next term to use in the index.
used is an array set to true for all the terms already used. 'key' is the key we're updating the index for.

The default version of this function just uses terms in numerical order, first to last. You may want to put a more clever heuristic in here.


#include "Ravl/RCHandleV.hh"
bool Save(ostream & out) const
Save to stream 'out'.

bool Save(BinOStreamC & out) const
Save to binary stream 'out'.

RCBodyVC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

#include "Ravl/RefCounter.hh"
UIntT References() const
Access count of handles open to this object.

RCBodyC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()
Increment reference counter.

bool DecRefCounter()
Decrement reference counter.


Maintainer:Charles Galambos, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002