package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

v3.9.0.tar.gz
md5=ea26b5c72e6731e59d856626049cca4d
sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb

doc/batteries.unthreaded/BatNum/index.html

Module BatNumSource

Operation on arbitrary-precision numbers.

Numbers (type num) are arbitrary-precision rational numbers, plus the special elements 1/0 (infinity) and 0/0 (undefined).

  • author Valerie Menissier-Morain (base module)
  • author Gabriel Scherer
  • author David Teller

@documents Num

type num = Num.num =
  1. | Int of int
  2. | Big_int of Big_int.big_int
  3. | Ratio of Ratio.ratio

The type of numbers.

Sourcetype t = num
Sourceval zero : num

Usual operations

Sourceval one : num
Sourceval neg : num -> num
Sourceval abs : num -> num
Sourceval add : num -> num -> num
Sourceval sub : num -> num -> num
Sourceval mul : num -> num -> num
Sourceval div : num -> num -> num
Sourceval modulo : num -> num -> num
Sourceval pow : num -> num -> num
Sourceval compare : num -> num -> int
Sourceval ord : num -> num -> BatOrd.order
Sourceval equal : num -> num -> bool
Sourceval of_int : int -> num
Sourceval to_int : num -> int
Sourceval of_float : float -> num
Sourceval to_float : num -> float
Sourceval of_string : string -> num
Sourceval to_string : num -> string

Convert a number to a string, using fractional notation. Two formats are recognized: simple integer literals and a pair of integer literals separated by a '/', to indicate a rational number.

Sourceval of_float_string : string -> num

Convert a simple floating point literal to a num. Plain integer literals are also accepted; numbers written with a trailing exponent are not currently accepted.

Sourceval (+) : num -> num -> num
Sourceval (-) : num -> num -> num
Sourceval (*) : num -> num -> num
Sourceval (/) : num -> num -> num
Sourceval (**) : num -> num -> num
val max_num : num -> num -> num
val min_num : num -> num -> num
Sourceval quo : num -> num -> num

Additional operations

Euclidian divisiom

Sourceval square : num -> num
Sourceval succ : num -> num
Sourceval pred : num -> num
Sourceval is_integer : num -> bool

is_integer x returns true if x represents an integer value, false otherwise

Sourceval round : num -> num
Sourceval floor : num -> num
Sourceval ceil : num -> num
Sourceval approx : num -> num

approx n return the integer closest to n

Sourceval sign : num -> int

Return -1, 0 or 1 according to the sign of the argument.

Sourceval operations : num BatNumber.numeric

Comparisons between numbers

val (=/) : num -> num -> bool
val (</) : num -> num -> bool
val (>/) : num -> num -> bool
val (<=/) : num -> num -> bool
val (>=/) : num -> num -> bool
val (<>/) : num -> num -> bool
val eq_num : num -> num -> bool
val lt_num : num -> num -> bool
val le_num : num -> num -> bool
val gt_num : num -> num -> bool
val ge_num : num -> num -> bool

Coercions with strings

val approx_num_fix : int -> num -> string

See Num.approx_num_exp.

val approx_num_exp : int -> num -> string

Approximate a number by a decimal. The first argument is the required precision. The second argument is the number to approximate. Num.approx_num_fix uses decimal notation; the first argument is the number of digits after the decimal point. approx_num_exp uses scientific (exponential) notation; the first argument is the number of digits in the mantissa.

val nat_of_num : num -> Nat.nat

Coercions between numerical types

val num_of_nat : Nat.nat -> num
val num_of_big_int : Big_int.big_int -> num
val big_int_of_num : num -> Big_int.big_int
val ratio_of_num : num -> Ratio.ratio
val num_of_ratio : Ratio.ratio -> num
val float_of_num : num -> float

Boilerplate code

Sourceval print : 'a BatInnerIO.output -> t -> unit

Printing

Submodules grouping all infix operators

Sourcemodule TaggedInfix : sig ... end
Sourcemodule Infix : sig ... end

Deprecated

val (+/) : num -> num -> num
val add_num : num -> num -> num
val minus_num : num -> num
val (-/) : num -> num -> num
val sub_num : num -> num -> num
val (*/) : num -> num -> num
val mult_num : num -> num -> num
val square_num : num -> num
val (//) : num -> num -> num
val div_num : num -> num -> num
val quo_num : num -> num -> num
val mod_num : num -> num -> num
val (**/) : num -> num -> num
val power_num : num -> num -> num
val abs_num : num -> num
val succ_num : num -> num
val pred_num : num -> num
val incr_num : num ref -> unit
val decr_num : num ref -> unit
val is_integer_num : num -> bool
val integer_num : num -> num
val floor_num : num -> num
val round_num : num -> num
val ceiling_num : num -> num
val sign_num : num -> int
val string_of_num : num -> string
val num_of_string : string -> num
val int_of_num : num -> int
val num_of_int : int -> num
val compare_num : num -> num -> int