package ocplib-simplex

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Type
Constructors
Algebraic operations
Comparison functions
Misc

ocplib-simplex
- OcplibSimplex
  - AssertBounds
    
    Make
    
    Core
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
    
    S
    
    Core
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
  - Basic
    
    Make
    
    Assert
    
    Core
    
    MX
    
    P
    
    R2
    
    SX
    
    Ex
    
    R
    
    Result
    
    Solve
    
    Var
  - Core
    
    Make
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
  - CoreSig
    
    S
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
  - ExtSigs
    
    Explanations
    
    Rationals
    
    Variables
  - Polys
    
    Make
    
    R
    
    Var
    
    SIG
    
    R
    
    Var
  - Rat2
    
    Make
    
    R
    
    SIG
    
    R
  - Result
    
    Make
    
    Core
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
    
    S
    
    Core
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
  - SolveBounds
    
    Make
    
    Core
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
    
    S
    
    Core
    
    Ex
    
    MX
    
    P
    
    R
    
    R2
    
    SX
    
    Var
  - Version

Legend:
Library
Module
Module type
Parameter
Class
Class type

module R : ExtSigs.Rationals

Type

type t = private {

v : R.t;
(*
The raw value of the bound.
*)
offset : R.t;
(*
The number of epsilons to add to the bound.
*)

}

Constructors

val zero : t

The zero bound with no offset.

val of_r : R.t -> t

From a rational r, returns the Rat2 representation with no offset.

val upper : R.t -> t

From a rational r, returns r - Ɛ.

val lower : R.t -> t

From a rational r, returns r + Ɛ.

Algebraic operations

val minus : t -> t

From a bound r + kƐ, returns -r -kƐ.

val add : t -> t -> t

Adds two bounds.

val sub : t -> t -> t

Substracts two bounds.

val mult : t -> t -> t

Multiplies two bounds.

val mult_by_const : R.t -> t -> t

Multiplies a bound by a rational constant (both v and offset are multiplied).

val div_by_const : R.t -> t -> t

Divides a bound by a constant. Fails if the constant is zero.

Comparison functions

val compare : t -> t -> int

Compares two bounds; returns 0 iff the two bounds are strictly equal.

val equal : t -> t -> bool

Returns true iff the bounds are strictly equal.

val is_zero : t -> bool

Returns true iff the bound in argument is zero.

val is_pure_rational : t -> bool

Returns true iff the offset is 0.

val is_int : t -> bool

Returns true iff the offset is 0 and the field v is an integer.

Misc

val floor : t -> t

Returns the greatest (pure) integer smaller or equal to the argument.

val ceiling : t -> t

Returns the smallest (pure) integer greater or equal to the argument.

val print : Format.formatter -> t -> unit

Prints a bound.