An integer term stores a single std::size_t value. It carries no arguments. More...

#include <aterm_int.h>

Inheritance diagram for atermpp::aterm_int:

Public Member Functions
	aterm_int () noexcept=default
	Default constructor.

	aterm_int (std::size_t value)
	Constructs an integer term from a value.

	aterm_int (const aterm &t)
	Constructs an integer term from an aterm.

std::size_t	value () const noexcept
	Provide the value stored in an aterm.

void	swap (aterm_int &t) noexcept
	Swaps two integer terms without changing the protection.

Public Member Functions inherited from atermpp::aterm
	aterm ()
	Default constructor.

	aterm (const aterm &other) noexcept=default
	This class has user-declared copy constructor so declare default copy and move operators.

aterm &	operator= (const aterm &other) noexcept=default

	aterm (aterm &&other) noexcept=default

aterm &	operator= (aterm &&other) noexcept=default

template<class ForwardIterator > requires (mcrl2::utilities::is_iterator<ForwardIterator>::value && !std::is_same_v<typename ForwardIterator::iterator_category, std::input_iterator_tag> && !std::is_same_v<typename ForwardIterator::iterator_category, std::output_iterator_tag>)
	aterm (const function_symbol &sym, ForwardIterator begin, ForwardIterator end)
	Constructor that provides an aterm based on a function symbol and forward iterator providing the arguments.

template<class InputIterator > requires mcrl2::utilities::is_iterator<InputIterator>
	aterm (const function_symbol &sym, InputIterator begin, InputIterator end)
	Constructor that provides an aterm based on a function symbol and an input iterator providing the arguments.

template<class InputIterator , class TermConverter > requires mcrl2::utilities::is_iterator<InputIterator>
	aterm (const function_symbol &sym, InputIterator begin, InputIterator end, TermConverter converter)
	Constructor.

template<typename... Terms>
	aterm (const function_symbol &symbol, const Terms &... arguments)
	Constructor for n-arity function application.

const function_symbol &	function () const
	Returns the function symbol belonging to an aterm.

size_type	size () const
	Returns the number of arguments of this term.

bool	empty () const
	Returns true if the term has no arguments.

const_iterator	begin () const
	Returns an iterator pointing to the first argument.

const_iterator	end () const
	Returns a const_iterator pointing past the last argument.

constexpr size_type	max_size () const
	Returns the largest possible number of arguments.

const aterm &	operator[] (const size_type i) const
	Returns the i-th argument.

Public Member Functions inherited from atermpp::aterm_core
	aterm_core () noexcept
	Default constructor.

	~aterm_core () noexcept
	Standard destructor.

	aterm_core (const detail::_aterm *t) noexcept
	Constructor based on an internal term data structure. This is not for public use.

	aterm_core (const aterm_core &other) noexcept
	Copy constructor.

	aterm_core (aterm_core &&other) noexcept
	Move constructor.

aterm_core &	operator= (const aterm_core &other) noexcept
	Assignment operator.

aterm_core &	assign (const aterm_core &other, detail::thread_aterm_pool &pool) noexcept
	Assignment operator, to be used if busy and forbidden flags are explicitly available.

template<bool CHECK_BUSY_FLAG = true>
aterm_core &	unprotected_assign (const aterm_core &other) noexcept
	Assignment operator, to be used when the busy flags do not need to be set.

aterm_core &	operator= (aterm_core &&other) noexcept
	Move assignment operator.

Public Member Functions inherited from atermpp::unprotected_aterm_core
	unprotected_aterm_core () noexcept
	Default constuctor.

	unprotected_aterm_core (const detail::_aterm *term) noexcept
	Constructor.

bool	type_is_appl () const noexcept
	Dynamic check whether the term is an aterm.

bool	type_is_int () const noexcept
	Dynamic check whether the term is an aterm_int.

bool	type_is_list () const noexcept
	Dynamic check whether the term is an aterm_list.

bool	operator== (const unprotected_aterm_core &t) const
	Comparison operator.

std::weak_ordering	operator<=> (const unprotected_aterm_core &t) const
	Comparison operator for two unprotected aterms.

bool	defined () const
	Returns true if this term is not equal to the term assigned by the default constructor of aterms, aterm_appls and aterm_int.

void	swap (unprotected_aterm_core &t) noexcept
	Swaps this term with its argument.

const function_symbol &	function () const
	Yields the function symbol in an aterm.

Additional Inherited Members
Public Types inherited from atermpp::aterm
using	size_type = std::size_t
	An unsigned integral type.

using	difference_type = ptrdiff_t
	A signed integral type.

using	iterator = term_appl_iterator< aterm >
	Iterator used to iterate through an term_appl.

using	const_iterator = term_appl_iterator< aterm >
	Const iterator used to iterate through an term_appl.

Protected Member Functions inherited from atermpp::aterm
	aterm (detail::_term_appl *t)
	Constructor.

Protected Attributes inherited from atermpp::unprotected_aterm_core
const detail::_aterm *	m_term

Detailed Description

An integer term stores a single std::size_t value. It carries no arguments.

A special function symbol is used to identify integer terms internally.

Definition at line 25 of file aterm_int.h.

Constructor & Destructor Documentation

◆ aterm_int() [1/3]

atermpp::aterm_int::aterm_int ( )

defaultnoexcept

Default constructor.

◆ aterm_int() [2/3]

atermpp::aterm_int::aterm_int ( std::size_t value )

inlineexplicit

Constructs an integer term from a value.

Parameters

value The value of the new integer.

Definition at line 33 of file aterm_int.h.

◆ aterm_int() [3/3]

atermpp::aterm_int::aterm_int ( const aterm & t )

inlineexplicit

Constructs an integer term from an aterm.

Definition at line 39 of file aterm_int.h.

Member Function Documentation

◆ swap()

void atermpp::aterm_int::swap ( aterm_int & t )

inlinenoexcept

Swaps two integer terms without changing the protection.

Parameters

t	The term that is swapped with the current term.

Definition at line 56 of file aterm_int.h.

◆ value()

std::size_t atermpp::aterm_int::value ( ) const

inlinenoexcept

Provide the value stored in an aterm.

Returns: The value of the integer term.

Definition at line 47 of file aterm_int.h.

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

atermpp/include/mcrl2/atermpp/aterm_int.h

Public Member Functions

Additional Inherited Members