Tree pattern 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. Additionally the pattern contains a special wildcard symbol representing any subtree. More...

#include <RankedPattern.h>

Inheritance diagram for tree::RankedPattern< SymbolType >:

[legend]

Collaboration diagram for tree::RankedPattern< SymbolType >:

[legend]

Public Member Functions
	RankedPattern (common::ranked_symbol< SymbolType > subtreeWildcard, ext::set< common::ranked_symbol< SymbolType > > alphabet, ext::tree< common::ranked_symbol< SymbolType > > pattern)
	Creates a new instance of the pattern with concrete alphabet, content, and wildcard. More...

	RankedPattern (common::ranked_symbol< SymbolType > subtreeWildcard, ext::tree< common::ranked_symbol< SymbolType > > pattern)
	Creates a new instance of the pattern with concrete content and wildcard. The alphabet is deduced from the content. More...

	RankedPattern (const UnrankedPattern< SymbolType > &other)
	Creates a new instance of the pattern based on UnrankedPattern, the alphabet is created from the content of the UnrankedPattern. The alphabet is created since ranks cannot be deduced. 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 common::ranked_symbol< SymbolType > &	getSubtreeWildcard () const &

common::ranked_symbol< SymbolType > &&	getSubtreeWildcard () &&

const ext::tree< common::ranked_symbol< SymbolType > > &	getContent () const &

ext::tree< common::ranked_symbol< SymbolType > > &&	getContent () &&

void	setTree (ext::tree< common::ranked_symbol< SymbolType > > pattern)

auto	operator<=> (const RankedPattern &other) const

bool	operator== (const RankedPattern &other) const

void	nicePrint (ext::ostream &os) const

Public Member Functions inherited from core::Components< RankedPattern< SymbolType >, ext::set< common::ranked_symbol< SymbolType > >, component::Set, GeneralAlphabet, common::ranked_symbol< SymbolType >, component::Value, SubtreeWildcard >
void	accessComponent ()

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

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

static void	unregisterComponent ()

Detailed Description

template<class SymbolType>
class tree::RankedPattern< SymbolType >

Tree pattern 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. Additionally the pattern contains a special wildcard symbol representing any subtree.

T = (A, C, W \in ( A \minus B ) ), A (Alphabet) = finite set of ranked symbols, C (Content) = pattern in its natural representation W (Wildcard) = special symbol representing any subtree

Template Parameters

SymbolType used for the symbol part of the ranked symbol

Constructor & Destructor Documentation

◆ RankedPattern() [1/3]

template<class SymbolType >

tree::RankedPattern< SymbolType >::RankedPattern	(	common::ranked_symbol< SymbolType >	subtreeWildcard,
		ext::set< common::ranked_symbol< SymbolType > >	alphabet,
		ext::tree< common::ranked_symbol< SymbolType > >	pattern
	)

explicit

Creates a new instance of the pattern with concrete alphabet, content, and wildcard.

Parameters

subtreeWildcard	the wildcard symbol
alphabet	the initial alphabet of the pattern
pattern	the initial content in it's natural representation

◆ RankedPattern() [2/3]

template<class SymbolType >

tree::RankedPattern< SymbolType >::RankedPattern	(	common::ranked_symbol< SymbolType >	subtreeWildcard,
		ext::tree< common::ranked_symbol< SymbolType > >	pattern
	)

explicit

Creates a new instance of the pattern with concrete content and wildcard. The alphabet is deduced from the content.

Parameters

subtreeWildcard	the wildcard symbol
pattern	the initial content in it's natural representation

◆ RankedPattern() [3/3]

template<class SymbolType >

tree::RankedPattern< SymbolType >::RankedPattern ( const UnrankedPattern< SymbolType > & other )

explicit

Creates a new instance of the pattern based on UnrankedPattern, the alphabet is created from the content of the UnrankedPattern. The alphabet is created since ranks cannot be deduced.

Parameters

other the pattern represented as UnrankedNonlinearPattern

Member Function Documentation

◆ extendAlphabet()

template<class SymbolType >

void tree::RankedPattern< 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::RankedPattern< SymbolType >::getAlphabet ( ) &&

inline

Getter of the alphabet.

Returns: the alphabet of the pattern

Here is the call graph for this function:

◆ getAlphabet() [2/2]

template<class SymbolType >

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

inline

Getter of the alphabet.

Returns: the alphabet of the pattern

Here is the caller graph for this function:

◆ getContent() [1/2]

template<class SymbolType >

ext::tree< common::ranked_symbol< SymbolType > > && tree::RankedPattern< SymbolType >::getContent ( ) &&

Getter of the pattern representation.

Returns: the natural representation of the pattern.

◆ getContent() [2/2]

template<class SymbolType >

const ext::tree< common::ranked_symbol< SymbolType > > & tree::RankedPattern< SymbolType >::getContent ( ) const &

Getter of the pattern representation.

Returns: the natural representation of the pattern.

Here is the caller graph for this function:

◆ getSubtreeWildcard() [1/2]

template<class SymbolType >

common::ranked_symbol< SymbolType > && tree::RankedPattern< SymbolType >::getSubtreeWildcard ( ) &&

inline

Getter of the wildcard symbol.

Returns: the wildcard symbol of the pattern

Here is the call graph for this function:

◆ getSubtreeWildcard() [2/2]

template<class SymbolType >

const common::ranked_symbol< SymbolType > & tree::RankedPattern< SymbolType >::getSubtreeWildcard ( ) const &

inline

Getter of the wildcard symbol.

Returns: the wildcard symbol of the pattern

Here is the caller graph for this function:

◆ nicePrint()

template<class SymbolType >

void tree::RankedPattern< SymbolType >::nicePrint ( ext::ostream & os ) const

Nice printer of the tree natural representation

Parameters

os	the output stream to print to

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator<=>()

template<class SymbolType >

auto tree::RankedPattern< SymbolType >::operator<=> ( const RankedPattern< 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::RankedPattern< SymbolType >::operator== ( const RankedPattern< 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::RankedPattern< SymbolType >::setTree ( ext::tree< common::ranked_symbol< SymbolType > > pattern )

Setter of the representation of the pattern.

Exceptions

TreeException in same situations as checkAlphabet and checkArities

Parameters

pattern new representation of the pattern.

Friends And Related Function Documentation

◆ operator<<

template<class SymbolType >

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RankedPattern() [1/3]

◆ RankedPattern() [2/3]

◆ RankedPattern() [3/3]

Member Function Documentation

◆ extendAlphabet()

◆ getAlphabet() [1/2]

◆ getAlphabet() [2/2]

◆ getContent() [1/2]

◆ getContent() [2/2]

◆ getSubtreeWildcard() [1/2]

◆ getSubtreeWildcard() [2/2]

◆ nicePrint()

◆ operator<=>()

◆ operator==()

◆ setTree()

Friends And Related Function Documentation

◆ operator<<