PPL C Language Interface: ppl_Coefficient_tag Interface Reference

PPL C Language Interface 1.2

- Main Page
- Related Pages
- Modules
- Classes

- Class List
- Class Members

List of all members
ppl_Coefficient_tag Interface Reference

Types and functions for coefficients. More...

`#include <ppl_c_header.h>`

## 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.
I/O Functions
int | ppl_io_print_Coefficient (ppl_const_Coefficient_t x)
| Prints `x` to `stdout`.
int | ppl_io_fprint_Coefficient (FILE *stream, ppl_const_Coefficient_t x)
| Prints `x` to the given output `stream`.
int | ppl_io_asprint_Coefficient (char **strp, ppl_const_Coefficient_t x)
| Prints `x` to a malloc-allocated string, a pointer to which is returned via `strp`.

## 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).

The documentation for this interface was generated from the following file:

- ppl_c_header.h