1Num(3) OCaml library Num(3)
2
6 Num - Operation on arbitrary-precision numbers.
7
9 Module Num
10
12 Module Num
13 : sig end
14 Operation on arbitrary-precision numbers.
17 Numbers (type num ) are arbitrary-precision rational numbers, plus the
19 special elements 1/0 (infinity) and 0/0 (undefined).
20 type num =
27 | Int of int
28 | Big_int of Big_int.big_int
29 | Ratio of Ratio.ratio
30 The type of numbers.
33 === Arithmetic operations ===
39 val (+/) : num -> num -> num
42 Same as Num.add_num .
44 val add_num : num -> num -> num
49 Addition
51 val minus_num : num -> num
56 Unary negation.
58 val (-/) : num -> num -> num
63 Same as Num.sub_num .
65 val sub_num : num -> num -> num
70 Subtraction
72 val ( */ ) : num -> num -> num
77 Same as Num.mult_num .
79 val mult_num : num -> num -> num
84 Multiplication
86 val square_num : num -> num
91 Squaring
93 val (//) : num -> num -> num
98 Same as Num.div_num .
100 val div_num : num -> num -> num
105 Division
107 val quo_num : num -> num -> num
112 Euclidean division: quotient.
114 val mod_num : num -> num -> num
119 Euclidean division: remainder.
121 val ( **/ ) : num -> num -> num
126 Same as Num.power_num .
128 val power_num : num -> num -> num
133 Exponentiation
135 val abs_num : num -> num
140 Absolute value.
142 val succ_num : num -> num
147 succ n is n+1
150 val pred_num : num -> num
156 pred n is n-1
159 val incr_num : num Pervasives.ref -> unit
165 incr r is r:=!r+1 , where r is a reference to a number.
168 val decr_num : num Pervasives.ref -> unit
173 decr r is r:=!r-1 , where r is a reference to a number.
176 val is_integer_num : num -> bool
181 Test if a number is an integer
183 === The four following functions approximate a number by an integer :
189 ===
190 val integer_num : num -> num
193 integer_num n returns the integer closest to n . In case of ties,
196 rounds towards zero.
197 val floor_num : num -> num
202 floor_num n returns the largest integer smaller or equal to n .
205 val round_num : num -> num
210 round_num n returns the integer closest to n . In case of ties, rounds
213 off zero.
214 val ceiling_num : num -> num
219 ceiling_num n returns the smallest integer bigger or equal to n .
222 val sign_num : num -> int
227 Return -1 , 0 or 1 according to the sign of the argument.
229 === Comparisons between numbers ===
235 val (=/) : num -> num -> bool
238 val (</) : num -> num -> bool
243 val (>/) : num -> num -> bool
248 val (<=/) : num -> num -> bool
253 val (>=/) : num -> num -> bool
258 val (<>/) : num -> num -> bool
263 val eq_num : num -> num -> bool
268 val lt_num : num -> num -> bool
273 val le_num : num -> num -> bool
278 val gt_num : num -> num -> bool
283 val ge_num : num -> num -> bool
288 val compare_num : num -> num -> int
293 Return -1 , 0 or 1 if the first argument is less than, equal to, or
295 greater than the second argument.
296 val max_num : num -> num -> num
301 Return the greater of the two arguments.
303 val min_num : num -> num -> num
308 Return the smaller of the two arguments.
310 === Coercions with strings ===
316 val string_of_num : num -> string
319 Convert a number to a string, using fractional notation.
321 val approx_num_fix : int -> num -> string
326 See Num.approx_num_exp .
328 val approx_num_exp : int -> num -> string
333 Approximate a number by a decimal. The first argument is the required
335 precision. The second argument is the number to approximate.
336 Num.approx_num_fix uses decimal notation; the first argument is the
337 number of digits after the decimal point. approx_num_exp uses scien‐
338 tific (exponential) notation; the first argument is the number of dig‐
339 its in the mantissa.
340 val num_of_string : string -> num
345 Convert a string to a number.
347 === Coercions between numerical types ===
353 val int_of_num : num -> int
356 val num_of_int : int -> num
361 val nat_of_num : num -> Nat.nat
366 val num_of_nat : Nat.nat -> num
371 val num_of_big_int : Big_int.big_int -> num
376 val big_int_of_num : num -> Big_int.big_int
381 val ratio_of_num : num -> Ratio.ratio
386 val num_of_ratio : Ratio.ratio -> num
391 val float_of_num : num -> float
396OCamldoc 2017-03-22 Num(3)