An adapter for Linear_Expression objects. More...

#include <Expression_Adapter_defs.hh>

Inheritance diagram for Parma_Polyhedra_Library::Expression_Adapter< T >:

[legend]

Collaboration diagram for Parma_Polyhedra_Library::Expression_Adapter< T >:

Public Types
typedef Expression_Adapter< T >	const_reference
	The type of this object. More...

typedef T::const_reference	inner_type
	The type obtained by one-level unwrapping. More...

typedef T::raw_type	raw_type
	The raw, completely unwrapped type. More...

typedef raw_type::const_iterator	const_iterator
	The type of const iterators on coefficients. More...

Public Member Functions
inner_type	inner () const
	Returns an adapter after one-level unwrapping. More...

Representation	representation () const
	Returns the current representation of `*this`. More...

const_iterator	begin () const
	Iterator pointing to the first nonzero variable coefficient. More...

const_iterator	end () const
	Iterator pointing after the last nonzero variable coefficient. More...

const_iterator	lower_bound (Variable v) const

dimension_type	space_dimension () const
	Returns the dimension of the vector space enclosing `*this`. More...

Coefficient_traits::const_reference	coefficient (Variable v) const
	Returns the coefficient of `v` in `*this`. More...

Coefficient_traits::const_reference	inhomogeneous_term () const
	Returns the inhomogeneous term of `*this`. More...

bool	is_zero () const
	Returns `true` if and only if `*this` is zero. More...

bool	all_homogeneous_terms_are_zero () const
	Returns `true` if and only if all the homogeneous terms of `*this` are zero. More...

template<typename Expression >
bool	is_equal_to (const Expression &y) const
	Returns `true` if `*this` is equal to `y`. More...

bool	all_zeroes (const Variables_Set &vars) const
	Returns `true` if the coefficient of each variable in `vars` is zero. More...

Coefficient_traits::const_reference	get (dimension_type i) const
	Returns the `i` -th coefficient. More...

Coefficient_traits::const_reference	get (Variable v) const
	Returns the coefficient of variable `v`. More...

bool	all_zeroes (dimension_type start, dimension_type end) const
	Returns `true` if (*this)[i] is zero, for each i in [start, end). More...

dimension_type	num_zeroes (dimension_type start, dimension_type end) const
	Returns the number of zero coefficient in [start, end). More...

Coefficient	gcd (dimension_type start, dimension_type end) const
	Returns the gcd of the nonzero coefficients in [start,end). Returns zero if all the coefficients in the range are zero. More...

dimension_type	last_nonzero () const

dimension_type	last_nonzero (dimension_type first, dimension_type last) const

dimension_type	first_nonzero (dimension_type first, dimension_type last) const

bool	all_zeroes_except (const Variables_Set &vars, dimension_type start, dimension_type end) const
	Returns `true` if all coefficients in [start,end), except those corresponding to variables in `vars`, are zero. More...

void	has_a_free_dimension_helper (std::set< dimension_type > &x) const
	Removes from set `x` all the indexes of nonzero elements in `*this`. More...

template<typename Expression >
bool	is_equal_to (const Expression &y, dimension_type start, dimension_type end) const

template<typename Expression >
bool	is_equal_to (const Expression &y, Coefficient_traits::const_reference c1, Coefficient_traits::const_reference c2, dimension_type start, dimension_type end) const

void	get_row (Dense_Row &r) const
	Sets `r` to a copy of the row as adapted by `*this`. More...

void	get_row (Sparse_Row &r) const
	Sets `r` to a copy of the row as adapted by `*this`. More...

template<typename Expression >
bool	have_a_common_variable (const Expression &y, Variable first, Variable last) const

Protected Member Functions
	Expression_Adapter (const raw_type &expr)
	Constructor. More...

Protected Attributes
const raw_type &	raw_
	The raw, completely unwrapped object subject to adaptation. More...

Detailed Description

template<typename T>
class Parma_Polyhedra_Library::Expression_Adapter< T >

An adapter for Linear_Expression objects.

The adapters are meant to provide read-only, customized access to the Linear_Expression members in Constraint, Generator, Congruence and Grid_Generator objects. They typically implement the user-level view of these expressions.

Note: A few methods implement low-level access routines and will take bare indexes as arguments (rather than Variable objects): when such a bare index i is zero, the inhomogeneous term is meant; when the bare index i is greater than zero, the coefficient of the variable having id i - 1 is meant.

Definition at line 56 of file Expression_Adapter_defs.hh.

Member Typedef Documentation

template<typename T>

typedef raw_type::const_iterator Parma_Polyhedra_Library::Expression_Adapter< T >::const_iterator

The type of const iterators on coefficients.

Definition at line 70 of file Expression_Adapter_defs.hh.

template<typename T>

typedef Expression_Adapter<T> Parma_Polyhedra_Library::Expression_Adapter< T >::const_reference

The type of this object.

Definition at line 60 of file Expression_Adapter_defs.hh.

template<typename T>

typedef T::const_reference Parma_Polyhedra_Library::Expression_Adapter< T >::inner_type

The type obtained by one-level unwrapping.

Definition at line 62 of file Expression_Adapter_defs.hh.

template<typename T>

typedef T::raw_type Parma_Polyhedra_Library::Expression_Adapter< T >::raw_type

The raw, completely unwrapped type.

Definition at line 64 of file Expression_Adapter_defs.hh.

Constructor & Destructor Documentation

template<typename T >

Parma_Polyhedra_Library::Expression_Adapter< T >::Expression_Adapter ( const raw_type & expr )

inlineexplicitprotected

Constructor.

Definition at line 33 of file Expression_Adapter_inlines.hh.

34 : raw_(expr) {

35 }

Parma_Polyhedra_Library::Expression_Adapter::raw_

const raw_type & raw_

The raw, completely unwrapped object subject to adaptation.

Definition: Expression_Adapter_defs.hh:189

Member Function Documentation

template<typename T >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::all_homogeneous_terms_are_zero ( ) const

inline

Returns true if and only if all the homogeneous terms of *this are zero.

Definition at line 93 of file Expression_Adapter_inlines.hh.

                                                             {
   return inner().all_homogeneous_terms_are_zero();
 }

template<typename T >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::all_zeroes ( const Variables_Set & vars ) const

inline

Returns true if the coefficient of each variable in vars is zero.

Definition at line 107 of file Expression_Adapter_inlines.hh.

Referenced by Parma_Polyhedra_Library::Box_Helpers::extract_interval_congruence().

                                             {
   return inner().all_zeroes(vars);
 }

template<typename T >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::all_zeroes	(	dimension_type	start,
		dimension_type	end
	)		const

inline

Returns true if (*this)[i] is zero, for each i in [start, end).

Definition at line 125 of file Expression_Adapter_inlines.hh.

                                                             {
   return inner().all_zeroes(start, end);
 }

template<typename T >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::all_zeroes_except	(	const Variables_Set &	vars,
		dimension_type	start,
		dimension_type	end
	)		const

inline

Returns true if all coefficients in [start,end), except those corresponding to variables in vars, are zero.

Definition at line 167 of file Expression_Adapter_inlines.hh.

                                                                     {
   return inner().all_zeroes_except(vars, start, end);
 }

template<typename T >

Expression_Adapter< T >::const_iterator Parma_Polyhedra_Library::Expression_Adapter< T >::begin ( ) const

inline

Iterator pointing to the first nonzero variable coefficient.

Definition at line 51 of file Expression_Adapter_inlines.hh.

                                    {
   return inner().begin();
 }

template<typename T >

Coefficient_traits::const_reference Parma_Polyhedra_Library::Expression_Adapter< T >::coefficient ( Variable v ) const

inline

Returns the coefficient of v in *this.

Definition at line 75 of file Expression_Adapter_inlines.hh.

                                                    {
   return inner().coefficient(v);
 }

template<typename T >

Expression_Adapter< T >::const_iterator Parma_Polyhedra_Library::Expression_Adapter< T >::end ( ) const

inline

Iterator pointing after the last nonzero variable coefficient.

Definition at line 57 of file Expression_Adapter_inlines.hh.

Referenced by Parma_Polyhedra_Library::Box< ITV >::relation_with().

                                  {
   return inner().end();
 }

template<typename T >

dimension_type Parma_Polyhedra_Library::Expression_Adapter< T >::first_nonzero	(	dimension_type	first,
		dimension_type	last
	)		const

inline

Returns the index of the first nonzero element, or last if there are no nonzero elements, considering only elements in [first,last).

Definition at line 159 of file Expression_Adapter_inlines.hh.

Referenced by Parma_Polyhedra_Library::Box_Helpers::extract_interval_congruence().

                                                                 {
   return inner().first_nonzero(first, last);
 }

template<typename T >

Coefficient Parma_Polyhedra_Library::Expression_Adapter< T >::gcd	(	dimension_type	start,
		dimension_type	end
	)		const

inline

Returns the gcd of the nonzero coefficients in [start,end). Returns zero if all the coefficients in the range are zero.

Definition at line 139 of file Expression_Adapter_inlines.hh.

                                                      {
   return inner().gcd(start, end);
 }

template<typename T >

Coefficient_traits::const_reference Parma_Polyhedra_Library::Expression_Adapter< T >::get ( dimension_type i ) const

inline

Returns the i -th coefficient.

Definition at line 113 of file Expression_Adapter_inlines.hh.

Referenced by Parma_Polyhedra_Library::Grid::conversion().

                                                  {
   return inner().get(i);
 }

template<typename T >

Coefficient_traits::const_reference Parma_Polyhedra_Library::Expression_Adapter< T >::get ( Variable v ) const

inline

Returns the coefficient of variable v.

Definition at line 119 of file Expression_Adapter_inlines.hh.

                                            {
   return inner().get(v);
 }

template<typename T >

void Parma_Polyhedra_Library::Expression_Adapter< T >::get_row ( Dense_Row & r ) const

inline

Sets r to a copy of the row as adapted by *this.

Definition at line 201 of file Expression_Adapter_inlines.hh.

                                                  {
   inner().get_row(r);
 }

template<typename T >

void Parma_Polyhedra_Library::Expression_Adapter< T >::get_row ( Sparse_Row & r ) const

inline

Sets r to a copy of the row as adapted by *this.

Definition at line 207 of file Expression_Adapter_inlines.hh.

                                                   {
   inner().get_row(r);
 }

template<typename T >

void Parma_Polyhedra_Library::Expression_Adapter< T >::has_a_free_dimension_helper ( std::set< dimension_type > & x ) const

inline

Removes from set x all the indexes of nonzero elements in *this.

Definition at line 175 of file Expression_Adapter_inlines.hh.

                                                              {
   inner().has_a_free_dimension_helper(x);
 }

template<typename T >

template<typename Expression >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::have_a_common_variable	(	const Expression &	y,
		Variable	first,
		Variable	last
	)		const

inline

Returns true if there is a variable in [first,last) whose coefficient is nonzero in both *this and y.

Definition at line 215 of file Expression_Adapter_inlines.hh.

                                                               {
   return inner().have_a_common_variable(y, first, last);
 }

template<typename T >

Coefficient_traits::const_reference Parma_Polyhedra_Library::Expression_Adapter< T >::inhomogeneous_term ( ) const

inline

Returns the inhomogeneous term of *this.

Definition at line 81 of file Expression_Adapter_inlines.hh.

Referenced by Parma_Polyhedra_Library::Implementation::Termination::fill_constraint_system_PR(), Parma_Polyhedra_Library::Implementation::Termination::fill_constraint_system_PR_original(), and Parma_Polyhedra_Library::Polyhedron::strongly_minimize_constraints().

                                                 {
   return inner().inhomogeneous_term();
 }

template<typename T >

Expression_Adapter< T >::inner_type Parma_Polyhedra_Library::Expression_Adapter< T >::inner ( ) const

inline

Returns an adapter after one-level unwrapping.

Definition at line 39 of file Expression_Adapter_inlines.hh.

                                    {
   return inner_type(raw_);
 }

template<typename T >

template<typename Expression >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::is_equal_to ( const Expression & y ) const

inline

Returns true if *this is equal to y.

Note that (*this == y) has a completely different meaning.

Definition at line 100 of file Expression_Adapter_inlines.hh.

                                                             {
   return inner().is_equal_to(y);
 }

template<typename T >

template<typename Expression >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::is_equal_to	(	const Expression &	y,
		dimension_type	start,
		dimension_type	end
	)		const

inline

Returns true if (*this)[i] is equal to y[i], for each i in [start,end).

Definition at line 183 of file Expression_Adapter_inlines.hh.

                                                               {
   return inner().is_equal_to(y, start, end);
 }

template<typename T >

template<typename Expression >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::is_equal_to	(	const Expression &	y,
		Coefficient_traits::const_reference	c1,
		Coefficient_traits::const_reference	c2,
		dimension_type	start,
		dimension_type	end
	)		const

inline

Returns true if (*this)[i]*c1 is equal to y[i]*c2, for each i in [start,end).

Definition at line 192 of file Expression_Adapter_inlines.hh.

                                                               {
   return inner().is_equal_to(y, c1, c2, start, end);
 }

template<typename T >

bool Parma_Polyhedra_Library::Expression_Adapter< T >::is_zero ( ) const

inline

Returns true if and only if *this is zero.

Definition at line 87 of file Expression_Adapter_inlines.hh.

                                      {
   return inner().is_zero();
 }

template<typename T >

dimension_type Parma_Polyhedra_Library::Expression_Adapter< T >::last_nonzero ( ) const

inline

Returns the index of the last nonzero element, or zero if there are no nonzero elements.

Definition at line 146 of file Expression_Adapter_inlines.hh.

                                           {
   return inner().last_nonzero();
 }

template<typename T >

dimension_type Parma_Polyhedra_Library::Expression_Adapter< T >::last_nonzero	(	dimension_type	first,
		dimension_type	last
	)		const

inline

Returns the index of the last nonzero element in [first,last), or last if there are no nonzero elements.

Definition at line 152 of file Expression_Adapter_inlines.hh.

                                                                {
   return inner().last_nonzero(first, last);
 }

template<typename T >

Expression_Adapter< T >::const_iterator Parma_Polyhedra_Library::Expression_Adapter< T >::lower_bound ( Variable v ) const

inline

Iterator pointing to the first nonzero variable coefficient of a variable bigger than or equal to v.

Definition at line 63 of file Expression_Adapter_inlines.hh.

Referenced by Parma_Polyhedra_Library::Congruence::operator<<().

                                                    {
   return inner().lower_bound(v);
 }

template<typename T >

dimension_type Parma_Polyhedra_Library::Expression_Adapter< T >::num_zeroes	(	dimension_type	start,
		dimension_type	end
	)		const

inline

Returns the number of zero coefficient in [start, end).

Definition at line 132 of file Expression_Adapter_inlines.hh.

                                                             {
   return inner().num_zeroes(start, end);
 }

template<typename T >

Representation Parma_Polyhedra_Library::Expression_Adapter< T >::representation ( ) const

inline

Returns the current representation of *this.

Definition at line 45 of file Expression_Adapter_inlines.hh.

                                             {
   return inner().representation();
 }

template<typename T >

dimension_type Parma_Polyhedra_Library::Expression_Adapter< T >::space_dimension ( ) const

inline

Returns the dimension of the vector space enclosing *this.

Definition at line 69 of file Expression_Adapter_inlines.hh.

                                              {
   return inner().space_dimension();
 }

Member Data Documentation

template<typename T>

const raw_type& Parma_Polyhedra_Library::Expression_Adapter< T >::raw_

protected

The raw, completely unwrapped object subject to adaptation.

Definition at line 189 of file Expression_Adapter_defs.hh.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename T> class Parma_Polyhedra_Library::Expression_Adapter< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class Parma_Polyhedra_Library::Expression_Adapter< T >