alphabet::NonlinearVariableSymbol< SymbolType > Class Template Reference

Represents the nonlinear variable symbol used in a nonlinear tree pattern. More...

#include <NonlinearVariableSymbol.h>

Public Member Functions
	NonlinearVariableSymbol (SymbolType symbol)
	Creates a new instance of the nonlinear variable with some underlying base symbol. More...
const SymbolType &	getSymbol () const &
SymbolType &&	getSymbol () &&
auto	operator<=> (const NonlinearVariableSymbol &other) const
bool	operator== (const NonlinearVariableSymbol &other) const

Friends
ext::ostream &	operator<< (ext::ostream &out, const NonlinearVariableSymbol< SymbolType > &instance)

Detailed Description

template<class SymbolType = DefaultSymbolType>
class alphabet::NonlinearVariableSymbol< SymbolType >

Represents the nonlinear variable symbol used in a nonlinear tree pattern.

Constructor & Destructor Documentation

NonlinearVariableSymbol()

template<class SymbolType >

alphabet::NonlinearVariableSymbol< SymbolType >::NonlinearVariableSymbol ( SymbolType  symbol )

explicit

Creates a new instance of the nonlinear variable with some underlying base symbol.

Member Function Documentation

getSymbol() [1/2]

template<class SymbolType = DefaultSymbolType>

SymbolType && alphabet::NonlinearVariableSymbol< SymbolType >::getSymbol

(

)

&&

Getter of the nonlinear variable's symbol

Returns

the symbol of the nonlinear variable

getSymbol() [2/2]

template<class SymbolType = DefaultSymbolType>

const SymbolType & alphabet::NonlinearVariableSymbol< SymbolType >::getSymbol

(

)

const &

Getter of the nonlinear variable's symbol

Returns

the symbol of the nonlinear variable

Here is the caller graph for this function:

operator<=>()

template<class SymbolType = DefaultSymbolType>

auto alphabet::NonlinearVariableSymbol< SymbolType >::operator<=> ( const NonlinearVariableSymbol< SymbolType > &  other ) const

inline

The three way comparison implementation

Parameters

other

the other instance

Returns

the ordering between this object and the other.

operator==()

template<class SymbolType = DefaultSymbolType>

bool alphabet::NonlinearVariableSymbol< SymbolType >::operator== ( const NonlinearVariableSymbol< 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

Friends And Related Function Documentation

operator<<

template<class SymbolType = DefaultSymbolType>

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