Basic read-only interface for pattern models, abstract base class. More...

#include <interface.h>

Inheritance diagram for PatternModelInterface:

Public Member Functions
virtual int	getmodeltype () const =0

virtual int	getmodelversion () const =0

virtual unsigned int	occurrencecount (const Pattern &pattern)=0

virtual double	frequency (const Pattern &)=0

virtual int	maxlength () const =0

virtual int	minlength () const =0

virtual unsigned int	types ()=0

virtual unsigned int	tokens () const =0

virtual PatternStoreInterface *	getstoreinterface ()

virtual int	getmodeltype () const =0

virtual int	getmodelversion () const =0

virtual unsigned int	occurrencecount (const Pattern &pattern)=0

virtual double	frequency (const Pattern &)=0

virtual int	maxlength () const =0

virtual int	minlength () const =0

virtual unsigned int	types ()=0

virtual unsigned int	tokens () const =0

virtual PatternStoreInterface *	getstoreinterface ()

Public Member Functions inherited from PatternStoreInterface
virtual bool	has (const Pattern &) const =0

virtual bool	has (const PatternPointer &) const =0

virtual size_t	size () const =0

virtual bool	has (const Pattern &) const =0

virtual bool	has (const PatternPointer &) const =0

virtual size_t	size () const =0

Detailed Description

Basic read-only interface for pattern models, abstract base class.

Member Function Documentation

virtual double PatternModelInterface::frequency ( const Pattern & )

pure virtual

Returns the number of times the frequency of the pattern in the model, a relative/normalised value

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual double PatternModelInterface::frequency ( const Pattern & )

pure virtual

Returns the frequency of the pattern in the model, a relative/normalised value

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual int PatternModelInterface::getmodeltype ( ) const

pure virtual

Get the type of the model

Returns: ModelType

Implemented in IndexedPatternPointerModel< MapType >, PatternPointerModel< ValueType, ValueHandler, MapType >, IndexedPatternModel< MapType, PatternType >, IndexedPatternModel< MapType, PatternPointer >, PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual int PatternModelInterface::getmodeltype ( ) const

pure virtual

Get the type of the model

Returns: ModelType

Implemented in IndexedPatternPointerModel< MapType >, PatternPointerModel< ValueType, ValueHandler, MapType >, IndexedPatternModel< MapType, PatternType >, IndexedPatternModel< MapType, PatternPointer >, PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual int PatternModelInterface::getmodelversion ( ) const

pure virtual

Get the version number of the model

Implemented in IndexedPatternPointerModel< MapType >, PatternPointerModel< ValueType, ValueHandler, MapType >, IndexedPatternModel< MapType, PatternType >, IndexedPatternModel< MapType, PatternPointer >, PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual int PatternModelInterface::getmodelversion ( ) const

pure virtual

Get the version number of the model

Implemented in IndexedPatternPointerModel< MapType >, PatternPointerModel< ValueType, ValueHandler, MapType >, IndexedPatternModel< MapType, PatternType >, IndexedPatternModel< MapType, PatternPointer >, PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual PatternStoreInterface* PatternModelInterface::getstoreinterface ( )

inlinevirtual

virtual PatternStoreInterface* PatternModelInterface::getstoreinterface ( )

inlinevirtual

virtual int PatternModelInterface::maxlength ( ) const

pure virtual

Return the maximum pattern length in this model

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual int PatternModelInterface::maxlength ( ) const

pure virtual

Return the maximum pattern length in this model

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual int PatternModelInterface::minlength ( ) const

pure virtual

Returns the minumum pattern length in this model

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual int PatternModelInterface::minlength ( ) const

pure virtual

Returns the minumum pattern length in this model

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual unsigned int PatternModelInterface::occurrencecount ( const Pattern & pattern )

pure virtual

Returns the number of times this pattern occurs in the model

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual unsigned int PatternModelInterface::occurrencecount ( const Pattern & pattern )

pure virtual

Returns the number of times this pattern occurs in the model

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual unsigned int PatternModelInterface::tokens ( ) const

pure virtual

Returns the number of tokens in the original corpus, includes tokens not covered by the model!

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual unsigned int PatternModelInterface::tokens ( ) const

pure virtual

Returns the number of tokens in the original corpus, includes tokens not covered by the model!

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual unsigned int PatternModelInterface::types ( )

pure virtual

Return the number of distinct words/unigram in the original corpus, includes types not covered by the model!

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

virtual unsigned int PatternModelInterface::types ( )

pure virtual

Return the number of distinct words/unigram in the original corpus, includes types not covered by the model!

Implemented in PatternModel< ValueType, ValueHandler, MapType, PatternType >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternPointer >, PatternModel< IndexedData, IndexedDataHandler, MapType, PatternType >, PatternModel< ValueType, ValueHandler, MapType, PatternPointer >, and PatternSetModel.

The documentation for this class was generated from the following files:

include/interface.h
include/patternmodel.h

Public Member Functions

Detailed Description

Member Function Documentation