add isl_set_from_point
[platform/upstream/isl.git] / doc / user.pod
index 10d7af4..3f9129d 100644 (file)
@@ -96,7 +96,7 @@ C<piplib> functionality is currently used by default.
 The C<--with-piplib> option can
 be used to specify which C<piplib>
 library to use, either an installed version (C<system>),
-an externally built version (C<build>), a bundled version (C<bundled>)
+an externally built version (C<build>)
 or no version (C<no>).  The option C<build> is mostly useful
 in C<configure> scripts of larger projects that bundle both C<isl>
 and C<piplib>.
@@ -117,9 +117,7 @@ Installation prefix for C<GMP> (architecture-dependent files).
 
 =item C<--with-piplib>
 
-Which copy of C<piplib> to use, either C<no> (default), C<system>, C<build>
-or C<bundled>.  Note that C<bundled> only works if you have obtained
-C<isl> and its submodules from the git repository.
+Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
 
 =item C<--with-piplib-prefix>
 
@@ -1072,7 +1070,12 @@ Points can be copied or freed using
                __isl_keep isl_point *pnt);
        void isl_point_free(__isl_take isl_point *pnt);
 
-A box can be created from two opposite extremal points using
+A singleton set can be created from a point using
+
+       __isl_give isl_set *isl_set_from_point(
+               __isl_take isl_point *pnt);
+
+and a box can be created from two opposite extremal points using
 
        __isl_give isl_set *isl_set_box_from_points(
                __isl_take isl_point *pnt1,
@@ -1105,6 +1108,173 @@ tested using
 
        int isl_point_is_void(__isl_keep isl_point *pnt);
 
+=head2 Piecewise Quasipolynomials
+
+A piecewise quasipolynomial is a particular kind of function that maps
+a parametric point to a rational value.
+More specifically, a quasipolynomial is a polynomial expression in greatest
+integer parts of affine expressions of parameters and variables.
+A piecewise quasipolynomial is a subdivision of a given parametric
+domain into disjoint cells with a quasipolynomial associated to
+each cell.  The value of the piecewise quasipolynomial at a given
+point is the value of the quasipolynomial associated to the cell
+that contains the point.  Outside of the union of cells,
+the value is assumed to be zero.
+For example, the piecewise quasipolynomial
+
+       [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
+
+maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
+Piecewise quasipolynomials are mainly used by the C<barvinok>
+library for representing the number of elements in a parametric set or map.
+For example, the piecewise quasipolynomial above represents
+the number of point in the map
+
+       [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
+
+=head3 Printing (Piecewise) Quasipolynomials
+
+Quasipolynomials and piecewise quasipolynomials can be printed
+using the following functions.
+
+       void isl_qpolynomial_print(__isl_keep isl_qpolynomial *qp,
+               FILE *out, unsigned output_format);
+
+       void isl_pw_qpolynomial_print(
+               __isl_keep isl_pw_qpolynomial *pwqp, FILE *out,
+               unsigned output_format);
+
+=head3 Creating New (Piecewise) Quasipolynomials
+
+Some simple quasipolynomials can be created using the following functions.
+More complicated quasipolynomials can be created by applying
+operations such as addition and multiplication
+on the resulting quasipolynomials
+
+       __isl_give isl_qpolynomial *isl_qpolynomial_zero(
+               __isl_take isl_dim *dim);
+       __isl_give isl_qpolynomial *isl_qpolynomial_infty(
+               __isl_take isl_dim *dim);
+       __isl_give isl_qpolynomial *isl_qpolynomial_nan(
+               __isl_take isl_dim *dim);
+       __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst(
+               __isl_take isl_dim *dim,
+               const isl_int n, const isl_int d);
+       __isl_give isl_qpolynomial *isl_qpolynomial_div(
+               __isl_take isl_div *div);
+       __isl_give isl_qpolynomial *isl_qpolynomial_var(
+               __isl_take isl_dim *dim,
+               enum isl_dim_type type, unsigned pos);
+
+The zero piecewise quasipolynomial or a piecewise quasipolynomial
+with a single cell can be created using the following functions.
+Multiple of these single cell piecewise quasipolynomials can
+be combined to create more complicated piecewise quasipolynomials.
+
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
+               __isl_take isl_dim *dim);
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
+               __isl_take isl_set *set,
+               __isl_take isl_qpolynomial *qp);
+
+Quasipolynomials can be copied and freed again using the following
+functions.
+
+       __isl_give isl_qpolynomial *isl_qpolynomial_copy(
+               __isl_keep isl_qpolynomial *qp);
+       void isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
+
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
+               __isl_keep isl_pw_qpolynomial *pwqp);
+       void isl_pw_qpolynomial_free(
+               __isl_take isl_pw_qpolynomial *pwqp);
+
+=head3 Inspecting (Piecewise) Quasipolynomials
+
+To iterate over the cells in a piecewise quasipolynomial,
+use the following function
+
+       int isl_pw_qpolynomial_foreach_piece(
+               __isl_keep isl_pw_qpolynomial *pwqp,
+               int (*fn)(__isl_take isl_set *set,
+                         __isl_take isl_qpolynomial *qp,
+                         void *user), void *user);
+
+As usual, the function C<fn> should return C<0> on success
+and C<-1> on failure.
+
+To iterate over all terms in a quasipolynomial,
+use
+
+       int isl_qpolynomial_foreach_term(
+               __isl_keep isl_qpolynomial *qp,
+               int (*fn)(__isl_take isl_term *term,
+                         void *user), void *user);
+
+The terms themselves can be inspected and freed using
+these functions
+
+       unsigned isl_term_dim(__isl_keep isl_term *term,
+               enum isl_dim_type type);
+       void isl_term_get_num(__isl_keep isl_term *term,
+               isl_int *n);
+       void isl_term_get_den(__isl_keep isl_term *term,
+               isl_int *d);
+       int isl_term_get_exp(__isl_keep isl_term *term,
+               enum isl_dim_type type, unsigned pos);
+       __isl_give isl_div *isl_term_get_div(
+               __isl_keep isl_term *term, unsigned pos);
+       void isl_term_free(__isl_take isl_term *term);
+
+Each term is a product of parameters, set variables and
+integer divisions.  The function C<isl_term_get_exp>
+returns the exponent of a given dimensions in the given term.
+The C<isl_int>s in the arguments of C<isl_term_get_num>
+and C<isl_term_get_den> need to have been initialized
+using C<isl_int_init> before calling these functions.
+
+=head3 Properties of (Piecewise) Quasipolynomials
+
+To check whether a quasipolynomial is actually a constant,
+use the following function.
+
+       int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
+               isl_int *n, isl_int *d);
+
+If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
+then the numerator and denominator of the constant
+are returned in C<*n> and C<*d>, respectively.
+
+=head3 Operations on (Piecewise) Quasipolynomials
+
+       __isl_give isl_qpolynomial *isl_qpolynomial_neg(
+               __isl_take isl_qpolynomial *qp);
+       __isl_give isl_qpolynomial *isl_qpolynomial_add(
+               __isl_take isl_qpolynomial *qp1,
+               __isl_take isl_qpolynomial *qp2);
+       __isl_give isl_qpolynomial *isl_qpolynomial_mul(
+               __isl_take isl_qpolynomial *qp1,
+               __isl_take isl_qpolynomial *qp2);
+
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
+               __isl_take isl_pw_qpolynomial *pwqp1,
+               __isl_take isl_pw_qpolynomial *pwqp2);
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
+               __isl_take isl_pw_qpolynomial *pwqp1,
+               __isl_take isl_pw_qpolynomial *pwqp2);
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
+               __isl_take isl_pw_qpolynomial *pwqp1,
+               __isl_take isl_pw_qpolynomial *pwqp2);
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
+               __isl_take isl_pw_qpolynomial *pwqp);
+       __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
+               __isl_take isl_pw_qpolynomial *pwqp1,
+               __isl_take isl_pw_qpolynomial *pwqp2);
+
+       __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
+               __isl_take isl_pw_qpolynomial *pwqp,
+               __isl_take isl_point *pnt);
+
 =head2 Dependence Analysis
 
 C<isl> contains specialized functionality for performing
@@ -1190,7 +1360,7 @@ C<isl_flow_free> to free all associated memory.
 Although C<isl> is mainly meant to be used as a library,
 it also contains some basic applications that use some
 of the functionality of C<isl>.
-The input may specified either in the L<isl format>
+The input may be specified in either the L<isl format>
 or the L<PolyLib format>.
 
 =head2 C<isl_polyhedron_sample>