ppl_Congruence_tag Interface Reference

Types and functions for congruences. 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_Congruence (ppl_Congruence_t *pc, ppl_const_Linear_Expression_t le, ppl_const_Coefficient_t m)
 Creates the new congruence $le = 0 \pmod{m}$ and writes a handle for it at address pc. The space dimension of the new congruence is equal to the space dimension of le.
int ppl_new_Congruence_zero_dim_false (ppl_Congruence_t *pc)
 Creates the unsatisfiable (zero-dimension space) congruence $0 = 1 \pmod{0}$ and writes a handle for it at address pc.
int ppl_new_Congruence_zero_dim_integrality (ppl_Congruence_t *pc)
 Creates the true (zero-dimension space) congruence $0 = 1 \pmod{1}$, also known as integrality congruence. A handle for the newly created congruence is written at address pc.
int ppl_new_Congruence_from_Congruence (ppl_Congruence_t *pc, ppl_const_Congruence_t c)
 Builds a congruence that is a copy of c; writes a handle for the newly created congruence at address pc.
int ppl_assign_Congruence_from_Congruence (ppl_Congruence_t dst, ppl_const_Congruence_t src)
 Assigns a copy of the congruence src to dst.
int ppl_delete_Congruence (ppl_const_Congruence_t c)
 Invalidates the handle c: this makes sure the corresponding resources will eventually be released.
Functions that Do Not Modify the Congruence

int ppl_Congruence_space_dimension (ppl_const_Congruence_t c, ppl_dimension_type *m)
 Writes to m the space dimension of c.
int ppl_Congruence_coefficient (ppl_const_Congruence_t c, ppl_dimension_type var, ppl_Coefficient_t n)
 Copies into n the coefficient of variable var in congruence c.
int ppl_Congruence_inhomogeneous_term (ppl_const_Congruence_t c, ppl_Coefficient_t n)
 Copies into n the inhomogeneous term of congruence c.
int ppl_Congruence_modulus (ppl_const_Congruence_t c, ppl_Coefficient_t m)
 Copies into m the modulus of congruence c.
int ppl_Congruence_OK (ppl_const_Congruence_t c)
 Returns a positive integer if c is well formed, i.e., if it satisfies all its implementation invariants; returns 0 and perhaps makes some noise if c is broken. Useful for debugging purposes.

Detailed Description

Types and functions for congruences.

The types and functions for congruences provide an interface towards Congruence.


Friends And Related Function Documentation

int ppl_assign_Congruence_from_Congruence ( ppl_Congruence_t  dst,
ppl_const_Congruence_t  src 
) [related]

Assigns a copy of the congruence src to dst.

Definition at line 1311 of file ppl_c_implementation_common.cc.

int ppl_Congruence_coefficient ( ppl_const_Congruence_t  c,
ppl_dimension_type  var,
ppl_Coefficient_t  n 
) [related]

Copies into n the coefficient of variable var in congruence c.

Definition at line 1329 of file ppl_c_implementation_common.cc.

int ppl_Congruence_inhomogeneous_term ( ppl_const_Congruence_t  c,
ppl_Coefficient_t  n 
) [related]

Copies into n the inhomogeneous term of congruence c.

Definition at line 1340 of file ppl_c_implementation_common.cc.

int ppl_Congruence_modulus ( ppl_const_Congruence_t  c,
ppl_Coefficient_t  m 
) [related]

Copies into m the modulus of congruence c.

Definition at line 1350 of file ppl_c_implementation_common.cc.

int ppl_Congruence_OK ( ppl_const_Congruence_t  c  )  [related]

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

Definition at line 1360 of file ppl_c_implementation_common.cc.

int ppl_Congruence_space_dimension ( ppl_const_Congruence_t  c,
ppl_dimension_type m 
) [related]

Writes to m the space dimension of c.

Definition at line 1321 of file ppl_c_implementation_common.cc.

int ppl_delete_Congruence ( ppl_const_Congruence_t  c  )  [related]

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

Definition at line 1304 of file ppl_c_implementation_common.cc.

int ppl_new_Congruence ( ppl_Congruence_t *  pc,
ppl_const_Linear_Expression_t  le,
ppl_const_Coefficient_t  m 
) [related]

Creates the new congruence $le = 0 \pmod{m}$ and writes a handle for it at address pc. The space dimension of the new congruence is equal to the space dimension of le.

Definition at line 1268 of file ppl_c_implementation_common.cc.

int ppl_new_Congruence_from_Congruence ( ppl_Congruence_t *  pc,
ppl_const_Congruence_t  c 
) [related]

Builds a congruence that is a copy of c; writes a handle for the newly created congruence at address pc.

Definition at line 1295 of file ppl_c_implementation_common.cc.

int ppl_new_Congruence_zero_dim_false ( ppl_Congruence_t *  pc  )  [related]

Creates the unsatisfiable (zero-dimension space) congruence $0 = 1 \pmod{0}$ and writes a handle for it at address pc.

Definition at line 1281 of file ppl_c_implementation_common.cc.

int ppl_new_Congruence_zero_dim_integrality ( ppl_Congruence_t *  pc  )  [related]

Creates the true (zero-dimension space) congruence $0 = 1 \pmod{1}$, also known as integrality congruence. A handle for the newly created congruence is written at address pc.

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