Inherited by Parma_Polyhedra_Library::Grid_Generator [private]
.
Public Types | |
enum | Type { LINE, RAY, POINT, CLOSURE_POINT } |
The generator type. More... | |
Public Member Functions | |
Generator (const Generator &g) | |
Ordinary copy-constructor. | |
~Generator () | |
Destructor. | |
Generator & | operator= (const Generator &g) |
Assignment operator. | |
dimension_type | space_dimension () const |
Returns the dimension of the vector space enclosing *this . | |
Type | type () const |
Returns the generator type of *this . | |
bool | is_line () const |
Returns true if and only if *this is a line. | |
bool | is_ray () const |
Returns true if and only if *this is a ray. | |
bool | is_point () const |
Returns true if and only if *this is a point. | |
bool | is_closure_point () const |
Returns true if and only if *this is a closure point. | |
Coefficient_traits::const_reference | coefficient (Variable v) const |
Returns the coefficient of v in *this . | |
Coefficient_traits::const_reference | divisor () const |
If *this is either a point or a closure point, returns its divisor. | |
memory_size_type | total_memory_in_bytes () const |
Returns a lower bound to 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 . | |
bool | is_equivalent_to (const Generator &y) const |
Returns true if and only if *this and y are equivalent generators. | |
bool | OK () const |
Checks if all the invariants are satisfied. | |
void | swap (Generator &y) |
Swaps *this with y . | |
Static Public Member Functions | |
static Generator | line (const Linear_Expression &e) |
Shorthand for Generator Generator::line(const Linear_Expression& e). | |
static Generator | ray (const Linear_Expression &e) |
Shorthand for Generator Generator::ray(const Linear_Expression& e). | |
static Generator | point (const Linear_Expression &e=Linear_Expression::zero(), Coefficient_traits::const_reference d=Coefficient_one()) |
Shorthand for Generator Generator::point(const Linear_Expression& e, Coefficient_traits::const_reference d). | |
static Generator | closure_point (const Linear_Expression &e=Linear_Expression::zero(), Coefficient_traits::const_reference d=Coefficient_one()) |
Shorthand for Generator Generator::closure_point(const Linear_Expression& e, Coefficient_traits::const_reference d). | |
static dimension_type | max_space_dimension () |
Returns the maximum space dimension a Generator can handle. | |
static const Generator & | zero_dim_point () |
Returns the origin of the zero-dimensional space ![]() | |
static const Generator & | zero_dim_closure_point () |
Returns, as a closure point, the origin of the zero-dimensional space ![]() | |
Friends | |
std::ostream & | operator<< (std::ostream &s, const Generator &g) |
Output operator. | |
Related Functions | |
(Note that these are not member functions.) | |
void | swap (Parma_Polyhedra_Library::Generator &x, Parma_Polyhedra_Library::Generator &y) |
Specializes std::swap . | |
bool | operator== (const Generator &x, const Generator &y) |
Returns true if and only if x is equivalent to y . | |
bool | operator!= (const Generator &x, const Generator &y) |
Returns true if and only if x is not equivalent to y . | |
std::ostream & | operator<< (std::ostream &s, const Generator::Type &t) |
Output operator. |
An object of the class Generator is one of the following:
where is the dimension of the space and, for points and closure points,
is the divisor.
line
, ray
, point
or closure_point
) to a linear expression, representing a direction in the space; the space dimension of the generator is defined as the space dimension of the corresponding linear expression. Linear expressions used to define a generator should be homogeneous (any constant term will be simply ignored). When defining points and closure points, an optional Coefficient argument can be used as a common divisor for all the coefficients occurring in the provided linear expression; the default value for this argument is 1.x
, y
and z
are defined as follows: Variable x(0); Variable y(1); Variable z(2);
point
is optional. Generator origin0 = Generator::zero_dim_point(); Generator origin0_alt = point();
point
(the divisor): Obviously, the divisor can be usefully exploited to specify points having some non-integer (but rational) coordinates. For instance, the point Generator c = closure_point(1*x + 0*y + 2*z);
Generator closure_origin0 = Generator::zero_dim_closure_point(); Generator closure_origin0_alt = closure_point();
g1
is a point having coordinates g2
having coordinates if (g1.is_point()) { cout << "Point g1: " << g1 << endl; Linear_Expression e; for (int i = g1.space_dimension() - 1; i >= 0; i--) e += (i + 1) * g1.coefficient(Variable(i)) * Variable(i); Generator g2 = closure_point(e, g1.divisor()); cout << "Closure point g2: " << g2 << endl; } else cout << "Generator g1 is not a point." << endl;
Point g1: p((2*A - B + 3*C)/2) Closure point g2: cp((2*A - 2*B + 9*C)/2)
The generator type.
LINE | The generator is a line. |
RAY | The generator is a ray. |
POINT | The generator is a point. |
CLOSURE_POINT | The generator is a closure point. |
Reimplemented in Parma_Polyhedra_Library::Grid_Generator.
Generator line | ( | const Linear_Expression & | e | ) | [inline, static] |
Shorthand for Generator Generator::line(const Linear_Expression& e).
std::invalid_argument | Thrown if the homogeneous part of e represents the origin of the vector space. |
Reimplemented in Parma_Polyhedra_Library::Grid_Generator.
Generator ray | ( | const Linear_Expression & | e | ) | [inline, static] |
Shorthand for Generator Generator::ray(const Linear_Expression& e).
std::invalid_argument | Thrown if the homogeneous part of e represents the origin of the vector space. |
Generator point | ( | const Linear_Expression & | e = Linear_Expression::zero() , |
|
Coefficient_traits::const_reference | d = Coefficient_one() | |||
) | [inline, static] |
Shorthand for Generator Generator::point(const Linear_Expression& e, Coefficient_traits::const_reference d).
Both e
and d
are optional arguments, with default values Linear_Expression::zero() and Coefficient_one(), respectively.
std::invalid_argument | Thrown if d is zero. |
Reimplemented in Parma_Polyhedra_Library::Grid_Generator.
Generator closure_point | ( | const Linear_Expression & | e = Linear_Expression::zero() , |
|
Coefficient_traits::const_reference | d = Coefficient_one() | |||
) | [inline, static] |
Shorthand for Generator Generator::closure_point(const Linear_Expression& e, Coefficient_traits::const_reference d).
Both e
and d
are optional arguments, with default values Linear_Expression::zero() and Coefficient_one(), respectively.
std::invalid_argument | Thrown if d is zero. |
Coefficient_traits::const_reference Parma_Polyhedra_Library::Generator::coefficient | ( | Variable | v | ) | const [inline] |
Returns the coefficient of v
in *this
.
std::invalid_argument | Thrown if the index of v is greater than or equal to the space dimension of *this . |
Coefficient_traits::const_reference Parma_Polyhedra_Library::Generator::divisor | ( | ) | const [inline] |
If *this
is either a point or a closure point, returns its divisor.
std::invalid_argument | Thrown if *this is neither a point nor a closure point. |
Reimplemented in Parma_Polyhedra_Library::Grid_Generator.
bool Parma_Polyhedra_Library::Generator::is_equivalent_to | ( | const Generator & | y | ) | const |
Returns true
if and only if *this
and y
are equivalent generators.
Generators having different space dimensions are not equivalent.