package lp

  1. Overview
  2. Docs

Module LpSource

top module of package Lp

Sourcemodule Var : sig ... end
Sourcemodule Term : sig ... end
Sourcemodule Poly : sig ... end

Module for polynomial expression type

Sourcemodule Cnstr : sig ... end
Sourcemodule Obj : sig ... end
Sourcemodule Problem : sig ... end
Sourceval c : float -> Poly.t

Make monomial of a constant value

Sourceval var : ?integer:bool -> ?lb:float -> ?ub:float -> string -> Poly.t

Make monomial of a variable

Sourceval binary : string -> Poly.t

Make monomial of a binary variable

Sourceval range : ?integer:bool -> ?lb:float -> ?ub:float -> string -> int -> Poly.t array

Make array of monomials of a variable

Sourceval (~-) : Poly.t -> Poly.t

Negate the whole polynomial

Sourceval (+) : Poly.t -> Poly.t -> Poly.t

Add (concatenate) two polynomials

Sourceval (-) : Poly.t -> Poly.t -> Poly.t

Subtract two polynomials (concatenate left with negated right )

Sourceval expand : Poly.t -> Poly.t -> Poly.t

Multiply two polynomials. specifically, performs polynomial expansion.

Sourceval (*) : Poly.t -> Poly.t -> Poly.t

Multiply two polynomials. specifically, performs polynomial expansion.

Sourceval dot : Poly.t -> Poly.t -> Poly.t

Regard two polynomials as vectors and take dot product.

Sourceval (*@) : Poly.t -> Poly.t -> Poly.t

Regard two polynomials as vectors and take dot product.

Sourceval div : Poly.t -> Poly.t -> Poly.t

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

    Sourceval (/) : Poly.t -> Poly.t -> Poly.t

    Equivalent to div

    Sourceval (=$) : Poly.t -> Poly.t -> Lp__.Constraint.t

    Build an equality constraint. Polynomials are simplified on build.

    Sourceval (<$) : Poly.t -> Poly.t -> Lp__.Constraint.t

    Build an inequality constraint. Polynomials are simplified on build.

    Sourceval (>$) : Poly.t -> Poly.t -> Lp__.Constraint.t

    Build an inequality constraint. Polynomials are simplified on build.

    Sourceval maximize : Poly.t -> Lp__.Objective.t

    Build an objective to maximize a polynomial. The polynomial is simplified on build.

    Sourceval minimize : Poly.t -> Lp__.Objective.t

    Build an objective to minimize a polynomial. The polynomial is simplified on build.

    Sourceval validate : Problem.t -> bool

    Validate the problem

    Sourceval to_string : ?short:bool -> Problem.t -> string

    Express the problem in LP file format string

    Sourceval of_string : string -> Problem.t

    Parse an LP file format string to build the problem

    Sourceval write : ?short:bool -> string -> Problem.t -> unit

    write fname problem writes out problem to an LP file fname

    Sourceval read : string -> Problem.t

    Parse an LP file to build the problem