Include file:
#include "mcrl2/atermpp/function_symbol.h
atermpp::
function_symbol
¶friend class atermpp::function_symbol::detail::_aterm
friend class atermpp::function_symbol::detail::function_symbol_pool
friend class atermpp::function_symbol::function_symbol_generator
friend struct atermpp::function_symbol::std::hash
atermpp::function_symbol::
m_function_symbol
¶The shared reference to the underlying function symbol.
arity
() const¶Return the arity (number of arguments) of the function symbol (function_symbol).
Returns: The arity of the function symbol.
defined
() const¶function_symbol
() = default¶function_symbol
(const function_symbol &other) noexcept = default¶This class has non-trivial destructor so declare default copy and move operators.
function_symbol
(const std::string &name, const std::size_t arity_)¶Defines a function symbol from a name and arity combination.
function_symbol
(function_symbol &&other) noexcept = default¶function_symbol
(std::string &&name, const std::size_t arity_)¶Defines a function symbol from a name and arity combination.
name
() const¶Return the name of the function_symbol.
Returns: The name of the function symbol.
operator!=
(const function_symbol &f) const¶Inequality test.
This operator takes constant time.
Returns: True iff the function symbols are not equal.
operator<
(const function_symbol &f) const¶Comparison operation.
This operator takes constant time.
Returns: True iff this function has a lower index than the argument.
operator<=
(const function_symbol &f) const¶Comparison operation.
This operator takes constant time.
Returns: True iff this function has a lower or equal index than the argument.
operator=
(const function_symbol &other) noexcept = default¶operator=
(function_symbol &&other) noexcept = default¶operator==
(const function_symbol &f) const¶Equality test.
This operator compares the indices of the function symbols. This means that this operation takes constant time.
Returns: True iff the function symbols are the same.
operator>
(const function_symbol &f) const¶Comparison operation.
This operator takes constant time.
Returns: True iff this function has a higher index than the argument.
operator>=
(const function_symbol &f) const¶Comparison operation.
This operator takes constant time.
Returns: True iff this function has a larger or equal index than the argument.
swap
(function_symbol &f)¶Swap this function with its argument.
More efficient than assigning twice.
Parameters:
destroy
()¶Calls the function symbol pool to free our used memory.
function_symbol
(const std::string &name, const std::size_t arity, const bool check_for_registered_functions)¶Constructor for internal use only.
function_symbol
(detail::_function_symbol::ref &&f)¶Constructor for internal use only.
function_symbol
(std::string &&name, const std::size_t arity, const bool check_for_registered_functions)¶Constructor for internal use only.