#include <Partial_Function_defs.hh>

Public Member Functions
	Partial_Function ()
	Default constructor: builds a function with empty codomain (i.e., always undefined). More...

bool	has_empty_codomain () const
	Returns `true` if and only if the represented partial function has an empty codomain (i.e., it is always undefined). More...

dimension_type	max_in_codomain () const
	If the codomain is not empty, returns the maximum value in it. More...

bool	maps (dimension_type i, dimension_type &j) const
	If `*this` maps `i` to a value `k`, assigns `k` to `j` and returns `true`; otherwise, `j` is unchanged and `false` is returned. More...

void	print (std::ostream &s) const

void	insert (dimension_type i, dimension_type j)
	Modifies `*this` so that `i` is mapped to `j`. More...

Private Attributes
std::vector< dimension_type >	vec

dimension_type	max

std::set< dimension_type >	codomain

Detailed Description

Definition at line 37 of file Partial_Function_defs.hh.

Constructor & Destructor Documentation

Parma_Polyhedra_Library::Partial_Function::Partial_Function ( )

inline

Default constructor: builds a function with empty codomain (i.e., always undefined).

Definition at line 33 of file Partial_Function_inlines.hh.

34 : max(0) {

35 }

Parma_Polyhedra_Library::Partial_Function::max

dimension_type max

Definition: Partial_Function_defs.hh:77

Member Function Documentation

bool Parma_Polyhedra_Library::Partial_Function::has_empty_codomain ( ) const

inline

Returns true if and only if the represented partial function has an empty codomain (i.e., it is always undefined).

Definition at line 38 of file Partial_Function_inlines.hh.

References codomain, and vec.

Referenced by Parma_Polyhedra_Library::Box< ITV >::map_space_dimensions(), Parma_Polyhedra_Library::Octagonal_Shape< T >::map_space_dimensions(), Parma_Polyhedra_Library::BD_Shape< T >::map_space_dimensions(), Parma_Polyhedra_Library::Grid::map_space_dimensions(), Parma_Polyhedra_Library::Polyhedron::map_space_dimensions(), max_in_codomain(), and print().

                                            {
   PPL_ASSERT(vec.empty() == codomain.empty());
   return vec.empty();
 }

void Parma_Polyhedra_Library::Partial_Function::insert	(	dimension_type	i,
		dimension_type	j
	)

inline

Modifies *this so that i is mapped to j.

Exceptions

std::runtime_error Thrown if *this is already mapping j.

Definition at line 55 of file Partial_Function_inlines.hh.

References codomain, max, Parma_Polyhedra_Library::not_a_dimension(), and vec.

                                                            {
 #ifndef NDEBUG
   // The partial function has to be an injective map.
   std::pair<std::set<dimension_type>::iterator, bool> s = codomain.insert(j);
   PPL_ASSERT(s.second);
 #endif // #ifndef NDEBUG
 
   // Expand `vec' if needed.
   const dimension_type sz = vec.size();
   if (i >= sz) {
     vec.insert(vec.end(), i - sz + 1, not_a_dimension());
   }
 
   // We cannot remap the same index to another one.
   PPL_ASSERT(i < vec.size() && vec[i] == not_a_dimension());
   vec[i] = j;
 
   // Maybe update `max'.
   if (j > max) {
     max = j;
   }
   PPL_ASSERT(codomain.begin() != codomain.end()
              && max == *codomain.rbegin());
 }

bool Parma_Polyhedra_Library::Partial_Function::maps	(	dimension_type	i,
		dimension_type &	j
	)		const

inline

If *this maps i to a value k, assigns k to j and returns true; otherwise, j is unchanged and false is returned.

Definition at line 81 of file Partial_Function_inlines.hh.

References Parma_Polyhedra_Library::not_a_dimension(), and vec.

Referenced by Parma_Polyhedra_Library::Pointset_Ask_Tell< PSET >::map_space_dimensions(), Parma_Polyhedra_Library::Pointset_Powerset< PSET >::map_space_dimensions(), Parma_Polyhedra_Library::Box< ITV >::map_space_dimensions(), Parma_Polyhedra_Library::Octagonal_Shape< T >::map_space_dimensions(), Parma_Polyhedra_Library::BD_Shape< T >::map_space_dimensions(), Parma_Polyhedra_Library::Grid::map_space_dimensions(), and Parma_Polyhedra_Library::Polyhedron::map_space_dimensions().

                                                                 {
   if (i >= vec.size()) {
     return false;
   }
   const dimension_type vec_i = vec[i];
   if (vec_i == not_a_dimension()) {
     return false;
   }
   j = vec_i;
   return true;
 }

dimension_type Parma_Polyhedra_Library::Partial_Function::max_in_codomain ( ) const

inline

If the codomain is not empty, returns the maximum value in it.

Exceptions

std::runtime_error Thrown if called when *this has an empty codomain.

Definition at line 44 of file Partial_Function_inlines.hh.

References codomain, has_empty_codomain(), and max.

Referenced by Parma_Polyhedra_Library::Box< ITV >::map_space_dimensions(), Parma_Polyhedra_Library::Octagonal_Shape< T >::map_space_dimensions(), Parma_Polyhedra_Library::BD_Shape< T >::map_space_dimensions(), Parma_Polyhedra_Library::Grid::map_space_dimensions(), and Parma_Polyhedra_Library::Polyhedron::map_space_dimensions().

                                         {
   if (has_empty_codomain()) {
     throw std::runtime_error("Partial_Function::max_in_codomain() called"
                              " when has_empty_codomain()");
   }
   PPL_ASSERT(codomain.begin() != codomain.end()
              && max == *codomain.rbegin());
   return max;
 }

void Parma_Polyhedra_Library::Partial_Function::print ( std::ostream & s ) const

Definition at line 32 of file Partial_Function.cc.

References has_empty_codomain(), Parma_Polyhedra_Library::not_a_dimension(), and vec.

                                            {
   using namespace Parma_Polyhedra_Library::IO_Operators;
   if (has_empty_codomain()) {
     s << "empty" << std::endl;
   }
   else {
     for (dimension_type i = 0, i_end = vec.size(); i < i_end; ++i) {
       if (vec[i] != not_a_dimension()) {
         s << Variable(i) << " --> " << Variable(vec[i]) << "\n";
       }
     }
   }
 }