lp 0.0.2 · OCaml Package

Module for polynomial expression type

type t = Term.t list

Type for the polynomial with order up to two (quadratic). Internal representation (Term.t list) is intentionally exposed for now.

type classified = {

quad : t;
linear : t;
const : t;

}

Type for the polynomial classified by orders

val c : float -> t

Make monomial of a constant value

val var : ?integer:bool -> ?lb:float -> ?ub:float -> string -> t

Make monomial of a variable

val binary : string -> t

Make monomial of a binary variable

val range : ?integer:bool -> ?lb:float -> ?ub:float -> string -> int -> t array

Make array of monomials of a variable

val zero : t

Constant zero

val sort : t -> t

Sort terms in the polynomial

val to_string : ?short:bool -> t -> string

Get string expression of the polynomial

val partition : t -> t * t

Partition terms into pair ( quad or linear, const )

val classify : t -> classified

Classify terms into three categories quad, linear, const

val collision : t -> bool

Check if any variable collision exist in the polynomial

val simplify : ?epsilon:float -> t -> t

Simplify the polynomial. The polynomial is sorted and terms with same variables are accumulated. After that, near-zero terms are dropped. epsilon specifies the threshold of near-zero, defaulting to 10. *. epsilon_float.

val degree : t -> int

Get the degree of polynomial

val take_vars : t -> Var.t list

List up all the variables in the polynomial

val neg : t -> t

Negate the whole polynomial

val (~-) : t -> t

Negate the whole polynomial

val (+) : t -> t -> t

Add (concatenate) two polynomials

val (-) : t -> t -> t

Subtract two polynomials (concatenate left with negated right )

val expand : t -> t -> t

Multiply two polynomials. specifically, performs polynomial expansion.

val (*) : t -> t -> t

Multiply two polynomials. specifically, performs polynomial expansion.

val dot : t -> t -> t

Regard two polynomials as vectors and take dot product.

val (*@) : t -> t -> t

Regard two polynomials as vectors and take dot product.

val equiv : t -> t -> bool

Check if two polynomials are equivalent

val divt : t -> Term.t -> t

Divide polynomial by a term.

val div : t -> t -> t

Divide polynomial by a univariate polynomial. Be careful as this function raises exception in following cases.

val (/) : t -> t -> t

equivalent to div

val trans_bound : string -> float -> float -> t -> t

trans_bound name lb ub transforms the bounds of the variable name with lb and ub

val to_integer : string -> t -> t

to_integer name transforms the variable name into general integer variable

val to_binary : string -> t -> t

to_integer name transforms the variable name into binary variable

package lp