ppl_Grid_Generator_System_tag Interface Reference

Types and functions for grid generator systems. More...

#include <ppl_c.h>

List of all members.

Related Functions

(Note that these are not member functions.)



Constructors, Assignment and Destructor

int ppl_new_Grid_Generator_System (ppl_Grid_Generator_System_t *pgs)
 Builds an empty system of grid generators and writes a handle to it at address pgs.
int ppl_new_Grid_Generator_System_from_Grid_Generator (ppl_Grid_Generator_System_t *pgs, ppl_const_Grid_Generator_t g)
 Builds the singleton grid generator system containing only a copy of generator g; writes a handle for the newly created system at address pgs.
int ppl_new_Grid_Generator_System_from_Grid_Generator_System (ppl_Grid_Generator_System_t *pgs, ppl_const_Grid_Generator_System_t gs)
 Builds a grid generator system that is a copy of gs; writes a handle for the newly created system at address pgs.
int ppl_assign_Grid_Generator_System_from_Grid_Generator_System (ppl_Grid_Generator_System_t dst, ppl_const_Grid_Generator_System_t src)
 Assigns a copy of the grid generator system src to dst.
int ppl_delete_Grid_Generator_System (ppl_const_Grid_Generator_System_t gs)
 Invalidates the handle gs: this makes sure the corresponding resources will eventually be released.
Functions that Do Not Modify the Grid Generator System

int ppl_Grid_Generator_System_space_dimension (ppl_const_Grid_Generator_System_t gs, ppl_dimension_type *m)
 Writes to m the dimension of the vector space enclosing gs.
int ppl_Grid_Generator_System_empty (ppl_const_Grid_Generator_System_t gs)
 Returns a positive integer if gs contains no generator; returns 0 otherwise.
int ppl_Grid_Generator_System_begin (ppl_const_Grid_Generator_System_t gs, ppl_Grid_Generator_System_const_iterator_t git)
 Assigns to git a const iterator "pointing" to the beginning of the grid generator system gs.
int ppl_Grid_Generator_System_end (ppl_const_Grid_Generator_System_t gs, ppl_Grid_Generator_System_const_iterator_t git)
 Assigns to git a const iterator "pointing" past the end of the grid generator system gs.
int ppl_Grid_Generator_System_OK (ppl_const_Grid_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 Grid Generator System

int ppl_Grid_Generator_System_clear (ppl_Grid_Generator_System_t gs)
 Removes all the generators from the grid generator system gs and sets its space dimension to 0.
int ppl_Grid_Generator_System_insert_Grid_Generator (ppl_Grid_Generator_System_t gs, ppl_const_Grid_Generator_t g)
 Inserts a copy of the grid generator g into gs; the space dimension is increased, if necessary.

Detailed Description

Types and functions for grid generator systems.

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


Friends And Related Function Documentation

int ppl_assign_Grid_Generator_System_from_Grid_Generator_System ( ppl_Grid_Generator_System_t  dst,
ppl_const_Grid_Generator_System_t  src 
) [related]

Assigns a copy of the grid generator system src to dst.

Definition at line 1724 of file ppl_c_implementation_common.cc.

int ppl_delete_Grid_Generator_System ( ppl_const_Grid_Generator_System_t  gs  )  [related]

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

Definition at line 1716 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_System_begin ( ppl_const_Grid_Generator_System_t  gs,
ppl_Grid_Generator_System_const_iterator_t  git 
) [related]

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

Definition at line 1813 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_System_clear ( ppl_Grid_Generator_System_t  gs  )  [related]

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

Definition at line 1749 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_System_empty ( ppl_const_Grid_Generator_System_t  gs  )  [related]

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

Definition at line 1742 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_System_end ( ppl_const_Grid_Generator_System_t  gs,
ppl_Grid_Generator_System_const_iterator_t  git 
) [related]

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

Definition at line 1824 of file ppl_c_implementation_common.cc.

int ppl_Grid_Generator_System_insert_Grid_Generator ( ppl_Grid_Generator_System_t  gs,
ppl_const_Grid_Generator_t  g 
) [related]

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

Definition at line 1757 of file ppl_c_implementation_common.cc.

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

int ppl_Grid_Generator_System_space_dimension ( ppl_const_Grid_Generator_System_t  gs,
ppl_dimension_type m 
) [related]

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

Definition at line 1733 of file ppl_c_implementation_common.cc.

int ppl_new_Grid_Generator_System ( ppl_Grid_Generator_System_t *  pgs  )  [related]

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

Definition at line 1682 of file ppl_c_implementation_common.cc.

int ppl_new_Grid_Generator_System_from_Grid_Generator ( ppl_Grid_Generator_System_t *  pgs,
ppl_const_Grid_Generator_t  g 
) [related]

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

Definition at line 1699 of file ppl_c_implementation_common.cc.

int ppl_new_Grid_Generator_System_from_Grid_Generator_System ( ppl_Grid_Generator_System_t *  pgs,
ppl_const_Grid_Generator_System_t  gs 
) [related]

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

Definition at line 1708 of file ppl_c_implementation_common.cc.


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