A wrapper for PPL pointsets, providing them with a determinate constraint system interface, as defined in [Bag98]. More...

#include <Determinate_defs.hh>

Collaboration diagram for Parma_Polyhedra_Library::Determinate< PSET >:

[legend]

Classes
class	Binary_Operator_Assign_Lifter
	A function adapter for the Determinate class. More...

class	Rep
	The possibly shared representation of a Determinate object. More...

Public Member Functions
Constructors and Destructor
	Determinate (const PSET &pset)
	Constructs a COW-wrapped object corresponding to the pointset `pset`. More...

	Determinate (const Constraint_System &cs)
	Constructs a COW-wrapped object corresponding to the pointset defined by `cs`. More...

	Determinate (const Congruence_System &cgs)
	Constructs a COW-wrapped object corresponding to the pointset defined by `cgs`. More...

	Determinate (const Determinate &y)
	Copy constructor. More...

	~Determinate ()
	Destructor. More...

Member Functions that May Modify the Domain Element
void	upper_bound_assign (const Determinate &y)
	Assigns to `this` the upper bound of `this` and `y`. More...

void	meet_assign (const Determinate &y)
	Assigns to `this` the meet of `this` and `y`. More...

void	weakening_assign (const Determinate &y)
	Assigns to `this` the result of weakening `this` with `y`. More...

void	concatenate_assign (const Determinate &y)
	Assigns to `this` the concatenation of `this` and `y`, taken in this order. More...

PSET &	pointset ()
	Returns a reference to the embedded element. More...

void	mutate ()
	On return from this method, the representation of `*this` is not shared by different Determinate objects. More...

Determinate &	operator= (const Determinate &y)
	Assignment operator. More...

void	m_swap (Determinate &y)
	Swaps `*this` with `y`. More...

Static Public Member Functions
template<typename Binary_Operator_Assign >
static Binary_Operator_Assign_Lifter< Binary_Operator_Assign >	lift_op_assign (Binary_Operator_Assign op_assign)
	Helper function returning a Binary_Operator_Assign_Lifter object, also allowing for the deduction of template arguments. More...

Private Attributes
Rep *	prep
	A pointer to the possibly shared representation of the base-level domain element. More...

Friends
bool	operator== (const Determinate< PSET > &x, const Determinate< PSET > &y)

bool	operator!= (const Determinate< PSET > &x, const Determinate< PSET > &y)

Related Functions
(Note that these are not member functions.)
template<typename PSET >
void	swap (Determinate< PSET > &x, Determinate< PSET > &y)
	Swaps `x` with `y`. More...

template<typename PSET >
bool	operator== (const Determinate< PSET > &x, const Determinate< PSET > &y)
	Returns `true` if and only if `x` and `y` are the same COW-wrapped pointset. More...

template<typename PSET >
bool	operator!= (const Determinate< PSET > &x, const Determinate< PSET > &y)
	Returns `true` if and only if `x` and `y` are different COW-wrapped pointsets. More...

template<typename PSET >
std::ostream &	operator<< (std::ostream &, const Determinate< PSET > &)
	Output operator. More...

template<typename PSET >
std::ostream &	operator<< (std::ostream &s, const Determinate< PSET > &x)

template<typename PSET >
bool	operator== (const Determinate< PSET > &x, const Determinate< PSET > &y)

template<typename PSET >
bool	operator!= (const Determinate< PSET > &x, const Determinate< PSET > &y)

template<typename PSET >
void	swap (Determinate< PSET > &x, Determinate< PSET > &y)

Member Functions that Do Not Modify the Domain Element
const PSET &	pointset () const
	Returns a const reference to the embedded pointset. More...

bool	is_top () const
	Returns `true` if and only if `*this` embeds the universe element `PSET`. More...

bool	is_bottom () const
	Returns `true` if and only if `*this` embeds the empty element of `PSET`. More...

bool	definitely_entails (const Determinate &y) const
	Returns `true` if and only if `*this` entails `y`. More...

bool	is_definitely_equivalent_to (const Determinate &y) const
	Returns `true` if and only if `*this` and `y` are definitely equivalent. More...

memory_size_type	total_memory_in_bytes () const
	Returns a lower bound to the total size in bytes of the memory occupied by `*this`. More...

memory_size_type	external_memory_in_bytes () const
	Returns a lower bound to the size in bytes of the memory managed by `*this`. More...

bool	OK () const
	Checks if all the invariants are satisfied. More...

static bool	has_nontrivial_weakening ()

Detailed Description

template<typename PSET>
class Parma_Polyhedra_Library::Determinate< PSET >

A wrapper for PPL pointsets, providing them with a determinate constraint system interface, as defined in [Bag98].

The implementation uses a copy-on-write optimization, making the class suitable for constructions, like the finite powerset and ask-and-tell of [Bag98], that are likely to perform many copies.

Definition at line 84 of file Determinate_defs.hh.

Constructor & Destructor Documentation

template<typename PSET >

Parma_Polyhedra_Library::Determinate< PSET >::Determinate ( const PSET & pset )

inline

Constructs a COW-wrapped object corresponding to the pointset pset.

Definition at line 94 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::Rep::new_reference(), and Parma_Polyhedra_Library::Determinate< PSET >::prep.

   : prep(new Rep(pset)) {
   prep->new_reference();
 }

template<typename PSET >

Parma_Polyhedra_Library::Determinate< PSET >::Determinate ( const Constraint_System & cs )

inline

Constructs a COW-wrapped object corresponding to the pointset defined by cs.

Definition at line 101 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::Rep::new_reference(), and Parma_Polyhedra_Library::Determinate< PSET >::prep.

   : prep(new Rep(cs)) {
   prep->new_reference();
 }

template<typename PSET >

Parma_Polyhedra_Library::Determinate< PSET >::Determinate ( const Congruence_System & cgs )

inline

Constructs a COW-wrapped object corresponding to the pointset defined by cgs.

Definition at line 108 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::Rep::new_reference(), and Parma_Polyhedra_Library::Determinate< PSET >::prep.

   : prep(new Rep(cgs)) {
   prep->new_reference();
 }

template<typename PSET >

Parma_Polyhedra_Library::Determinate< PSET >::Determinate ( const Determinate< PSET > & y )

inline

Copy constructor.

Definition at line 115 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::Rep::new_reference(), and Parma_Polyhedra_Library::Determinate< PSET >::prep.

   : prep(y.prep) {
   prep->new_reference();
 }

template<typename PSET >

Parma_Polyhedra_Library::Determinate< PSET >::~Determinate ( )

inline

Destructor.

Definition at line 122 of file Determinate_inlines.hh.

                                 {
   if (prep->del_reference()) {
     delete prep;
   }
 }

Member Function Documentation

template<typename PSET >

void Parma_Polyhedra_Library::Determinate< PSET >::concatenate_assign ( const Determinate< PSET > & y )

inline

Assigns to *this the concatenation of *this and y, taken in this order.

Definition at line 202 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::pointset().

Referenced by Parma_Polyhedra_Library::Pointset_Ask_Tell< PSET >::concatenate_assign(), and Parma_Polyhedra_Library::Pointset_Powerset< PSET >::concatenate_assign().

                                                           {
   pointset().concatenate_assign(y.pointset());
 }

template<typename PSET >

bool Parma_Polyhedra_Library::Determinate< PSET >::definitely_entails ( const Determinate< PSET > & y ) const

inline

Returns true if and only if *this entails y.

Definition at line 208 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::prep, and Parma_Polyhedra_Library::Determinate< PSET >::Rep::pset.

                                                                 {
   return prep == y.prep || y.prep->pset.contains(prep->pset);
 }

template<typename PSET >

memory_size_type Parma_Polyhedra_Library::Determinate< PSET >::external_memory_in_bytes ( ) const

inline

Returns a lower bound to the size in bytes of the memory managed by *this.

Definition at line 232 of file Determinate_inlines.hh.

Referenced by Parma_Polyhedra_Library::Determinate< PSET >::Rep::total_memory_in_bytes().

                                                   {
   return prep->total_memory_in_bytes();
 }

template<typename PSET >

bool Parma_Polyhedra_Library::Determinate< PSET >::has_nontrivial_weakening ( )

inlinestatic

Returns true if and only if this domain has a nontrivial weakening operator.

Definition at line 184 of file Determinate_inlines.hh.

                                             {
   // FIXME: the following should be turned into a query to PSET.  This
   // can be postponed until the time the ask-and-tell construction is
   // revived.
   return false;
 }

template<typename PSET >

bool Parma_Polyhedra_Library::Determinate< PSET >::is_bottom ( ) const

inline

Returns true if and only if *this embeds the empty element of PSET.

Definition at line 226 of file Determinate_inlines.hh.

Referenced by Parma_Polyhedra_Library::Pointset_Powerset< PSET >::concatenate_assign().

                                    {
   return prep->pset.is_empty();
 }

template<typename PSET >

bool Parma_Polyhedra_Library::Determinate< PSET >::is_definitely_equivalent_to ( const Determinate< PSET > & y ) const

inline

Returns true if and only if *this and y are definitely equivalent.

Definition at line 214 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::prep, and Parma_Polyhedra_Library::Determinate< PSET >::Rep::pset.

                                                                          {
   return prep == y.prep || prep->pset == y.prep->pset;
 }

template<typename PSET >

bool Parma_Polyhedra_Library::Determinate< PSET >::is_top ( ) const

inline

Returns true if and only if *this embeds the universe element PSET.

Definition at line 220 of file Determinate_inlines.hh.

                                 {
   return prep->pset.is_universe();
 }

template<typename PSET >

template<typename Binary_Operator_Assign >

Determinate< PSET >::Binary_Operator_Assign_Lifter< Binary_Operator_Assign > Parma_Polyhedra_Library::Determinate< PSET >::lift_op_assign ( Binary_Operator_Assign op_assign )

inlinestatic

Helper function returning a Binary_Operator_Assign_Lifter object, also allowing for the deduction of template arguments.

Definition at line 294 of file Determinate_inlines.hh.

                                                                   {
   return Binary_Operator_Assign_Lifter<Binary_Operator_Assign>(op_assign);
 }

template<typename PSET >

void Parma_Polyhedra_Library::Determinate< PSET >::m_swap ( Determinate< PSET > & y )

inline

Swaps *this with y.

Definition at line 141 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::prep, and Parma_Polyhedra_Library::swap().

Referenced by Parma_Polyhedra_Library::Determinate< PSET >::swap().

                                         {
   using std::swap;
   swap(prep, y.prep);
 }

template<typename PSET >

void Parma_Polyhedra_Library::Determinate< PSET >::meet_assign ( const Determinate< PSET > & y )

inline

Assigns to *this the meet of *this and y.

Definition at line 178 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::pointset().

                                                    {
   pointset().intersection_assign(y.pointset());
 }

template<typename PSET >

void Parma_Polyhedra_Library::Determinate< PSET >::mutate ( )

inline

On return from this method, the representation of *this is not shared by different Determinate objects.

Definition at line 148 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::Rep::new_reference().

                           {
   if (prep->is_shared()) {
     Rep* const new_prep = new Rep(prep->pset);
     (void) prep->del_reference();
     new_prep->new_reference();
     prep = new_prep;
   }
 }

template<typename PSET >

bool Parma_Polyhedra_Library::Determinate< PSET >::OK ( ) const

inline

Checks if all the invariants are satisfied.

Definition at line 244 of file Determinate_inlines.hh.

                             {
   return prep->pset.OK();
 }

template<typename PSET >

Determinate< PSET > & Parma_Polyhedra_Library::Determinate< PSET >::operator= ( const Determinate< PSET > & y )

inline

Assignment operator.

Definition at line 130 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::Rep::new_reference(), and Parma_Polyhedra_Library::Determinate< PSET >::prep.

                                                  {
   y.prep->new_reference();
   if (prep->del_reference()) {
     delete prep;
   }
   prep = y.prep;
   return *this;
 }

template<typename PSET >

const PSET & Parma_Polyhedra_Library::Determinate< PSET >::pointset ( ) const

inline

Returns a const reference to the embedded pointset.

Definition at line 159 of file Determinate_inlines.hh.

Referenced by Parma_Polyhedra_Library::Determinate< PSET >::concatenate_assign(), Parma_Polyhedra_Library::Determinate< PSET >::meet_assign(), Parma_Polyhedra_Library::Determinate< PSET >::Binary_Operator_Assign_Lifter< Binary_Operator_Assign >::operator()(), Parma_Polyhedra_Library::Determinate< PSET >::upper_bound_assign(), and Parma_Polyhedra_Library::Determinate< PSET >::weakening_assign().

                                   {
   return prep->pset;
 }

template<typename PSET >

PSET & Parma_Polyhedra_Library::Determinate< PSET >::pointset ( )

inline

Returns a reference to the embedded element.

Definition at line 165 of file Determinate_inlines.hh.

                             {
   mutate();
   return prep->pset;
 }

template<typename PSET >

memory_size_type Parma_Polyhedra_Library::Determinate< PSET >::total_memory_in_bytes ( ) const

inline

Returns a lower bound to the total size in bytes of the memory occupied by *this.

Definition at line 238 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::external_memory_in_bytes().

                                                {
   return sizeof(*this) + external_memory_in_bytes();
 }

template<typename PSET >

void Parma_Polyhedra_Library::Determinate< PSET >::upper_bound_assign ( const Determinate< PSET > & y )

inline

Assigns to *this the upper bound of *this and y.

Definition at line 172 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::pointset().

                                                           {
   pointset().upper_bound_assign(y.pointset());
 }

template<typename PSET >

void Parma_Polyhedra_Library::Determinate< PSET >::weakening_assign ( const Determinate< PSET > & y )

inline

Assigns to *this the result of weakening *this with y.

Definition at line 193 of file Determinate_inlines.hh.

References Parma_Polyhedra_Library::Determinate< PSET >::pointset().

                                                         {
   // FIXME: the following should be turned into a proper
   // implementation.  This can be postponed until the time the
   // ask-and-tell construction is revived.
   pointset().difference_assign(y.pointset());
 }

Friends And Related Function Documentation

template<typename PSET >

bool operator!=	(	const Determinate< PSET > &	x,
		const Determinate< PSET > &	y
	)

template<typename PSET >

bool operator!=	(	const Determinate< PSET > &	x,
		const Determinate< PSET > &	y
	)

References Parma_Polyhedra_Library::Determinate< PSET >::prep.

                                                                    {
   return x.prep != y.prep && x.prep->pset != y.prep->pset;
 }

template<typename PSET>

bool operator!=	(	const Determinate< PSET > &	x,
		const Determinate< PSET > &	y
	)

friend

template<typename PSET >

std::ostream & operator<<	(	std::ostream &	,
		const Determinate< PSET > &
	)

template<typename PSET >

std::ostream & operator<<	(	std::ostream &	s,
		const Determinate< PSET > &	x
	)

                                                       {
   s << x.pointset();
   return s;
 }

template<typename PSET >

bool operator==	(	const Determinate< PSET > &	x,
		const Determinate< PSET > &	y
	)

template<typename PSET >

bool operator==	(	const Determinate< PSET > &	x,
		const Determinate< PSET > &	y
	)

References Parma_Polyhedra_Library::Determinate< PSET >::prep.

                                                                    {
   return x.prep == y.prep || x.prep->pset == y.prep->pset;
 }

template<typename PSET>

bool operator==	(	const Determinate< PSET > &	x,
		const Determinate< PSET > &	y
	)

friend

template<typename PSET >

void swap	(	Determinate< PSET > &	x,
		Determinate< PSET > &	y
	)

template<typename PSET >

void swap	(	Determinate< PSET > &	x,
		Determinate< PSET > &	y
	)

References Parma_Polyhedra_Library::Determinate< PSET >::m_swap().

                                                  {
   x.m_swap(y);
 }

Member Data Documentation

template<typename PSET>

Rep* Parma_Polyhedra_Library::Determinate< PSET >::prep

private

A pointer to the possibly shared representation of the base-level domain element.

Definition at line 319 of file Determinate_defs.hh.

Referenced by Parma_Polyhedra_Library::Determinate< PSET >::definitely_entails(), Parma_Polyhedra_Library::Determinate< PSET >::Determinate(), Parma_Polyhedra_Library::Determinate< PSET >::is_definitely_equivalent_to(), Parma_Polyhedra_Library::Determinate< PSET >::m_swap(), Parma_Polyhedra_Library::Determinate< PSET >::operator!=(), Parma_Polyhedra_Library::Determinate< PSET >::operator=(), and Parma_Polyhedra_Library::Determinate< PSET >::operator==().

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

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Related Functions

Member Functions that Do Not Modify the Domain Element

Detailed Description

template<typename PSET> class Parma_Polyhedra_Library::Determinate< PSET >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename PSET>
class Parma_Polyhedra_Library::Determinate< PSET >