atermpp::unprotected_aterm_core Class Reference

An unprotected term does not change the reference count of the shared term when it is copied or moved. More...

#include <aterm_core.h>

Inheritance diagram for atermpp::unprotected_aterm_core:

Public Member Functions
	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.

Protected Attributes
const detail::_aterm *	m_term

Friends
detail::_aterm *	detail::address (const unprotected_aterm_core &t)

Detailed Description

An unprotected term does not change the reference count of the shared term when it is copied or moved.

Definition at line 33 of file aterm_core.h.

Constructor & Destructor Documentation

unprotected_aterm_core() [1/2]

atermpp::unprotected_aterm_core::unprotected_aterm_core ( )

inlinenoexcept

Default constuctor.

Definition at line 43 of file aterm_core.h.

unprotected_aterm_core() [2/2]

atermpp::unprotected_aterm_core::unprotected_aterm_core ( const detail::_aterm *  term )

inlinenoexcept

Constructor.

Parameters

term	The term from which the new term is constructed.

Definition at line 49 of file aterm_core.h.

Member Function Documentation

defined()

bool atermpp::unprotected_aterm_core::defined ( ) const

inline

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

The default constructor of a term_list<T> is the empty list, on which the operator defined yields true. This operation is more efficient than comparing the current term with an aterm(), aterm_list() or an aterm_int().

Returns

A boolean indicating whether this term equals the default constructor.

Definition at line 111 of file aterm_core.h.

function()

const function_symbol & atermpp::unprotected_aterm_core::function ( ) const

inline

Yields the function symbol in an aterm.

Returns

The function symbol of the term, which can also be an AS_EMPTY_LIST, AS_INT and AS_LIST.

This is for internal use only.

Definition at line 129 of file aterm_core.h.

operator<=>()

std::weak_ordering atermpp::unprotected_aterm_core::operator<=> ( const unprotected_aterm_core &  t ) const

inline

Comparison operator for two unprotected aterms.

This operator is constant time. It compares the addresses where terms are stored. That means that the outcome of this operator is only stable as long as aterms are not garbage collected.

Parameters

t	A term to which the current term is compared.

Returns

True iff the current term is smaller than the argument.

Definition at line 99 of file aterm_core.h.

operator==()

bool atermpp::unprotected_aterm_core::operator== ( const unprotected_aterm_core &  t ) const

inline

Comparison operator.

Terms are stored in a maximally shared way. This means that this equality operator can be calculated in constant time.

Returns

true iff t is equal to the current term.

Definition at line 87 of file aterm_core.h.

swap()

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

inlinenoexcept

Swaps this term with its argument.

This operation is more efficient than exchanging terms by an assignment, as swapping does not require to change the protection of terms.

Parameters

t	The term with which this term is swapped.

Definition at line 120 of file aterm_core.h.

type_is_appl()

bool atermpp::unprotected_aterm_core::type_is_appl ( ) const

inlinenoexcept

Dynamic check whether the term is an aterm.

Returns

True iff this term is an term_appl.

This function has constant complexity. It is defined as !type_is_int() && !type_is_list().

Definition at line 57 of file aterm_core.h.

type_is_int()

bool atermpp::unprotected_aterm_core::type_is_int ( ) const

inlinenoexcept

Dynamic check whether the term is an aterm_int.

Returns

True iff this term has internal structure of an aterm_int.

This function has constant complexity.

Definition at line 65 of file aterm_core.h.

type_is_list()

bool atermpp::unprotected_aterm_core::type_is_list ( ) const

inlinenoexcept

Dynamic check whether the term is an aterm_list.

Returns

True iff this term has the structure of an term_list

This function has constant complexity.

Definition at line 75 of file aterm_core.h.

Friends And Related Symbol Documentation

detail::address

detail::_aterm * detail::address ( const unprotected_aterm_core &  t )

friend

Member Data Documentation

m_term

const detail::_aterm* atermpp::unprotected_aterm_core::m_term

protected

Definition at line 38 of file aterm_core.h.

---

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

• atermpp/include/mcrl2/atermpp/aterm_core.h