tree::UnorderedRankedTree< SymbolType > Class Template Reference

Tree structure represented in its natural representation. The representation is so called ranked, therefore it consists of ranked symbols. The rank of the ranked symbol needs to be compatible with unsigned integer. More...

#include <UnorderedRankedTree.h>

Inheritance diagram for tree::UnorderedRankedTree< SymbolType >:

Collaboration diagram for tree::UnorderedRankedTree< SymbolType >:

Public Member Functions
	UnorderedRankedTree (ext::set< common::ranked_symbol< SymbolType > > alphabet, ext::tree< common::ranked_symbol< SymbolType > > tree)
	Creates a new instance of the tree with concrete alphabet and content. More...
	UnorderedRankedTree (ext::tree< common::ranked_symbol< SymbolType > > tree)
	Creates a new instance of the tree based on the content, the alphabet is implicitly created from the content. More...
	UnorderedRankedTree (const RankedTree< SymbolType > &tree)
	Creates a new instance of the tree based on the Ranked Tree. More...
const ext::set< common::ranked_symbol< SymbolType > > &	getAlphabet () const &
ext::set< common::ranked_symbol< SymbolType > > &&	getAlphabet () &&
void	extendAlphabet (const ext::set< common::ranked_symbol< SymbolType > > &symbols)
const ext::tree< common::ranked_symbol< SymbolType > > &	getContent () const &
ext::tree< common::ranked_symbol< SymbolType > > &&	getContent () &&
void	setTree (ext::tree< common::ranked_symbol< SymbolType > > tree)
auto	operator<=> (const UnorderedRankedTree &other) const
bool	operator== (const UnorderedRankedTree &other) const
void	nicePrint (ext::ostream &os) const
Public Member Functions inherited from core::Components< UnorderedRankedTree< SymbolType >, ext::set< common::ranked_symbol< SymbolType > >, component::Set, GeneralAlphabet >
void	accessComponent ()

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

Additional Inherited Members
Static Public Member Functions inherited from core::Components< UnorderedRankedTree< SymbolType >, ext::set< common::ranked_symbol< SymbolType > >, component::Set, GeneralAlphabet >
static void	registerComponent ()
static void	unregisterComponent ()

Detailed Description

template<class SymbolType>
class tree::UnorderedRankedTree< SymbolType >

Tree structure represented in its natural representation. The representation is so called ranked, therefore it consists of ranked symbols. The rank of the ranked symbol needs to be compatible with unsigned integer.

T = (A, C), A (Alphabet) = finite set of ranked symbols, C (Content) = tree in its natural representation

Template Parameters

SymbolType

used for the symbol part of the ranked symbol

Constructor & Destructor Documentation

UnorderedRankedTree() [1/3]

template<class SymbolType >

tree::UnorderedRankedTree< SymbolType >::UnorderedRankedTree ( ext::set< common::ranked_symbol< SymbolType > >  alphabet, ext::tree< common::ranked_symbol< SymbolType > >  tree  )

explicit

Creates a new instance of the tree with concrete alphabet and content.

Parameters

alphabet	the initial alphabet of the tree
tree	the initial tree in its natural representation

UnorderedRankedTree() [2/3]

template<class SymbolType >

tree::UnorderedRankedTree< SymbolType >::UnorderedRankedTree ( ext::tree< common::ranked_symbol< SymbolType > >  tree )

explicit

Creates a new instance of the tree based on the content, the alphabet is implicitly created from the content.

Parameters

tree	the initial tree in its natural representation

UnorderedRankedTree() [3/3]

template<class SymbolType >

tree::UnorderedRankedTree< SymbolType >::UnorderedRankedTree ( const RankedTree< SymbolType > &  tree )

explicit

Creates a new instance of the tree based on the Ranked Tree.

Parameters

tree	the ranked tree to use.

Member Function Documentation

extendAlphabet()

template<class SymbolType >

void tree::UnorderedRankedTree< SymbolType >::extendAlphabet ( const ext::set< common::ranked_symbol< SymbolType > > &  symbols )

inline

Adder of an alphabet symbols.

Parameters

symbols

the new symbols to be added to the alphabet

getAlphabet() [1/2]

template<class SymbolType >

ext::set< common::ranked_symbol< SymbolType > > && tree::UnorderedRankedTree< SymbolType >::getAlphabet ( ) &&

inline

Getter of the alphabet.

Returns

the alphabet of the tree

Here is the call graph for this function:

getAlphabet() [2/2]

template<class SymbolType >

const ext::set< common::ranked_symbol< SymbolType > > & tree::UnorderedRankedTree< SymbolType >::getAlphabet ( ) const &

inline

Getter of the alphabet.

Returns

the alphabet of the tree

Here is the caller graph for this function:

getContent() [1/2]

template<class SymbolType >

ext::tree< common::ranked_symbol< SymbolType > > && tree::UnorderedRankedTree< SymbolType >::getContent

(

)

&&

Getter of the tree representation.

Returns

the natural representation of the tree.

getContent() [2/2]

template<class SymbolType >

const ext::tree< common::ranked_symbol< SymbolType > > & tree::UnorderedRankedTree< SymbolType >::getContent

(

)

const &

Getter of the tree representation.

Returns

the natural representation of the tree.

Here is the caller graph for this function:

nicePrint()

template<class SymbolType >

void tree::UnorderedRankedTree< SymbolType >::nicePrint

(

ext::ostream &

os

)

const

Hierarchical printer of the tree.

Parameters

os	the output stream destination of the print

Here is the call graph for this function:

Here is the caller graph for this function:

operator<=>()

template<class SymbolType >

auto tree::UnorderedRankedTree< SymbolType >::operator<=> ( const UnorderedRankedTree< SymbolType > &  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 >

bool tree::UnorderedRankedTree< SymbolType >::operator== ( const UnorderedRankedTree< SymbolType > &  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:

setTree()

template<class SymbolType >

void tree::UnorderedRankedTree< SymbolType >::setTree

(

ext::tree< common::ranked_symbol< SymbolType > >

tree

)

Setter of the representation of the tree.

Exceptions

TreeException

in same situations as checkAlphabet and checkArities

Parameters

tree	new representation of the tree.

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

template<class SymbolType >

ext::ostream & operator<< ( ext::ostream &  out, const UnorderedRankedTree< SymbolType > &  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/tree/ranked/UnorderedRankedTree.h