Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

lemur::api Namespace Reference

Classes that provide services to applications programmers. More...


Classes

class  ClusterDB
 Abstract interface for clustering databases. More...

class  ClusterDBError
 Exception to throw for clustering errors. More...

class  DocInfo
 Representation of Doc Information Entry. More...

class  DocInfoList
 Abstract Interface of Doc Information List. More...

class  DocInfoList::iterator
 Iterator class, used for all subclass lists. More...

class  DocMgrManager
 This is a factory class for creating and opening DocumentManagers. More...

class  DocStream
 Abstract interface for a collection of documents. More...

class  Document
 Abstract document class. More...

class  DocumentManager
 Abstract API for document manager interface. More...

class  DocumentRep
 Representation of documents in a collection for efficient inverted index scoring. More...

class  Exception
 Default Exception class. More...

class  FieldInfo
 Abstract Representation of Field Information Entry. More...

class  FieldInfoList
 Abstract Interface of Field Information List. More...

class  FieldInfoList::iterator
 Iterator class, used for all subclass lists. More...

class  Index
 Abstract Class for indexed document collection. More...

struct  IndexedReal
 A list of indexed real numbers (similar to IndexProb). More...

class  IndexedRealVector
 A vector of IndexedReal. More...

class  IndexedRealVector::IndexedRealAscending
class  IndexedRealVector::IndexedRealDescending
class  IndexManager
 A group of index management functions. More...

class  IndriFieldInfoList
class  MatchInfo
 Match information for a query within a document. More...

class  MatchInfo::TMatchAscending
 For sorting TMatch vectors. More...

class  Parser
 Provides a generic parser interface. More...

class  PseudoFBDocs
 Representation of a subset of feedback documents. More...

class  Query
 Abstract query. More...

class  QueryDocument
 A convenience class for dealing with "interactive" queries. More...

class  QueryRep
 Abstract query representation. More...

class  QueryTerm
 A query term is assumed to have at least an ID and a weight. More...

class  ResultFile
 representation of result file More...

class  RetMethodManager
 Factory class for creating RetrievalMethod objects. More...

class  RetrievalMethod
class  ScoreAccumulator
 Abstract Score Accumulator. More...

class  ScoreFunction
 Abstract interface for retrieval function with a default implementation (dot product). More...

class  Stemmer
 A generic interface for Stemmers. More...

class  Stopper
 Provides a stopword list that can be chained with a Parser using the TextHandler class. More...

class  StructQueryRetMethod
 Abstract Interface for A Retrieval Method/Model for Structured Query. More...

class  StructQueryScoreFunc
 ScoreFunction for structured querys. Provides evalQuery. More...

class  Term
 Basic term class. More...

class  TermInfo
 Abstract Representation of Term Information Entry. More...

class  TermInfoList
 Abstract Interface of Term Information List. More...

class  TermInfoList::iterator
 Iterator class, used for all subclass lists. More...

class  TermQuery
 Abstract interface for a query containing a sequence of Terms. More...

class  TextHandler
 This class serves as an interface for classes working with the parsers. More...

class  TextHandlerManager
 Factory class for creating a Parser, Stemmer, or Stopper. More...

class  TextQuery
class  TextQueryRep
 Abstract representation of a text query as a sequence of weighted terms. More...

class  TextQueryRetMethod
 Abstract Interface for A Retrieval Method/Model for Text Query. More...

class  TMatch
 Term match entry. More...


Typedefs

typedef lemur::utility::WeightedIDSet DocIDSet
 Reuse a WeightedIDSet to represent A feedback doc set, with the weight interpreted as the corresponding "prob. of relevance" which could be any score that may be useful for feedback.

typedef unsigned long LemurErrorType
 Error codes.

typedef int FILEID_T
 internal file id for mapping.

typedef int TERMID_T
 internal term id encoding.

typedef TERMID_T LOC_T
 term position

typedef TERMID_T DOCID_T
 internal document id encoding.

typedef TERMID_T COUNT_T
 integral frequencies

typedef float SCORE_T
 floating point frequencies and/or scores.

typedef std::string TERM_T
 external term encoding

typedef std::string EXDOCID_T
 external document id encoding

typedef int POS_T
 pointer into collection of term positions


Functions

lemur::utility::String ParamGetString (const lemur::utility::String &s, const lemur::utility::String &def)
 Get a parameter value as a string.

lemur::utility::String ParamGetString (const lemur::utility::String &s, lemur::utility::String &value, const lemur::utility::String &def)
 Get a parameter value as a string.

lemur::utility::String ParamGetString (const lemur::utility::String &s)
int ParamGet (const lemur::utility::String &s, lemur::utility::String &value)
 Get a parameter value as a string.

int ParamGet (const lemur::utility::String &s, lemur::utility::String &value, const lemur::utility::String &def)
 Get a parameter value as a string.

int ParamGet (const lemur::utility::String &s, int &value)
 Get a parameter value as an integer.

int ParamGet (const lemur::utility::String &s, int &value, const int &def)
 Get a parameter value as an integer.

int ParamGet (const lemur::utility::String &s, double &value)
 Get a parameter value as a double.

int ParamGet (const lemur::utility::String &s, double &value, const double &def)
 Get a parameter value as a double.

int ParamGet (const lemur::utility::String &s, float &value)
 Get a parameter value as a float.

int ParamGet (const lemur::utility::String &s, float &value, const float &def)
 Get a parameter value as a float.

int ParamGetInt (const lemur::utility::String &s, int def)
 Get a parameter value as an int.

int ParamGetBit (const lemur::utility::String &s, int def)
 Get a parameter value as a bit (true or false).

double ParamGetDouble (const lemur::utility::String &s, double def)
 Get a parameter value as a double.

float ParamGetFloat (const lemur::utility::String &s, float def)
 Get a parameter value as a float.

INT64 ParamGetLongLong (const lemur::utility::String &s, INT64 def)
 Get a parameter value as an INT64 (long long).

int ParamPushFile (const lemur::utility::String &s)
 Load parameters from a parameter file.

lemur::utility::String ParamPopFile (void)
 Remove parameters from the parameter stack.

void ParamDisplay ()
 prints the current parameter keys to cerr.

void ParamClear ()
 Reset Parameter stack to empty and deallocate all memory.

void ParamSet (const lemur::utility::String &key, const lemur::utility::String &value)
 Add a parameter value pair.

float ParamGetFloat (const lemur::utility::String &s, float &def)


Detailed Description

Classes that provide services to applications programmers.

Typedef Documentation

typedef TERMID_T lemur::api::COUNT_T
 

integral frequencies

typedef TERMID_T lemur::api::DOCID_T
 

internal document id encoding.

typedef lemur::utility::WeightedIDSet lemur::api::DocIDSet
 

Reuse a WeightedIDSet to represent A feedback doc set, with the weight interpreted as the corresponding "prob. of relevance" which could be any score that may be useful for feedback.

typedef std::string lemur::api::EXDOCID_T
 

external document id encoding

typedef int lemur::api::FILEID_T
 

internal file id for mapping.

typedef unsigned long lemur::api::LemurErrorType
 

Error codes.

typedef TERMID_T lemur::api::LOC_T
 

term position

typedef int lemur::api::POS_T
 

pointer into collection of term positions

typedef float lemur::api::SCORE_T
 

floating point frequencies and/or scores.

typedef std::string lemur::api::TERM_T
 

external term encoding

typedef int lemur::api::TERMID_T
 

internal term id encoding.


Function Documentation

void lemur::api::ParamClear  ) 
 

Reset Parameter stack to empty and deallocate all memory.

void lemur::api::ParamDisplay  ) 
 

prints the current parameter keys to cerr.

int lemur::api::ParamGet const lemur::utility::String s,
float &  value,
const float &  def
 

Get a parameter value as a float.

Parameters:
s the parameter name.
value reference to a float to place the value into.
def the default value for the parameter.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGet const lemur::utility::String s,
float &  value
 

Get a parameter value as a float.

Parameters:
s the parameter name.
value reference to a float to place the value into.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGet const lemur::utility::String s,
double &  value,
const double &  def
 

Get a parameter value as a double.

Parameters:
s the parameter name.
value reference to a double to place the value into.
def the default value for the parameter.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGet const lemur::utility::String s,
double &  value
 

Get a parameter value as a double.

Parameters:
s the parameter name.
value reference to an int to place the value into.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGet const lemur::utility::String s,
int &  value,
const int &  def
 

Get a parameter value as an integer.

Parameters:
s the parameter name.
value reference to an int to place the value into.
def the default value for the parameter.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGet const lemur::utility::String s,
int &  value
 

Get a parameter value as an integer.

Parameters:
s the parameter name.
value reference to an int to place the value into.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGet const lemur::utility::String s,
lemur::utility::String value,
const lemur::utility::String def
 

Get a parameter value as a string.

Parameters:
s the parameter name.
value reference to a String to place the value into.
def the default value for the parameter.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGet const lemur::utility::String s,
lemur::utility::String value
 

Get a parameter value as a string.

Parameters:
s the parameter name.
value reference to a String to place the value into.
Returns:
true (1) if the parameter was specified, false (0) otherwise.

int lemur::api::ParamGetBit const lemur::utility::String s,
int  def
 

Get a parameter value as a bit (true or false).

Parameters:
s the parameter name.
def the default value for the parameter.
Returns:
the value of the parameter or the default value if unspecified.

double lemur::api::ParamGetDouble const lemur::utility::String s,
double  def
 

Get a parameter value as a double.

Parameters:
s the parameter name.
def the default value for the parameter.
Returns:
the value of the parameter or the default value if unspecified.

float ParamGetFloat const lemur::utility::String s,
float &  def
 

float ParamGetFloat const lemur::utility::String s,
float  def
 

Get a parameter value as a float.

Parameters:
s the parameter name.
def the default value for the parameter.
Returns:
the value of the parameter or the default value if unspecified.

int lemur::api::ParamGetInt const lemur::utility::String s,
int  def
 

Get a parameter value as an int.

Parameters:
s the parameter name.
def the default value for the parameter.
Returns:
the value of the parameter or the default value if unspecified.

INT64 lemur::api::ParamGetLongLong const lemur::utility::String s,
INT64  def
 

Get a parameter value as an INT64 (long long).

Parameters:
s the parameter name.
def the default value for the parameter.
Returns:
the value of the parameter or the default value if unspecified.

lemur::utility::String lemur::api::ParamGetString const lemur::utility::String s  ) 
 

Parameters:
s the parameter name.
Returns:
the value of the parameter or an empty String if unspecified.

lemur::utility::String lemur::api::ParamGetString const lemur::utility::String s,
lemur::utility::String value,
const lemur::utility::String def
 

Get a parameter value as a string.

Parameters:
s the parameter name.
value reference to a String to place the value into.
def the default value for the parameter.
Returns:
the value of the parameter or the default value if unspecified.

lemur::utility::String lemur::api::ParamGetString const lemur::utility::String s,
const lemur::utility::String def
 

Get a parameter value as a string.

Parameters:
s the parameter name.
def the default value for the parameter.
Returns:
the value of the parameter or the default value if unspecified.

lemur::utility::String lemur::api::ParamPopFile void   ) 
 

Remove parameters from the parameter stack.

Removes the most recently pushed parameter file from the stack.

Returns:
an empty String

int lemur::api::ParamPushFile const lemur::utility::String s  ) 
 

Load parameters from a parameter file.

Adds a set of parameters to the parameter stack.

Parameters:
s the parameter file to load.
Returns:
true if the file was loaded. false if it was not.

void lemur::api::ParamSet const lemur::utility::String key,
const lemur::utility::String value
 

Add a parameter value pair.

If no parameter file has been pushed, a new empty Parameters object is put on the stack.


Generated on Tue Jun 15 11:03:04 2010 for Lemur by doxygen 1.3.4