ppl_Constraint_tag Interface Reference

Types and functions for constraints. 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_Constraint (ppl_Constraint_t *pc, ppl_const_Linear_Expression_t le, enum ppl_enum_Constraint_Type rel)
 Creates the new constraint `le rel 0' and writes a handle for it at address pc. The space dimension of the new constraint is equal to the space dimension of le.
int ppl_new_Constraint_zero_dim_false (ppl_Constraint_t *pc)
 Creates the unsatisfiable (zero-dimension space) constraint $0 = 1$ and writes a handle for it at address pc.
int ppl_new_Constraint_zero_dim_positivity (ppl_Constraint_t *pc)
 Creates the true (zero-dimension space) constraint $0 \leq 1$, also known as positivity constraint. A handle for the newly created constraint is written at address pc.
int ppl_new_Constraint_from_Constraint (ppl_Constraint_t *pc, ppl_const_Constraint_t c)
 Builds a constraint that is a copy of c; writes a handle for the newly created constraint at address pc.
int ppl_assign_Constraint_from_Constraint (ppl_Constraint_t dst, ppl_const_Constraint_t src)
 Assigns a copy of the constraint src to dst.
int ppl_delete_Constraint (ppl_const_Constraint_t c)
 Invalidates the handle c: this makes sure the corresponding resources will eventually be released.
Functions that Do Not Modify the Constraint

int ppl_Constraint_space_dimension (ppl_const_Constraint_t c, ppl_dimension_type *m)
 Writes to m the space dimension of c.
int ppl_Constraint_type (ppl_const_Constraint_t c)
 Returns the type of constraint c.
int ppl_Constraint_coefficient (ppl_const_Constraint_t c, ppl_dimension_type var, ppl_Coefficient_t n)
 Copies into n the coefficient of variable var in constraint c.
int ppl_Constraint_inhomogeneous_term (ppl_const_Constraint_t c, ppl_Coefficient_t n)
 Copies into n the inhomogeneous term of constraint c.
int ppl_Constraint_OK (ppl_const_Constraint_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 constraints.

The types and functions for constraints provide an interface towards Constraint.


Friends And Related Function Documentation

int ppl_assign_Constraint_from_Constraint ( ppl_Constraint_t  dst,
ppl_const_Constraint_t  src 
) [related]

Assigns a copy of the constraint src to dst.

Definition at line 697 of file ppl_c_implementation_common.cc.

int ppl_Constraint_coefficient ( ppl_const_Constraint_t  c,
ppl_dimension_type  var,
ppl_Coefficient_t  n 
) [related]

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

Definition at line 730 of file ppl_c_implementation_common.cc.

int ppl_Constraint_inhomogeneous_term ( ppl_const_Constraint_t  c,
ppl_Coefficient_t  n 
) [related]

Copies into n the inhomogeneous term of constraint c.

Definition at line 741 of file ppl_c_implementation_common.cc.

int ppl_Constraint_OK ( ppl_const_Constraint_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 751 of file ppl_c_implementation_common.cc.

int ppl_Constraint_space_dimension ( ppl_const_Constraint_t  c,
ppl_dimension_type m 
) [related]

Writes to m the space dimension of c.

Definition at line 707 of file ppl_c_implementation_common.cc.

int ppl_Constraint_type ( ppl_const_Constraint_t  c  )  [related]

Returns the type of constraint c.

Definition at line 715 of file ppl_c_implementation_common.cc.

int ppl_delete_Constraint ( ppl_const_Constraint_t  c  )  [related]

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

Definition at line 690 of file ppl_c_implementation_common.cc.

int ppl_new_Constraint ( ppl_Constraint_t *  pc,
ppl_const_Linear_Expression_t  le,
enum ppl_enum_Constraint_Type  rel 
) [related]

Creates the new constraint `le rel 0' and writes a handle for it at address pc. The space dimension of the new constraint is equal to the space dimension of le.

Definition at line 636 of file ppl_c_implementation_common.cc.

int ppl_new_Constraint_from_Constraint ( ppl_Constraint_t *  pc,
ppl_const_Constraint_t  c 
) [related]

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

Definition at line 681 of file ppl_c_implementation_common.cc.

int ppl_new_Constraint_zero_dim_false ( ppl_Constraint_t *  pc  )  [related]

Creates the unsatisfiable (zero-dimension space) constraint $0 = 1$ and writes a handle for it at address pc.

Definition at line 667 of file ppl_c_implementation_common.cc.

int ppl_new_Constraint_zero_dim_positivity ( ppl_Constraint_t *  pc  )  [related]

Creates the true (zero-dimension space) constraint $0 \leq 1$, also known as positivity constraint. A handle for the newly created constraint is written at address pc.

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