apron::texpr1::iterator Class Reference

Iterators to traverse and mutate an expression tree. More...

#include <apxx_texpr1.hh>

Inherits apron::texpr1::const_iterator.

Public Member Functions
Constructors
	iterator (texpr1 &e)
	Starts a new iterator at the root of the tree.
	iterator (const iterator &i)
	Duplicates the iterator.
Expression substitutions
iterator &	operator= (const builder &x)
	Replace the sub-expression at the iterator position with a (deep) copy of c.
Access
texpr0::iterator	get_texpr0 () const
	Returns an iterator at the root of the underlying texpr0.
coeff &	get_coeff () const
	Returns a (modifiable) reference to the coefficient of a constant node.
void	set_var (const var &v) const
	Sets the variable name of a dimension node.
ap_dim_t &	get_dim () const
	Returns a (modifiable) reference to the dimension of a dimension node.
ap_texpr_op_t &	get_op () const
	Returns a (modifiable) reference to the operator kind of an operator node.
ap_texpr_rtype_t &	get_rtype () const
	Returns a (modifiable) reference to the destination type of an operator node.
ap_texpr_rdir_t &	get_rdir () const
	Returns a (modifiable) reference to the rounding direction of an operator node.
Traversal
iterator &	operator= (const iterator &i)
	Resets the iterator at position i.
iterator	child () const
	Constructs an iterator to the only or left sub-expression of an operator node.
iterator	left () const
	Constructs an iterator to the only of left sub-expression of an operator node.
iterator	right () const
	Constructs an iterator to the right sub-expression argument of a binary operator node.
C API compatibility
ap_texpr1_t *	get_ap_texpr1_t ()
	Returns a pointer to the internal APRON object stored in *this.
const ap_texpr1_t *	get_ap_texpr1_t () const
	Returns a pointer to the internal APRON object stored in *this.
Public Member Functions inherited from apron::texpr1::const_iterator
	const_iterator (const texpr1 &e)
	Starts a new const_iterator at the root of a constant expression tree.
	const_iterator (const const_iterator &i)
	Duplicates the const_iterator.
environment	get_environment () const
	Returns (a copy of) the environment associated with the expression.
texpr0::const_iterator	get_texpr0 () const
	Returns a constant iterator at the root of the underlying texpr0.
ap_texpr_discr_t	get_discr () const
	Returns the node kind.
const coeff &	get_coeff () const
	Returns a reference to the coefficient of a constant node.
const var &	get_var () const
	Returns a (unmodifiable) reference to the variable name of a dimension node.
ap_dim_t	get_dim () const
	Returns the dimension of a dimension node.
ap_texpr_op_t	get_op () const
	Returns the operator kind of an operator node.
ap_texpr_rtype_t	get_rtype () const
	Returns the destination type of an operator node.
ap_texpr_rdir_t	get_rdir () const
	Returns the rounding direction of an operator node.
const_iterator &	operator= (const const_iterator &i)
	Resets the const_iterator at position i.
const_iterator	child () const
	Constructs a const_iterator to the only or left sub-expression of an operator node.
const_iterator	left () const
	Constructs a const_iterator to the only of left sub-expression of an operator node.
const_iterator	right () const
	Constructs a const_iterator to the right sub-expression argument of a binary operator node.
bool	equal (const texpr1 &x) const
	Whether two expressions are syntactically, structurally equal.
bool	is_zero () const
	Whether the expression is a single coefficient node with 0 value.
size_t	depth () const
	Returns the depth of the expression tree (counting only operator nodes).
size_t	size () const
	Returns the number of operator nodes in the expression tree.
bool	has_var (const var &v) const
	Whether the given variable name occurs in the expression.
bool	is_interval_cst () const
	Whether the expression is constant (i.e., has no dimension leaves).
bool	is_interval_linear () const
	Whether the expression is linear and there is no rounding.
bool	is_interval_polynomial () const
	Whether the expression is polynomial and there is no rounding.
bool	is_interval_polyfrac () const
	Whether the expression is a polynomial fraction and there is no rounding.
bool	is_scalar () const
	Whether all occurring constants are scalar.
ap_texpr1_t *	get_ap_texpr1_t ()
	Returns a pointer to the internal APRON object stored in *this.
const ap_texpr1_t *	get_ap_texpr1_t () const
	Returns a pointer to the internal APRON object stored in *this.
void	print (FILE *stream=stdout) const
	Prints to a C stream.

Protected Member Functions
	iterator (ap_texpr1_t *l)
	Internal use only.
	iterator (ap_texpr0_t *t, ap_environment_t *e)
	Internal use only.
Protected Member Functions inherited from apron::texpr1::const_iterator
	const_iterator (ap_texpr1_t *l)
	Internal use only.
	const_iterator (ap_texpr0_t *t, ap_environment_t *e)
	Internal use only.

Additional Inherited Members
Protected Attributes inherited from apron::texpr1::const_iterator
ap_texpr1_t	l

Detailed Description

Iterators to traverse and mutate an expression tree.

As const_iterator, but can be used to modify as well as traverse nodes.

Constructor & Destructor Documentation

iterator() [1/4]

texpr1::iterator::iterator ( ap_texpr1_t * l )

inlineprotected

Internal use only.

iterator() [2/4]

apron::texpr1::iterator::iterator ( ap_texpr0_t * t, ap_environment_t * e )

inlineprotected

Internal use only.

iterator() [3/4]

texpr1::iterator::iterator ( texpr1 & e )

inline

Starts a new iterator at the root of the tree.

iterator() [4/4]

texpr1::iterator::iterator ( const iterator & i )

inline

Duplicates the iterator.

Member Function Documentation

child()

texpr1::iterator texpr1::iterator::child ( ) const

inline

Constructs an iterator to the only or left sub-expression of an operator node.

Exceptions

bad_discriminant

if the node is not an operator node.

get_ap_texpr1_t() [1/2]

ap_texpr1_t * texpr1::iterator::get_ap_texpr1_t ( )

inline

Returns a pointer to the internal APRON object stored in *this.

get_ap_texpr1_t() [2/2]

const ap_texpr1_t * texpr1::iterator::get_ap_texpr1_t ( ) const

inline

Returns a pointer to the internal APRON object stored in *this.

get_coeff()

coeff & texpr1::iterator::get_coeff ( ) const

inline

Returns a (modifiable) reference to the coefficient of a constant node.

Exceptions

bad_discriminant

if the node is not a constant leaf.

get_dim()

ap_dim_t & texpr1::iterator::get_dim ( ) const

inline

Returns a (modifiable) reference to the dimension of a dimension node.

Exceptions

bad_discriminant

if the node is not a dimension node.

get_op()

ap_texpr_op_t & texpr1::iterator::get_op ( ) const

inline

Returns a (modifiable) reference to the operator kind of an operator node.

Returns

either AP_TEXPR_ADD, AP_TEXPR_SUB, AP_TEXPR_MUL, AP_TEXPR_DIV, AP_TEXPR_MOD, AP_TEXPR_POW, AP_TEXPR_NEG, AP_TEXPR_CAST, or AP_TEXPR_SQRT.

Exceptions

bad_discriminant

if the node is not an operator node.

get_rdir()

ap_texpr_rdir_t & texpr1::iterator::get_rdir ( ) const

inline

Returns a (modifiable) reference to the rounding direction of an operator node.

Returns

either AP_RDIR_NEAREST, AP_RDIR_ZERO, AP_RDIR_UP, AP_RDIR_DOWN, or AP_RDIR_RND.

Exceptions

bad_discriminant

if the node is not an operator node.

get_rtype()

ap_texpr_rtype_t & texpr1::iterator::get_rtype ( ) const

inline

Returns a (modifiable) reference to the destination type of an operator node.

Returns

either AP_RTYPE_REAL, AP_RTYPE_INT, AP_RTYPE_SINGLE (32-bit), AP_RTYPE_DOUBLE (64-bit), AP_RTYPE_EXTENDED (80-bit), or AP_RTYPE_QUAD (128-bit).

Exceptions

bad_discriminant

if the node is not an operator node.

get_texpr0()

texpr0::iterator texpr1::iterator::get_texpr0 ( ) const

inline

Returns an iterator at the root of the underlying texpr0.

left()

texpr1::iterator texpr1::iterator::left ( ) const

inline

Constructs an iterator to the only of left sub-expression of an operator node.

(Identical to child()).

Exceptions

bad_discriminant

if the node is not an operator node.

operator=() [1/2]

texpr1::iterator & apron::texpr1::iterator::operator= ( const builder & x )

inline

Replace the sub-expression at the iterator position with a (deep) copy of c.

Assumes that the *this and have the same environment (unchecked).

operator=() [2/2]

texpr1::iterator & texpr1::iterator::operator= ( const iterator & i )

inline

Resets the iterator at position i.

right()

texpr1::iterator texpr1::iterator::right ( ) const

inline

Constructs an iterator to the right sub-expression argument of a binary operator node.

Exceptions

bad_discriminant	if the node is not an operator node.
std::out_of_range	if the operator node is not binary.

set_var()

void texpr1::iterator::set_var ( const var & v ) const

inline

Sets the variable name of a dimension node.

Exceptions

bad_discriminant	if the node is not a dimension node.
std::invalid_argument	if the environment does not contain a variable.

---

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

• /home/mine/apron/apronxx/apxx_texpr1.hh
• /home/mine/apron/apronxx/apxx_texpr1_inline.hh