indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex > Class Template Reference

Full and linear tree index. The index serves as a adaptor of string index so that searching for tree patterns is possible. The representation of the index stores a string index and a subtree jump table. The implementation since parametrized with the string index represents a family of indexes. More...

#include <FullAndLinearIndex.h>

Public Member Functions
	FullAndLinearIndex (StringIndex< common::ranked_symbol< SymbolType > > stringIndex, ext::vector< int > jumpTable)
const StringIndex< common::ranked_symbol< SymbolType > > &	getStringIndex () const &
StringIndex< common::ranked_symbol< SymbolType > > &&	getStringIndex () &&
const ext::vector< int > &	getJumps () const &
ext::vector< int > &&	getJumps () &&
const ext::set< common::ranked_symbol< SymbolType > > &	getAlphabet () const &
ext::set< common::ranked_symbol< SymbolType > > &&	getAlphabet () &&
void	setStringIndex (StringIndex< common::ranked_symbol< SymbolType > > stringIndex)
bool	removeSymbolFromAlphabet (const common::ranked_symbol< SymbolType > &symbol)
auto	operator<=> (const FullAndLinearIndex &other) const
bool	operator== (const FullAndLinearIndex &other) const

Friends
ext::ostream &	operator<< (ext::ostream &out, const FullAndLinearIndex &instance)

Detailed Description

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>
class indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >

Full and linear tree index. The index serves as a adaptor of string index so that searching for tree patterns is possible. The representation of the index stores a string index and a subtree jump table. The implementation since parametrized with the string index represents a family of indexes.

The actual notation of used tree is irelevant. The index, as fas as the data structure is concerned, is not different. Of course tree in postfix notation must be queried with patterns in postfix notation, etc.

Template Parameters

SymbolType	used for the symbol part of the ranked symbol
StringIndex	a template parameter representing a type of the string index

Constructor & Destructor Documentation

FullAndLinearIndex()

template<class SymbolType , template< typename > class StringIndex>

indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::FullAndLinearIndex ( StringIndex< common::ranked_symbol< SymbolType > >  stringIndex, ext::vector< int >  jumpTable  )

explicit

Creates a new instance of the index with concrete alphabet, bit vectors, and subtree jump table.

Parameters

stringIndex	the concrete underlying string index.
jumpTable	the subtree jump table

Member Function Documentation

getAlphabet() [1/2]

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

ext::set< common::ranked_symbol< SymbolType > > && indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::getAlphabet ( ) &&

inline

Getter of the alphabet of the indexed tree.

Returns

the alphabet of the indexed tree

getAlphabet() [2/2]

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

const ext::set< common::ranked_symbol< SymbolType > > & indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::getAlphabet ( ) const &

inline

Getter of the alphabet of the indexed tree.

Returns

the alphabet of the indexed tree

getJumps() [1/2]

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

ext::vector< int > && indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::getJumps

(

)

&&

Getter of the subtree jump table

Returns

the subtree jump table

getJumps() [2/2]

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

const ext::vector< int > & indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::getJumps

(

)

const &

Getter of the subtree jump table

Returns

the subtree jump table

Here is the caller graph for this function:

getStringIndex() [1/2]

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

StringIndex< common::ranked_symbol< SymbolType > > && indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::getStringIndex

(

)

&&

Getter of the underlying string index.

Returns

underlying string index

getStringIndex() [2/2]

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

const StringIndex< common::ranked_symbol< SymbolType > > & indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::getStringIndex

(

)

const &

Getter of the underlying string index.

Returns

underlying string index

Here is the caller graph for this function:

operator<=>()

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

auto indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::operator<=> ( const FullAndLinearIndex< SymbolType, StringIndex > &  other ) const

inline

The three way comparison implementation

Parameters

other

the other instance

Returns

the ordering between this object and the other.

Here is the call graph for this function:

operator==()

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

bool indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::operator== ( const FullAndLinearIndex< SymbolType, StringIndex > &  other ) const

inline

The equality comparison implementation.

Parameters

other

the other object to compare with.

Returns

true if this and other objects are equal, false othervise

Here is the call graph for this function:

removeSymbolFromAlphabet()

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

bool indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::removeSymbolFromAlphabet ( const common::ranked_symbol< SymbolType > &  symbol )

inline

Remover of a symbol from the alphabet. The symbol can be removed if it is not used in any of bit vector keys.

Parameters

symbol

a symbol to remove.

setStringIndex()

template<class SymbolType , template< typename > class StringIndex>

void indexes::arbology::FullAndLinearIndex< SymbolType, StringIndex >::setStringIndex

(

StringIndex< common::ranked_symbol< SymbolType > >

stringIndex

)

Changes the underlying string index.

Parameters

stringIndex

new string index

Friends And Related Function Documentation

operator<<

template<class SymbolType = DefaultSymbolType, template< typename > class StringIndex = indexes::stringology::PositionHeap>

ext::ostream & operator<< ( ext::ostream &  out, const FullAndLinearIndex< SymbolType, StringIndex > &  instance  )

friend

Print this object as raw representation to ostream.

Parameters

out	ostream where to print
instance	object to print

Returns

modified output stream

---

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

• alib2data/src/indexes/arbology/FullAndLinearIndex.h