ppl_Grid_Generator_tag Interface Reference

Types and functions for grid generators. More...

#include <ppl_c_header.h>

List of all members.

Related Functions

(Note that these are not member functions.)



Constructors, Assignment and Destructor

int ppl_new_Grid_Generator (ppl_Grid_Generator_t *pg, ppl_const_Linear_Expression_t le, enum ppl_enum_Grid_Generator_Type t, ppl_const_Coefficient_t d)
 Creates a new grid generator of direction le and type t. If the grid generator to be created is a point or a parameter, the divisor d is applied to le. If it is a line, d is simply disregarded. A handle for the new grid generator is written at address pg. The space dimension of the new grid generator is equal to the space dimension of le.
int ppl_new_Grid_Generator_zero_dim_point (ppl_Grid_Generator_t *pg)
 Creates the point that is the origin of the zero-dimensional space $\Rset^0$. Writes a handle for the new grid generator at address pg.
int ppl_new_Grid_Generator_from_Grid_Generator (ppl_Grid_Generator_t *pg, ppl_const_Grid_Generator_t g)
 Builds a grid generator that is a copy of g; writes a handle for the newly created grid generator at address pg.
int ppl_assign_Grid_Generator_from_Grid_Generator (ppl_Grid_Generator_t dst, ppl_const_Grid_Generator_t src)
 Assigns a copy of the grid generator src to dst.
int ppl_delete_Grid_Generator (ppl_const_Grid_Generator_t g)
 Invalidates the handle g: this makes sure the corresponding resources will eventually be released.
Functions that Do Not Modify the Grid Generator

int ppl_Grid_Generator_space_dimension (ppl_const_Grid_Generator_t g, ppl_dimension_type *m)
 Writes to m the space dimension of g.
int ppl_Grid_Generator_type (ppl_const_Grid_Generator_t g)
 Returns the type of grid generator g.
int ppl_Grid_Generator_coefficient (ppl_const_Grid_Generator_t g, ppl_dimension_type var, ppl_Coefficient_t n)
 Copies into n the coefficient of variable var in grid generator g.
int ppl_Grid_Generator_divisor (ppl_const_Grid_Generator_t g, ppl_Coefficient_t n)
 If g is a point or a parameter assigns its divisor to n.
int ppl_Grid_Generator_OK (ppl_const_Grid_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.

Detailed Description

Types and functions for grid generators.

The types and functions for grid generators provide an interface towards Grid_Generator.


Friends And Related Function Documentation

int ppl_assign_Grid_Generator_from_Grid_Generator ( ppl_Grid_Generator_t  dst,
ppl_const_Grid_Generator_t  src 
) [related]

Assigns a copy of the grid generator src to dst.

Definition at line 1609 of file ppl_c_implementation_common.cc.

int ppl_delete_Grid_Generator ( ppl_const_Grid_Generator_t  g  )  [related]

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

Definition at line 1601 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_coefficient ( ppl_const_Grid_Generator_t  g,
ppl_dimension_type  var,
ppl_Coefficient_t  n 
) [related]

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

Definition at line 1642 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_divisor ( ppl_const_Grid_Generator_t  g,
ppl_Coefficient_t  n 
) [related]

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

Definition at line 1653 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_OK ( ppl_const_Grid_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 1663 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_space_dimension ( ppl_const_Grid_Generator_t  g,
ppl_dimension_type m 
) [related]

Writes to m the space dimension of g.

Definition at line 1619 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_type ( ppl_const_Grid_Generator_t  g  )  [related]

Returns the type of grid generator g.

Definition at line 1627 of file ppl_c_implementation_common.cc.

int ppl_new_Grid_Generator ( ppl_Grid_Generator_t *  pg,
ppl_const_Linear_Expression_t  le,
enum ppl_enum_Grid_Generator_Type  t,
ppl_const_Coefficient_t  d 
) [related]

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

Definition at line 1558 of file ppl_c_implementation_common.cc.

int ppl_new_Grid_Generator_from_Grid_Generator ( ppl_Grid_Generator_t *  pg,
ppl_const_Grid_Generator_t  g 
) [related]

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

Definition at line 1592 of file ppl_c_implementation_common.cc.

int ppl_new_Grid_Generator_zero_dim_point ( ppl_Grid_Generator_t *  pg  )  [related]

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

Definition at line 1585 of file ppl_c_implementation_common.cc.


The documentation for this interface was generated from the following file:
Generated on Sun Feb 27 16:22:49 2011 for PPL C Language Interface by  doxygen 1.6.3