ppl_Generator_System_tag Interface Reference

Types and functions for generator systems. 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_Generator_System (ppl_Generator_System_t *pgs)
 Builds an empty system of generators and writes a handle to it at address pgs.
int ppl_new_Generator_System_from_Generator (ppl_Generator_System_t *pgs, ppl_const_Generator_t g)
 Builds the singleton generator system containing only a copy of generator g; writes a handle for the newly created system at address pgs.
int ppl_new_Generator_System_from_Generator_System (ppl_Generator_System_t *pgs, ppl_const_Generator_System_t gs)
 Builds a generator system that is a copy of gs; writes a handle for the newly created system at address pgs.
int ppl_assign_Generator_System_from_Generator_System (ppl_Generator_System_t dst, ppl_const_Generator_System_t src)
 Assigns a copy of the generator system src to dst.
int ppl_delete_Generator_System (ppl_const_Generator_System_t gs)
 Invalidates the handle gs: this makes sure the corresponding resources will eventually be released.
Functions that Do Not Modify the Generator System

int ppl_Generator_System_space_dimension (ppl_const_Generator_System_t gs, ppl_dimension_type *m)
 Writes to m the dimension of the vector space enclosing gs.
int ppl_Generator_System_empty (ppl_const_Generator_System_t gs)
 Returns a positive integer if gs contains no generators; returns 0 otherwise.
int ppl_Generator_System_begin (ppl_const_Generator_System_t gs, ppl_Generator_System_const_iterator_t git)
 Assigns to git a const iterator "pointing" to the beginning of the generator system gs.
int ppl_Generator_System_end (ppl_const_Generator_System_t gs, ppl_Generator_System_const_iterator_t git)
 Assigns to git a const iterator "pointing" past the end of the generator system gs.
int ppl_Generator_System_OK (ppl_const_Generator_System_t gs)
 Returns a positive integer if gs is well formed, i.e., if it satisfies all its implementation invariants; returns 0 and perhaps makes some noise if gs is broken. Useful for debugging purposes.
Functions that May Modify the Generator System

int ppl_Generator_System_clear (ppl_Generator_System_t gs)
 Removes all the generators from the generator system gs and sets its space dimension to 0.
int ppl_Generator_System_insert_Generator (ppl_Generator_System_t gs, ppl_const_Generator_t g)
 Inserts a copy of the generator g into gs; the space dimension is increased, if necessary.

Detailed Description

Types and functions for generator systems.

The types and functions for generator systems provide an interface towards Generator_System.


Friends And Related Function Documentation

int ppl_assign_Generator_System_from_Generator_System ( ppl_Generator_System_t  dst,
ppl_const_Generator_System_t  src 
) [related]

Assigns a copy of the generator system src to dst.

Definition at line 1130 of file ppl_c_implementation_common.cc.

int ppl_delete_Generator_System ( ppl_const_Generator_System_t  gs  )  [related]

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

Definition at line 1122 of file ppl_c_implementation_common.cc.

int ppl_Generator_System_begin ( ppl_const_Generator_System_t  gs,
ppl_Generator_System_const_iterator_t  git 
) [related]

Assigns to git a const iterator "pointing" to the beginning of the generator system gs.

Definition at line 1216 of file ppl_c_implementation_common.cc.

int ppl_Generator_System_clear ( ppl_Generator_System_t  gs  )  [related]

Removes all the generators from the generator system gs and sets its space dimension to 0.

Definition at line 1155 of file ppl_c_implementation_common.cc.

int ppl_Generator_System_empty ( ppl_const_Generator_System_t  gs  )  [related]

Returns a positive integer if gs contains no generators; returns 0 otherwise.

Definition at line 1148 of file ppl_c_implementation_common.cc.

int ppl_Generator_System_end ( ppl_const_Generator_System_t  gs,
ppl_Generator_System_const_iterator_t  git 
) [related]

Assigns to git a const iterator "pointing" past the end of the generator system gs.

Definition at line 1226 of file ppl_c_implementation_common.cc.

int ppl_Generator_System_insert_Generator ( ppl_Generator_System_t  gs,
ppl_const_Generator_t  g 
) [related]

Inserts a copy of the generator g into gs; the space dimension is increased, if necessary.

Definition at line 1162 of file ppl_c_implementation_common.cc.

int ppl_Generator_System_OK ( ppl_const_Generator_System_t  gs  )  [related]

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

Definition at line 1172 of file ppl_c_implementation_common.cc.

int ppl_Generator_System_space_dimension ( ppl_const_Generator_System_t  gs,
ppl_dimension_type m 
) [related]

Writes to m the dimension of the vector space enclosing gs.

Definition at line 1139 of file ppl_c_implementation_common.cc.

int ppl_new_Generator_System ( ppl_Generator_System_t *  pgs  )  [related]

Builds an empty system of generators and writes a handle to it at address pgs.

Definition at line 1090 of file ppl_c_implementation_common.cc.

int ppl_new_Generator_System_from_Generator ( ppl_Generator_System_t *  pgs,
ppl_const_Generator_t  g 
) [related]

Builds the singleton generator system containing only a copy of generator g; writes a handle for the newly created system at address pgs.

Definition at line 1104 of file ppl_c_implementation_common.cc.

int ppl_new_Generator_System_from_Generator_System ( ppl_Generator_System_t *  pgs,
ppl_const_Generator_System_t  gs 
) [related]

Builds a generator system that is a copy of gs; writes a handle for the newly created system at address pgs.

Definition at line 1114 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