summaryrefslogtreecommitdiff
path: root/ocaml-binary-annot/otherlibs/num/arith_status.mli
diff options
context:
space:
mode:
Diffstat (limited to 'ocaml-binary-annot/otherlibs/num/arith_status.mli')
-rw-r--r--ocaml-binary-annot/otherlibs/num/arith_status.mli59
1 files changed, 59 insertions, 0 deletions
diff --git a/ocaml-binary-annot/otherlibs/num/arith_status.mli b/ocaml-binary-annot/otherlibs/num/arith_status.mli
new file mode 100644
index 0000000000..121b4d5756
--- /dev/null
+++ b/ocaml-binary-annot/otherlibs/num/arith_status.mli
@@ -0,0 +1,59 @@
+(***********************************************************************)
+(* *)
+(* Objective Caml *)
+(* *)
+(* Valerie Menissier-Morain, projet Cristal, INRIA Rocquencourt *)
+(* *)
+(* Copyright 1996 Institut National de Recherche en Informatique et *)
+(* en Automatique. All rights reserved. This file is distributed *)
+(* under the terms of the GNU Library General Public License, with *)
+(* the special exception on linking described in file ../../LICENSE. *)
+(* *)
+(***********************************************************************)
+
+(* $Id$ *)
+
+(** Flags that control rational arithmetic. *)
+
+val arith_status: unit -> unit
+ (** Print the current status of the arithmetic flags. *)
+
+val get_error_when_null_denominator : unit -> bool
+ (** See {!Arith_status.set_error_when_null_denominator}.*)
+val set_error_when_null_denominator : bool -> unit
+ (** Get or set the flag [null_denominator]. When on, attempting to
+ create a rational with a null denominator raises an exception.
+ When off, rationals with null denominators are accepted.
+ Initially: on. *)
+
+val get_normalize_ratio : unit -> bool
+ (** See {!Arith_status.set_normalize_ratio}.*)
+val set_normalize_ratio : bool -> unit
+ (** Get or set the flag [normalize_ratio]. When on, rational
+ numbers are normalized after each operation. When off,
+ rational numbers are not normalized until printed.
+ Initially: off. *)
+
+val get_normalize_ratio_when_printing : unit -> bool
+ (** See {!Arith_status.set_normalize_ratio_when_printing}.*)
+val set_normalize_ratio_when_printing : bool -> unit
+ (** Get or set the flag [normalize_ratio_when_printing].
+ When on, rational numbers are normalized before being printed.
+ When off, rational numbers are printed as is, without normalization.
+ Initially: on. *)
+
+val get_approx_printing : unit -> bool
+ (** See {!Arith_status.set_approx_printing}.*)
+val set_approx_printing : bool -> unit
+ (** Get or set the flag [approx_printing].
+ When on, rational numbers are printed as a decimal approximation.
+ When off, rational numbers are printed as a fraction.
+ Initially: off. *)
+
+val get_floating_precision : unit -> int
+ (** See {!Arith_status.set_floating_precision}.*)
+val set_floating_precision : int -> unit
+ (** Get or set the parameter [floating_precision].
+ This parameter is the number of digits displayed when
+ [approx_printing] is on.
+ Initially: 12. *)