Parma_Polyhedra_Library::Grid_Generator_System Class Reference
[C++ Language Interface]

A system of grid generators. More...

#include <ppl.hh>

Inherits Parma_Polyhedra_Library::Generator_System.

Collaboration diagram for Parma_Polyhedra_Library::Grid_Generator_System:

[legend]

List of all members.

Classes
class	const_iterator
	An iterator over a system of grid generators. More...
Public Member Functions
	Grid_Generator_System ()
	Default constructor: builds an empty system of generators.
	Grid_Generator_System (const Grid_Generator &g)
	Builds the singleton system containing only generator g.
	Grid_Generator_System (dimension_type dim)
	Builds an empty system of generators of dimension dim.
	Grid_Generator_System (const Grid_Generator_System &gs)
	Ordinary copy-constructor.
	~Grid_Generator_System ()
	Destructor.
Grid_Generator_System &	operator= (const Grid_Generator_System &y)
	Assignment operator.
dimension_type	space_dimension () const
	Returns the dimension of the vector space enclosing *this.
void	clear ()
	Removes all the generators from the generator system and sets its space dimension to 0.
void	insert (const Grid_Generator &g)
	Inserts into *this a copy of the generator g, increasing the number of space dimensions if needed.
void	recycling_insert (Grid_Generator &g)
	Inserts into *this the generator g, increasing the number of space dimensions if needed.
void	recycling_insert (Grid_Generator_System &gs)
	Inserts into *this the generators in gs, increasing the number of space dimensions if needed.
bool	empty () const
	Returns true if and only if *this has no generators.
const_iterator	begin () const
	Returns the const_iterator pointing to the first generator, if this is not empty; otherwise, returns the past-the-end const_iterator.
const_iterator	end () const
	Returns the past-the-end const_iterator.
dimension_type	num_rows () const
	Returns the number of rows (generators) in the system.
dimension_type	num_parameters () const
	Returns the number of parameters in the system.
dimension_type	num_lines () const
	Returns the number of lines in the system.
bool	has_points () const
	Returns true if and only if *this contains one or more points.
bool	is_equal_to (const Grid_Generator_System &y) const
	Returns true if *this is identical to y.
bool	OK () const
	Checks if all the invariants are satisfied.
memory_size_type	total_memory_in_bytes () const
	Returns the total size in bytes of the memory occupied by *this.
memory_size_type	external_memory_in_bytes () const
	Returns the size in bytes of the memory managed by *this.
void	swap (Grid_Generator_System &y)
	Swaps *this with y.
Static Public Member Functions
static dimension_type	max_space_dimension ()
	Returns the maximum space dimension a Grid_Generator_System can handle.
static void	initialize ()
	Initializes the class.
static void	finalize ()
	Finalizes the class.
static const Grid_Generator_System &	zero_dim_univ ()
	Returns the singleton system containing only Grid_Generator::zero_dim_point().
Friends
bool	operator== (const Grid_Generator_System &x, const Grid_Generator_System &y)
	Returns true if and only if x and y are identical.
Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &s, const Grid_Generator_System &gs)
	Output operator.
void	swap (Parma_Polyhedra_Library::Grid_Generator_System &x, Parma_Polyhedra_Library::Grid_Generator_System &y)
	Specializes std::swap.

---

Detailed Description

A system of grid generators.

An object of the class Grid_Generator_System is a system of grid generators, i.e., a multiset of objects of the class Grid_Generator (lines, parameters and points). When inserting generators in a system, space dimensions are automatically adjusted so that all the generators in the system are defined on the same vector space. A system of grid generators which is meant to define a non-empty grid must include at least one point: the reason is that lines and parameters need a supporting point (lines only specify directions while parameters only specify direction and distance.

In all the examples it is assumed that variables x and y are defined as follows:

  Variable x(0);
  Variable y(1);

Example 1

The following code defines the line having the same direction as the axis (i.e., the first Cartesian axis) in :

  Grid_Generator_System gs;
  gs.insert(grid_line(x + 0*y));

As said above, this system of generators corresponds to an empty grid, because the line has no supporting point. To define a system of generators that does correspond to the axis, we can add the following code which inserts the origin of the space as a point:

  gs.insert(grid_point(0*x + 0*y));

Since space dimensions are automatically adjusted, the following code obtains the same effect:

  gs.insert(grid_point(0*x));

In contrast, if we had added the following code, we would have defined a line parallel to the axis through the point .

  gs.insert(grid_point(0*x + 1*y));

Example 2

The following code builds a system of generators corresponding to the grid consisting of all the integral points on the axes; that is, all points satisfying the congruence relation

  Grid_Generator_System gs;
  gs.insert(parameter(x + 0*y));
  gs.insert(grid_point(0*x + 0*y));

Example 3

The following code builds a system of generators having three points corresponding to a non-relational grid consisting of all points whose coordinates are integer multiple of 3.

  Grid_Generator_System gs;
  gs.insert(grid_point(0*x + 0*y));
  gs.insert(grid_point(0*x + 3*y));
  gs.insert(grid_point(3*x + 0*y));

Example 4

By using parameters instead of two of the points we can define the same grid as that defined in the previous example. Note that there has to be at least one point and, for this purpose, any point in the grid could be considered. Thus the following code builds two identical grids from the grid generator systems gs and gs1.

  Grid_Generator_System gs;
  gs.insert(grid_point(0*x + 0*y));
  gs.insert(parameter(0*x + 3*y));
  gs.insert(parameter(3*x + 0*y));
  Grid_Generator_System gs1;
  gs1.insert(grid_point(3*x + 3*y));
  gs1.insert(parameter(0*x + 3*y));
  gs1.insert(parameter(3*x + 0*y));

Example 5

The following code builds a system of generators having one point and a parameter corresponding to all the integral points that lie on in

  Grid_Generator_System gs;
  gs.insert(grid_point(1*x + 1*y));
  gs.insert(parameter(1*x - 1*y));

Note:

After inserting a multiset of generators in a grid generator system, there are no guarantees that an exact copy of them can be retrieved: in general, only an equivalent grid generator system will be available, where original generators may have been reordered, removed (if they are duplicate or redundant), etc.

---

Member Function Documentation

void Parma_Polyhedra_Library::Grid_Generator_System::insert

(

const Grid_Generator &

g

)

Inserts into *this a copy of the generator g, increasing the number of space dimensions if needed.

If g is an all-zero parameter then the only action is to ensure that the space dimension of *this is at least the space dimension of g.

bool Parma_Polyhedra_Library::Grid_Generator_System::OK

(

)

const

Checks if all the invariants are satisfied.

Returns true if and only if *this is a valid Linear_System and each row in the system is a valid Grid_Generator.

Reimplemented from Parma_Polyhedra_Library::Generator_System.

---

Friends And Related Function Documentation

bool operator==	(	const Grid_Generator_System &	x,
		const Grid_Generator_System &	y
	)			[friend]

Returns true if and only if x and y are identical.

std::ostream & operator<<	(	std::ostream &	s,
		const Grid_Generator_System &	gs
	)			[related]

Output operator.

Writes false if gs is empty. Otherwise, writes on s the generators of gs, all in one row and separated by ", ".

void swap	(	Parma_Polyhedra_Library::Grid_Generator_System &	x,
		Parma_Polyhedra_Library::Grid_Generator_System &	y
	)			[related]

Specializes std::swap.

---

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

• ppl.hh