1Num(3) OCamldoc 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 =
26 | Int of int
27 | Big_int of Big_int.big_int
28 | Ratio of Ratio.ratio
29 The type of numbers.
32 === Arithmetic operations ===
37 val (+/) : num -> num -> num
40 Same as Num.add_num .
42 val add_num : num -> num -> num
46 Addition
48 val minus_num : num -> num
52 Unary negation.
54 val (-/) : num -> num -> num
58 Same as Num.sub_num .
60 val sub_num : num -> num -> num
64 Subtraction
66 val ( */ ) : num -> num -> num
70 Same as Num.mult_num .
72 val mult_num : num -> num -> num
76 Multiplication
78 val square_num : num -> num
82 Squaring
84 val (//) : num -> num -> num
88 Same as Num.div_num .
90 val div_num : num -> num -> num
94 Division
96 val quo_num : num -> num -> num
100 Euclidean division: quotient.
102 val mod_num : num -> num -> num
106 Euclidean division: remainder.
108 val ( **/ ) : num -> num -> num
112 Same as Num.power_num .
114 val power_num : num -> num -> num
118 Exponentiation
120 val abs_num : num -> num
124 Absolute value.
126 val succ_num : num -> num
130 succ n is n+1
133 val pred_num : num -> num
138 pred n is n-1
141 val incr_num : num Pervasives.ref -> unit
146 incr r is r:=!r+1 , where r is a reference to a number.
149 val decr_num : num Pervasives.ref -> unit
153 decr r is r:=!r-1 , where r is a reference to a number.
156 val is_integer_num : num -> bool
160 Test if a number is an integer
162 === The four following functions approximate a number by an integer :
167 ===
168 val integer_num : num -> num
171 integer_num n returns the integer closest to n . In case of ties,
174 rounds towards zero.
175 val floor_num : num -> num
179 floor_num n returns the largest integer smaller or equal to n .
182 val round_num : num -> num
186 round_num n returns the integer closest to n . In case of ties, rounds
189 off zero.
190 val ceiling_num : num -> num
194 ceiling_num n returns the smallest integer bigger or equal to n .
197 val sign_num : num -> int
201 Return -1 , 0 or 1 according to the sign of the argument.
203 === Comparisons between numbers ===
208 val (=/) : num -> num -> bool
211 val (</) : num -> num -> bool
216 val (>/) : num -> num -> bool
221 val (<=/) : num -> num -> bool
226 val (>=/) : num -> num -> bool
231 val (<>/) : num -> num -> bool
236 val eq_num : num -> num -> bool
241 val lt_num : num -> num -> bool
246 val le_num : num -> num -> bool
251 val gt_num : num -> num -> bool
256 val ge_num : num -> num -> bool
261 val compare_num : num -> num -> int
266 Return -1 , 0 or 1 if the first argument is less than, equal to, or
268 greater than the second argument.
269 val max_num : num -> num -> num
273 Return the greater of the two arguments.
275 val min_num : num -> num -> num
279 Return the smaller of the two arguments.
281 === Coercions with strings ===
286 val string_of_num : num -> string
289 Convert a number to a string, using fractional notation.
291 val approx_num_fix : int -> num -> string
295 See Num.approx_num_exp .
297 val approx_num_exp : int -> num -> string
301 Approximate a number by a decimal. The first argument is the required
303 precision. The second argument is the number to approximate.
304 Num.approx_num_fix uses decimal notation; the first argument is the
305 number of digits after the decimal point. approx_num_exp uses scien‐
306 tific (exponential) notation; the first argument is the number of dig‐
307 its in the mantissa.
308 val num_of_string : string -> num
312 Convert a string to a number. Raise Failure num_of_string if the given
314 string is not a valid representation of an integer
315 val num_of_string_opt : string -> num option
319 Convert a string to a number. Return None if the given string is not a
321 valid representation of an integer.
322 Since 4.05
325 === Coercions between numerical types ===
330 val int_of_num : num -> int
333 val int_of_num_opt : num -> int option
338 Since 4.05.0
340 val num_of_int : int -> num
344 val nat_of_num : num -> Nat.nat
349 val nat_of_num_opt : num -> Nat.nat option
354 Since 4.05.0
356 val num_of_nat : Nat.nat -> num
360 val num_of_big_int : Big_int.big_int -> num
365 val big_int_of_num : num -> Big_int.big_int
370 val big_int_of_num_opt : num -> Big_int.big_int option
375 Since 4.05.0
377 val ratio_of_num : num -> Ratio.ratio
381 val num_of_ratio : Ratio.ratio -> num
386 val float_of_num : num -> float
3912018-04-14 source: Num(3)