gsl-ocaml / lib / ieee.mli

(* gsl-ocaml - OCaml interface to GSL                       *)
(* Copyright (©) 2002-2012 - Olivier Andrieu                *)
(* Distributed under the terms of the GPL version 3         *)

(** IEEE floating-point arithmetic *)

(** {3 Representation of floating point numbers} *)

type ieee_type = | NAN | INF | NORMAL | DENORMAL | ZERO
type float_rep = {
  sign : int;
  mantissa : string;
  exponent : int;
  ieee_type : ieee_type;
} 

external rep_of_float : float -> float_rep
    = "ml_gsl_ieee_double_to_rep"

val print : float -> string

(** {3 IEEE environment} *)

type precision = 
  | SINGLE | DOUBLE | EXTENDED
type rounding = 
  | TO_NEAREST | DOWN | UP | TO_ZERO
type exceptions =
  | MASK_INVALID
  | MASK_DENORMALIZED
  | MASK_DIVISION_BY_ZERO
  | MASK_OVERFLOW
  | MASK_UNDERFLOW
  | MASK_ALL
  | TRAP_INEXACT
external set_mode : ?precision:precision -> ?rounding:rounding -> exceptions list -> unit
  = "ml_gsl_ieee_set_mode"

external env_setup : unit -> unit
    = "ml_gsl_ieee_env_setup"

(** {3 FPU status word} *)

type excepts =
  | FE_INEXACT
  | FE_DIVBYZERO
  | FE_UNDERFLOW
  | FE_OVERFLOW
  | FE_INVALID
  | FE_ALL_EXCEPT
external clear_except : excepts list -> unit = "ml_feclearexcept"
external test_except  : excepts list -> excepts list = "ml_fetestexcept"
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.