PPL Configured C Language Interface  1.2
ppl_Generator_tag Interface Reference

Types and functions for generators. More...

#include <ppl_c.h>

Related Functions

(Note that these are not member functions.)

Constructors, Assignment and Destructor
int ppl_new_Generator (ppl_Generator_t *pg, ppl_const_Linear_Expression_t le, enum ppl_enum_Generator_Type t, ppl_const_Coefficient_t d)
 Creates a new generator of direction le and type t. If the generator to be created is a point or a closure point, the divisor d is applied to le. For other types of generators d is simply disregarded. A handle for the new generator is written at address pg. The space dimension of the new generator is equal to the space dimension of le. More...
 
int ppl_new_Generator_zero_dim_point (ppl_Generator_t *pg)
 Creates the point that is the origin of the zero-dimensional space $\Rset^0$. Writes a handle for the new generator at address pg. More...
 
int ppl_new_Generator_zero_dim_closure_point (ppl_Generator_t *pg)
 Creates, as a closure point, the point that is the origin of the zero-dimensional space $\Rset^0$. Writes a handle for the new generator at address pg. More...
 
int ppl_new_Generator_from_Generator (ppl_Generator_t *pg, ppl_const_Generator_t g)
 Builds a generator that is a copy of g; writes a handle for the newly created generator at address pg. More...
 
int ppl_assign_Generator_from_Generator (ppl_Generator_t dst, ppl_const_Generator_t src)
 Assigns a copy of the generator src to dst. More...
 
int ppl_delete_Generator (ppl_const_Generator_t g)
 Invalidates the handle g: this makes sure the corresponding resources will eventually be released. More...
 
Functions that Do Not Modify the Generator
int ppl_Generator_space_dimension (ppl_const_Generator_t g, ppl_dimension_type *m)
 Writes to m the space dimension of g. More...
 
int ppl_Generator_type (ppl_const_Generator_t g)
 Returns the type of generator g. More...
 
int ppl_Generator_coefficient (ppl_const_Generator_t g, ppl_dimension_type var, ppl_Coefficient_t n)
 Copies into n the coefficient of variable var in generator g. More...
 
int ppl_Generator_divisor (ppl_const_Generator_t g, ppl_Coefficient_t n)
 If g is a point or a closure point assigns its divisor to n. More...
 
int ppl_Generator_OK (ppl_const_Generator_t g)
 Returns a positive integer if g is well formed, i.e., if it satisfies all its implementation invariants; returns 0 and perhaps makes some noise if g is broken. Useful for debugging purposes. More...
 

Detailed Description

Types and functions for generators.

The types and functions for generators provide an interface towards Generator.

Friends And Related Function Documentation

int ppl_assign_Generator_from_Generator ( ppl_Generator_t  dst,
ppl_const_Generator_t  src 
)
related

Assigns a copy of the generator src to dst.

Definition at line 984 of file ppl_c_implementation_common.cc.

int ppl_delete_Generator ( ppl_const_Generator_t  g)
related

Invalidates the handle g: this makes sure the corresponding resources will eventually be released.

Definition at line 977 of file ppl_c_implementation_common.cc.

int ppl_Generator_coefficient ( ppl_const_Generator_t  g,
ppl_dimension_type  var,
ppl_Coefficient_t  n 
)
related

Copies into n the coefficient of variable var in generator g.

Definition at line 1018 of file ppl_c_implementation_common.cc.

int ppl_Generator_divisor ( ppl_const_Generator_t  g,
ppl_Coefficient_t  n 
)
related

If g is a point or a closure point assigns its divisor to n.

Definition at line 1029 of file ppl_c_implementation_common.cc.

int ppl_Generator_OK ( ppl_const_Generator_t  g)
related

Returns a positive integer if g is well formed, i.e., if it satisfies all its implementation invariants; returns 0 and perhaps makes some noise if g is broken. Useful for debugging purposes.

Definition at line 1039 of file ppl_c_implementation_common.cc.

int ppl_Generator_space_dimension ( ppl_const_Generator_t  g,
ppl_dimension_type m 
)
related

Writes to m the space dimension of g.

Definition at line 994 of file ppl_c_implementation_common.cc.

int ppl_Generator_type ( ppl_const_Generator_t  g)
related

Returns the type of generator g.

Definition at line 1002 of file ppl_c_implementation_common.cc.

int ppl_new_Generator ( ppl_Generator_t *  pg,
ppl_const_Linear_Expression_t  le,
enum ppl_enum_Generator_Type  t,
ppl_const_Coefficient_t  d 
)
related

Creates a new generator of direction le and type t. If the generator to be created is a point or a closure point, the divisor d is applied to le. For other types of generators d is simply disregarded. A handle for the new generator is written at address pg. The space dimension of the new generator is equal to the space dimension of le.

Definition at line 925 of file ppl_c_implementation_common.cc.

int ppl_new_Generator_from_Generator ( ppl_Generator_t *  pg,
ppl_const_Generator_t  g 
)
related

Builds a generator that is a copy of g; writes a handle for the newly created generator at address pg.

Definition at line 968 of file ppl_c_implementation_common.cc.

int ppl_new_Generator_zero_dim_closure_point ( ppl_Generator_t *  pg)
related

Creates, as a closure point, the point that is the origin of the zero-dimensional space $\Rset^0$. Writes a handle for the new generator at address pg.

Definition at line 961 of file ppl_c_implementation_common.cc.

int ppl_new_Generator_zero_dim_point ( ppl_Generator_t *  pg)
related

Creates the point that is the origin of the zero-dimensional space $\Rset^0$. Writes a handle for the new generator at address pg.

Definition at line 954 of file ppl_c_implementation_common.cc.


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