ppl_Coefficient_tag Interface Reference

Types and functions for coefficients. 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_Coefficient (ppl_Coefficient_t *pc)
 Creates a new coefficient with value 0 and writes a handle for the newly created coefficient at address pc.
int ppl_new_Coefficient_from_mpz_t (ppl_Coefficient_t *pc, mpz_t z)
 Creates a new coefficient with the value given by the GMP integer z and writes a handle for the newly created coefficient at address pc.
int ppl_new_Coefficient_from_Coefficient (ppl_Coefficient_t *pc, ppl_const_Coefficient_t c)
 Builds a coefficient that is a copy of c; writes a handle for the newly created coefficient at address pc.
int ppl_assign_Coefficient_from_mpz_t (ppl_Coefficient_t dst, mpz_t z)
 Assign to dst the value given by the GMP integer z.
int ppl_assign_Coefficient_from_Coefficient (ppl_Coefficient_t dst, ppl_const_Coefficient_t src)
 Assigns a copy of the coefficient src to dst.
int ppl_delete_Coefficient (ppl_const_Coefficient_t c)
 Invalidates the handle c: this makes sure the corresponding resources will eventually be released.
Read-Only Accessor Functions

int ppl_Coefficient_to_mpz_t (ppl_const_Coefficient_t c, mpz_t z)
 Sets the value of the GMP integer z to the value of c.
int ppl_Coefficient_OK (ppl_const_Coefficient_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.
int ppl_Coefficient_is_bounded (void)
 Returns a positive integer if coefficients are bounded; returns 0 otherwise.
int ppl_Coefficient_min (mpz_t min)
 Returns a positive integer if coefficients are bounded, in which case min is set to their minimum value; returns 0 otherwise.
int ppl_Coefficient_max (mpz_t max)
 Returns a positive integer if coefficients are bounded, in which case max is set to their maximum value; returns 0 otherwise.

Detailed Description

Types and functions for coefficients.

The types and functions for coefficients provide an interface towards Coefficient. Depending on configuration, the PPL coefficients may be implemented by the unbounded precision integers provided by GMP (default), or by bounded precision integers (with checks for overflows).


Friends And Related Function Documentation

int ppl_assign_Coefficient_from_Coefficient ( ppl_Coefficient_t  dst,
ppl_const_Coefficient_t  src 
) [related]

Assigns a copy of the coefficient src to dst.

Definition at line 442 of file ppl_c_implementation_common.cc.

int ppl_assign_Coefficient_from_mpz_t ( ppl_Coefficient_t  dst,
mpz_t  z 
) [related]

Assign to dst the value given by the GMP integer z.

Definition at line 434 of file ppl_c_implementation_common.cc.

int ppl_Coefficient_is_bounded ( void   )  [related]

Returns a positive integer if coefficients are bounded; returns 0 otherwise.

Definition at line 458 of file ppl_c_implementation_common.cc.

int ppl_Coefficient_max ( mpz_t  max  )  [related]

Returns a positive integer if coefficients are bounded, in which case max is set to their maximum value; returns 0 otherwise.

Definition at line 477 of file ppl_c_implementation_common.cc.

int ppl_Coefficient_min ( mpz_t  min  )  [related]

Returns a positive integer if coefficients are bounded, in which case min is set to their minimum value; returns 0 otherwise.

Definition at line 464 of file ppl_c_implementation_common.cc.

int ppl_Coefficient_OK ( ppl_const_Coefficient_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 452 of file ppl_c_implementation_common.cc.

int ppl_Coefficient_to_mpz_t ( ppl_const_Coefficient_t  c,
mpz_t  z 
) [related]

Sets the value of the GMP integer z to the value of c.

Definition at line 420 of file ppl_c_implementation_common.cc.

int ppl_delete_Coefficient ( ppl_const_Coefficient_t  c  )  [related]

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

Definition at line 427 of file ppl_c_implementation_common.cc.

int ppl_new_Coefficient ( ppl_Coefficient_t *  pc  )  [related]

Creates a new coefficient with value 0 and writes a handle for the newly created coefficient at address pc.

Definition at line 397 of file ppl_c_implementation_common.cc.

int ppl_new_Coefficient_from_Coefficient ( ppl_Coefficient_t *  pc,
ppl_const_Coefficient_t  c 
) [related]

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

Definition at line 411 of file ppl_c_implementation_common.cc.

int ppl_new_Coefficient_from_mpz_t ( ppl_Coefficient_t *  pc,
mpz_t  z 
) [related]

Creates a new coefficient with the value given by the GMP integer z and writes a handle for the newly created coefficient at address pc.

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