-
Notifications
You must be signed in to change notification settings - Fork 460
/
Copy pathpervasives.resi
747 lines (595 loc) · 26.8 KB
/
pervasives.resi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
/* ************************************************************************ */
/* */
/* OCaml */
/* */
/* Xavier Leroy, 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 Lesser General Public License version 2.1, with the */
/* special exception on linking described in the file LICENSE. */
/* */
/* ************************************************************************ */
/*** The initially opened module.
This module provides the basic operations over the built-in types
(numbers, booleans, byte sequences, strings, exceptions, references,
lists, arrays, input-output channels, ...).
This module is automatically opened at the beginning of each compilation.
All components of this module can therefore be referred by their short
name, without prefixing them by [Pervasives].
*/
/* Internal */
external __unsafe_cast: 'a => 'b = "%identity"
/* 1 Exceptions} */
/** Raise the given exception value */
external raise: exn => 'a = "%raise"
/** A faster version [raise] which does not record the backtrace.
@since 4.02.0
*/
external raise_notrace: exn => 'a = "%raise_notrace"
/** Raise exception [Invalid_argument] with the given string. */
let invalid_arg: string => 'a
/** Raise exception [Failure] with the given string. */
let failwith: string => 'a
/** The [Exit] exception is not raised by any library function. It is
provided for use in your programs. */
exception Exit
/* {1 Comparisons} */
/** [e1 = e2] tests for structural equality of [e1] and [e2].
Mutable structures (e.g. references and arrays) are equal
if and only if their current contents are structurally equal,
even if the two mutable objects are not the same physical object.
Equality between functional values raises [Invalid_argument].
Equality between cyclic data structures may not terminate.
Left-associative operator at precedence level 4/11. */
external \"=": ('a, 'a) => bool = "%equal"
/** Negation of {!Pervasives.( = )}.
Left-associative operator at precedence level 4/11. */
external \"<>": ('a, 'a) => bool = "%notequal"
/** See {!Pervasives.( >= )}.
Left-associative operator at precedence level 4/11. */
external \"<": ('a, 'a) => bool = "%lessthan"
/** See {!Pervasives.( >= )}.
Left-associative operator at precedence level 4/11. */
external \">": ('a, 'a) => bool = "%greaterthan"
/** See {!Pervasives.( >= )}.
Left-associative operator at precedence level 4/11. */
external \"<=": ('a, 'a) => bool = "%lessequal"
/** Structural ordering functions. These functions coincide with
the usual orderings over integers, characters, strings, byte sequences
and floating-point numbers, and extend them to a
total ordering over all types.
The ordering is compatible with [( = )]. As in the case
of [( = )], mutable structures are compared by contents.
Comparison between functional values raises [Invalid_argument].
Comparison between cyclic structures may not terminate.
Left-associative operator at precedence level 4/11. */
external \">=": ('a, 'a) => bool = "%greaterequal"
/** [compare x y] returns [0] if [x] is equal to [y],
a negative integer if [x] is less than [y], and a positive integer
if [x] is greater than [y]. The ordering implemented by [compare]
is compatible with the comparison predicates [=], [<] and [>]
defined above, with one difference on the treatment of the float value
{!Pervasives.nan}. Namely, the comparison predicates treat [nan]
as different from any other float value, including itself;
while [compare] treats [nan] as equal to itself and less than any
other float value. This treatment of [nan] ensures that [compare]
defines a total ordering relation.
[compare] applied to functional values may raise [Invalid_argument].
[compare] applied to cyclic structures may not terminate.
The [compare] function can be used as the comparison function
required by the {!Set.Make} and {!Map.Make} functors, as well as
the {!List.sort} and {!Array.sort} functions. */
external compare: ('a, 'a) => int = "%compare"
/** Return the smaller of the two arguments.
The result is unspecified if one of the arguments contains
the float value [nan]. */
external min: ('a, 'a) => 'a = "%bs_min"
/** Return the greater of the two arguments.
The result is unspecified if one of the arguments contains
the float value [nan]. */
external max: ('a, 'a) => 'a = "%bs_max"
/** [e1 == e2] tests for physical equality of [e1] and [e2].
On mutable types such as references, arrays, byte sequences, records with
mutable fields and objects with mutable instance variables,
[e1 == e2] is true if and only if physical modification of [e1]
also affects [e2].
On non-mutable types, the behavior of [( == )] is
implementation-dependent; however, it is guaranteed that
[e1 == e2] implies [compare e1 e2 = 0].
Left-associative operator at precedence level 4/11. */
external \"==": ('a, 'a) => bool = "%eq"
/** Negation of {!Pervasives.( == )}.
Left-associative operator at precedence level 4/11. */
external \"!=": ('a, 'a) => bool = "%noteq"
/* {1 Boolean operations} */
/** The boolean negation. */
external not: bool => bool = "%boolnot"
/** The boolean 'and'. Evaluation is sequential, left-to-right:
in [e1 && e2], [e1] is evaluated first, and if it returns [false],
[e2] is not evaluated at all.
Right-associative operator at precedence level 3/11. */
external \"&&": (bool, bool) => bool = "%sequand"
/** The boolean 'or'. Evaluation is sequential, left-to-right:
in [e1 || e2], [e1] is evaluated first, and if it returns [true],
[e2] is not evaluated at all.
Right-associative operator at precedence level 2/11.
*/
external \"||": (bool, bool) => bool = "%sequor"
/* {1 Debugging} */
/** [__LOC__] returns the location at which this expression appears in
the file currently being parsed by the compiler, with the standard
error format of OCaml: "File %S, line %d, characters %d-%d".
@since 4.02.0
*/
external __LOC__: string = "%loc_LOC"
/** [__FILE__] returns the name of the file currently being
parsed by the compiler.
@since 4.02.0
*/
external __FILE__: string = "%loc_FILE"
/** [__LINE__] returns the line number at which this expression
appears in the file currently being parsed by the compiler.
@since 4.02.0
*/
external __LINE__: int = "%loc_LINE"
/** [__MODULE__] returns the module name of the file being
parsed by the compiler.
@since 4.02.0
*/
external __MODULE__: string = "%loc_MODULE"
/** [__POS__] returns a tuple [(file,lnum,cnum,enum)], corresponding
to the location at which this expression appears in the file
currently being parsed by the compiler. [file] is the current
filename, [lnum] the line number, [cnum] the character position in
the line and [enum] the last character position in the line.
@since 4.02.0
*/
external __POS__: (string, int, int, int) = "%loc_POS"
/** [__LOC_OF__ expr] returns a pair [(loc, expr)] where [loc] is the
location of [expr] in the file currently being parsed by the
compiler, with the standard error format of OCaml: "File %S, line
%d, characters %d-%d".
@since 4.02.0
*/
external __LOC_OF__: 'a => (string, 'a) = "%loc_LOC"
/** [__LINE__ expr] returns a pair [(line, expr)], where [line] is the
line number at which the expression [expr] appears in the file
currently being parsed by the compiler.
@since 4.02.0
*/
external __LINE_OF__: 'a => (int, 'a) = "%loc_LINE"
/** [__POS_OF__ expr] returns a pair [(loc,expr)], where [loc] is a
tuple [(file,lnum,cnum,enum)] corresponding to the location at
which the expression [expr] appears in the file currently being
parsed by the compiler. [file] is the current filename, [lnum] the
line number, [cnum] the character position in the line and [enum]
the last character position in the line.
@since 4.02.0
*/
external __POS_OF__: 'a => ((string, int, int, int), 'a) = "%loc_POS"
/* {1 Composition operators} */
/** Reverse-application operator: [x |> f |> g] is exactly equivalent
to [g (f (x))].
Left-associative operator at precedence level 4/11.
@since 4.01
*/
external \"|>": ('a, 'a => 'b) => 'b = "%revapply"
/** Application operator: [g @@ f @@ x] is exactly equivalent to
[g (f (x))].
Right-associative operator at precedence level 5/11.
@since 4.01
*/
external \"@@": ('a => 'b, 'a) => 'b = "%apply"
/* {1 Integer arithmetic} */
/* Integers are 31 bits wide (or 63 bits on 64-bit processors).
All operations are taken modulo 2{^31} (or 2{^63}).
They do not fail on overflow. */
/** Unary negation. You can also write [- e] instead of [~- e].
Unary operator at precedence level 9/11 for [- e]
and 11/11 for [~- e]. */
external \"~-": int => int = "%negint"
/** Unary addition. You can also write [+ e] instead of [~+ e].
Unary operator at precedence level 9/11 for [+ e]
and 11/11 for [~+ e].
@since 3.12.0
*/
external \"~+": int => int = "%identity"
/** [succ x] is [x + 1]. */
external succ: int => int = "%succint"
/** [pred x] is [x - 1]. */
external pred: int => int = "%predint"
/** Integer addition.
Left-associative operator at precedence level 6/11. */
external \"+": (int, int) => int = "%addint"
/** Integer subtraction.
Left-associative operator at precedence level 6/11. */
external \"-": (int, int) => int = "%subint"
/** Integer multiplication.
Left-associative operator at precedence level 7/11. */
external \"*": (int, int) => int = "%mulint"
/** Integer division.
Raise [Division_by_zero] if the second argument is 0.
Integer division rounds the real quotient of its arguments towards zero.
More precisely, if [x >= 0] and [y > 0], [x / y] is the greatest integer
less than or equal to the real quotient of [x] by [y]. Moreover,
[(- x) / y = x / (- y) = - (x / y)].
Left-associative operator at precedence level 7/11. */
external \"/": (int, int) => int = "%divint"
/** Integer remainder. If [y] is not zero, the result
of [x mod y] satisfies the following properties:
[x = (x / y) * y + x mod y] and
[abs(x mod y) <= abs(y) - 1].
If [y = 0], [x mod y] raises [Division_by_zero].
Note that [x mod y] is negative only if [x < 0].
Raise [Division_by_zero] if [y] is zero.
Left-associative operator at precedence level 7/11. */
external mod: (int, int) => int = "%modint"
/** Return the absolute value of the argument. Note that this may be
negative if the argument is [min_int]. */
let abs: int => int
/** The greatest representable integer. */
let max_int: int
/** The smallest representable integer. */
let min_int: int
/* {2 Bitwise operations} */
/** Bitwise logical and.
Left-associative operator at precedence level 7/11. */
external land: (int, int) => int = "%andint"
/** Bitwise logical or.
Left-associative operator at precedence level 7/11. */
external lor: (int, int) => int = "%orint"
/** Bitwise logical exclusive or.
Left-associative operator at precedence level 7/11. */
external lxor: (int, int) => int = "%xorint"
/** Bitwise logical negation. */
let lnot: int => int
/** [n lsl m] shifts [n] to the left by [m] bits.
The result is unspecified if [m < 0] or [m >= bitsize],
where [bitsize] is [32] on a 32-bit platform and
[64] on a 64-bit platform.
Right-associative operator at precedence level 8/11. */
external lsl: (int, int) => int = "%lslint"
/** [n lsr m] shifts [n] to the right by [m] bits.
This is a logical shift: zeroes are inserted regardless of
the sign of [n].
The result is unspecified if [m < 0] or [m >= bitsize].
Right-associative operator at precedence level 8/11. */
external lsr: (int, int) => int = "%lsrint"
/** [n asr m] shifts [n] to the right by [m] bits.
This is an arithmetic shift: the sign bit of [n] is replicated.
The result is unspecified if [m < 0] or [m >= bitsize].
Right-associative operator at precedence level 8/11. */
external asr: (int, int) => int = "%asrint"
/* {1 Floating-point arithmetic}
OCaml's floating-point numbers follow the
IEEE 754 standard, using double precision (64 bits) numbers.
Floating-point operations never raise an exception on overflow,
underflow, division by zero, etc. Instead, special IEEE numbers
are returned as appropriate, such as [infinity] for [1.0 /. 0.0],
[neg_infinity] for [-1.0 /. 0.0], and [nan] ('not a number')
for [0.0 /. 0.0]. These special numbers then propagate through
floating-point computations as expected: for instance,
[1.0 /. infinity] is [0.0], and any arithmetic operation with [nan]
as argument returns [nan] as result.
*/
/** Unary negation. You can also write [-. e] instead of [~-. e].
Unary operator at precedence level 9/11 for [-. e]
and 11/11 for [~-. e]. */
external \"~-.": float => float = "%negfloat"
/** Unary addition. You can also write [+. e] instead of [~+. e].
Unary operator at precedence level 9/11 for [+. e]
and 11/11 for [~+. e].
@since 3.12.0
*/
external \"~+.": float => float = "%identity"
/** Floating-point addition.
Left-associative operator at precedence level 6/11. */
external \"+.": (float, float) => float = "%addfloat"
/** Floating-point subtraction.
Left-associative operator at precedence level 6/11. */
external \"-.": (float, float) => float = "%subfloat"
/** Floating-point multiplication.
Left-associative operator at precedence level 7/11. */
external \"*.": (float, float) => float = "%mulfloat"
/** Floating-point division.
Left-associative operator at precedence level 7/11. */
external \"/.": (float, float) => float = "%divfloat"
@val @scope("Math") /** Exponentiation. */
external \"**": (float, float) => float = "pow"
@val @scope("Math") /** Square root. */
external sqrt: float => float = "sqrt"
@val @scope("Math") /** Exponential. */
external exp: float => float = "exp"
@val @scope("Math") /** Natural logarithm. */
external log: float => float = "log"
@val @scope("Math") /** Base 10 logarithm. */
external log10: float => float = "log10"
/** [expm1 x] computes [exp x -. 1.0], giving numerically-accurate results
even if [x] is close to [0.0].
@since 3.12.0
*/
external expm1: float => float = "?expm1_float"
@val
@scope("Math")
/** [log1p x] computes [log(1.0 +. x)] (natural logarithm),
giving numerically-accurate results even if [x] is close to [0.0].
@since 3.12.0
*/
external log1p: float => float = "log1p"
@val @scope("Math") /** Cosine. Argument is in radians. */
external cos: float => float = "cos"
@val @scope("Math") /** Sine. Argument is in radians. */
external sin: float => float = "sin"
@val @scope("Math") /** Tangent. Argument is in radians. */
external tan: float => float = "tan"
@val
@scope("Math")
/** Arc cosine. The argument must fall within the range [[-1.0, 1.0]].
Result is in radians and is between [0.0] and [pi]. */
external acos: float => float = "acos"
@val
@scope("Math")
/** Arc sine. The argument must fall within the range [[-1.0, 1.0]].
Result is in radians and is between [-pi/2] and [pi/2]. */
external asin: float => float = "asin"
@val @scope("Math") /** Arc tangent.
Result is in radians and is between [-pi/2] and [pi/2]. */
external atan: float => float = "atan"
@val
@scope("Math")
/** [atan2 y x] returns the arc tangent of [y /. x]. The signs of [x]
and [y] are used to determine the quadrant of the result.
Result is in radians and is between [-pi] and [pi]. */
external atan2: (float, float) => float = "atan2"
/** [hypot x y] returns [sqrt(x *. x + y *. y)], that is, the length
of the hypotenuse of a right-angled triangle with sides of length
[x] and [y], or, equivalently, the distance of the point [(x,y)]
to origin.
@since 4.00.0 */
external hypot: (float, float) => float = "?hypot_float"
@val @scope("Math") /** Hyperbolic cosine. Argument is in radians. */
external cosh: float => float = "cosh"
@val @scope("Math") /** Hyperbolic sine. Argument is in radians. */
external sinh: float => float = "sinh"
@val @scope("Math") /** Hyperbolic tangent. Argument is in radians. */
external tanh: float => float = "tanh"
@val
@scope("Math")
/** Round above to an integer value.
[ceil f] returns the least integer value greater than or equal to [f].
The result is returned as a float. */
external ceil: float => float = "ceil"
@val
@scope("Math")
/** Round below to an integer value.
[floor f] returns the greatest integer value less than or
equal to [f].
The result is returned as a float. */
external floor: float => float = "floor"
@val @scope("Math") /** [abs_float f] returns the absolute value of [f]. */
external abs_float: float => float = "abs"
/** [copysign x y] returns a float whose absolute value is that of [x]
and whose sign is that of [y]. If [x] is [nan], returns [nan].
If [y] is [nan], returns either [x] or [-. x], but it is not
specified which.
@since 4.00.0 */
external copysign: (float, float) => float = "?copysign_float"
/** [mod_float a b] returns the remainder of [a] with respect to
[b]. The returned value is [a -. n *. b], where [n]
is the quotient [a /. b] rounded towards zero to an integer. */
external mod_float: (float, float) => float = "?fmod_float"
/** [frexp f] returns the pair of the significant
and the exponent of [f]. When [f] is zero, the
significant [x] and the exponent [n] of [f] are equal to
zero. When [f] is non-zero, they are defined by
[f = x *. 2 ** n] and [0.5 <= x < 1.0]. */
external frexp: float => (float, int) = "?frexp_float"
/** [ldexp x n] returns [x *. 2 ** n]. */
external ldexp: (float, int) => float = "?ldexp_float"
/** [modf f] returns the pair of the fractional and integral
part of [f]. */
external modf: float => (float, float) = "?modf_float"
/** Same as {!Pervasives.float_of_int}. */
external float: int => float = "%floatofint"
/** Convert an integer to floating-point. */
external float_of_int: int => float = "%floatofint"
/** Same as {!Pervasives.int_of_float}. */
external truncate: float => int = "%intoffloat"
/** Truncate the given floating-point number to an integer.
The result is unspecified if the argument is [nan] or falls outside the
range of representable integers. */
external int_of_float: float => int = "%intoffloat"
/** Positive infinity. */
let infinity: float
/** Negative infinity. */
let neg_infinity: float
@val
@scope("Number")
/** A special floating-point value denoting the result of an
undefined operation such as [0.0 /. 0.0]. Stands for
'not a number'. Any floating-point operation with [nan] as
argument returns [nan] as result. As for floating-point comparisons,
[=], [<], [<=], [>] and [>=] return [false] and [<>] returns [true]
if one or both of their arguments is [nan]. */
external nan: float = "NaN"
/* we could also use [0. /. 0.] */
/** The largest positive finite value of type [float]. */
let max_float: float
/** The smallest positive, non-zero, non-denormalized value of type [float]. */
let min_float: float
/** The difference between [1.0] and the smallest exactly representable
floating-point number greater than [1.0]. */
let epsilon_float: float
/** The five classes of floating-point numbers, as determined by
the {!Pervasives.classify_float} function. */
type fpclass =
| /** Normal number, none of the below */ FP_normal
| /** Number very close to 0.0, has reduced precision */ FP_subnormal
| /** Number is 0.0 or -0.0 */ FP_zero
| /** Number is positive or negative infinity */ FP_infinite
| /** Not a number: result of an undefined operation */ FP_nan
/** Return the class of the given floating-point number:
normal, subnormal, zero, infinite, or not a number. */
let classify_float: float => fpclass
/** {1 String operations}
More string operations are provided in module {!String}.
*/
/** String concatenation.
Right-associative operator at precedence level 5/11. */
external \"^": (string, string) => string = "#string_append"
/* {1 Character operations}
More character operations are provided in module {!Char}.
*/
/** Return the ASCII code of the argument. */
external int_of_char: char => int = "%identity"
/** Return the character with the given ASCII code.
Raise [Invalid_argument "char_of_int"] if the argument is
outside the range 0--255. */
let char_of_int: int => char
/* {1 Unit operations} */
/** Discard the value of its argument and return [()].
For instance, [ignore(f x)] discards the result of
the side-effecting function [f]. It is equivalent to
[f x; ()], except that the latter may generate a
compiler warning; writing [ignore(f x)] instead
avoids the warning. */
external ignore: 'a => unit = "%ignore"
/* {1 String conversion functions} */
/** Return the string representation of a boolean. As the returned values
may be shared, the user should not modify them directly.
*/
let string_of_bool: bool => string
/** Convert the given string to a boolean.
Raise [Invalid_argument "bool_of_string"] if the string is not
["true"] or ["false"]. */
let bool_of_string: string => bool
/** Convert the given string to a boolean.
Return [None] if the string is not
["true"] or ["false"].
@since 4.05
*/
let bool_of_string_opt: string => option<bool>
@val /** Return the string representation of an integer, in decimal. */
external string_of_int: int => string = "String"
/** Convert the given string to an integer.
The string is read in decimal (by default, or if the string
begins with [0u]), in hexadecimal (if it begins with [0x] or
[0X]), in octal (if it begins with [0o] or [0O]), or in binary
(if it begins with [0b] or [0B]).
The [0u] prefix reads the input as an unsigned integer in the range
[[0, 2*max_int+1]]. If the input exceeds {!max_int}
it is converted to the signed integer
[min_int + input - max_int - 1].
The [_] (underscore) character can appear anywhere in the string
and is ignored.
Raise [Failure "int_of_string"] if the given string is not
a valid representation of an integer, or if the integer represented
exceeds the range of integers representable in type [int]. */
external int_of_string: string => int = "?int_of_string"
/** Same as [int_of_string], but returns [None] instead of raising.
@since 4.05
*/
let int_of_string_opt: string => option<int>
@deprecated("Please use Js.Float.toString instead, string_of_float generates unparseable floats")
/** Return the string representation of a floating-point number. */
let string_of_float: float => string
/** Convert the given string to a float. The string is read in decimal
(by default) or in hexadecimal (marked by [0x] or [0X]).
The format of decimal floating-point numbers is
[ [-] dd.ddd (e|E) [+|-] dd ], where [d] stands for a decimal digit.
The format of hexadecimal floating-point numbers is
[ [-] 0(x|X) hh.hhh (p|P) [+|-] dd ], where [h] stands for an
hexadecimal digit and [d] for a decimal digit.
In both cases, at least one of the integer and fractional parts must be
given; the exponent part is optional.
The [_] (underscore) character can appear anywhere in the string
and is ignored.
Depending on the execution platforms, other representations of
floating-point numbers can be accepted, but should not be relied upon.
Raise [Failure "float_of_string"] if the given string is not a valid
representation of a float. */
external float_of_string: string => float = "?float_of_string"
/** Same as [float_of_string], but returns [None] instead of raising.
@since 4.05
*/
let float_of_string_opt: string => option<float>
/* {1 Pair operations} */
/** Return the first component of a pair. */
external fst: (('a, 'b)) => 'a = "%field0"
/** Return the second component of a pair. */
external snd: (('a, 'b)) => 'b = "%field1"
/* {1 List operations}
More list operations are provided in module {!List}.
*/
@deprecated("Use Belt.List.concat instead")
/** List concatenation. Tail-recursive (length of the first argument).
Right-associative operator at precedence level 5/11. */
let \"@": (list<'a>, list<'a>) => list<'a>
type int32 = int
/** Print a string on standard output. */
let print_string: string => unit
/** Print an integer, in decimal, on standard output. */
let print_int: int => unit
/** Print a floating-point number, in decimal, on standard output. */
let print_float: float => unit
/** Print a floating-point number, in decimal, on standard output. */
@val
@scope("console")
/** Print a string, followed by a newline character, on
standard output and flush standard output. */
external print_endline: string => unit = "log"
/** Print a newline character on standard output, and flush
standard output. This can be used to simulate line
buffering of standard output. */
let print_newline: unit => unit
@val
@scope("console")
/** Print a string, followed by a newline character on standard
error and flush standard error. */
external prerr_endline: string => unit = "error"
/** Print a newline character on standard error, and flush
standard error. */
let prerr_newline: unit => unit
/* {1 References} */
/** The type of references (mutable indirection cells) containing
a value of type ['a]. */
type ref<'a> = {mutable contents: 'a}
/** Return a fresh reference containing the given value. */
external ref: 'a => ref<'a> = "%makemutable"
/** [!r] returns the current contents of reference [r].
Equivalent to [fun r -> r.contents].
Unary operator at precedence level 11/11.*/
external \"!": ref<'a> => 'a = "%bs_ref_field0"
/** [r := a] stores the value of [a] in reference [r].
Equivalent to [fun r v -> r.contents <- v].
Right-associative operator at precedence level 1/11. */
external \":=": (ref<'a>, 'a) => unit = "%bs_ref_setfield0"
/** Increment the integer contained in the given reference.
Equivalent to [fun r -> r := succ !r]. */
external incr: ref<int> => unit = "%incr"
/** Decrement the integer contained in the given reference.
Equivalent to [fun r -> r := pred !r]. */
external decr: ref<int> => unit = "%decr"
/* {1 Program termination} */
/** Terminate the process, returning the given status code
to the operating system: usually 0 to indicate no errors,
and a small positive integer to indicate failure.
All open output channels are flushed with [flush_all].
An implicit [exit 0] is performed each time a program
terminates normally. An implicit [exit 2] is performed if the program
terminates early because of an uncaught exception. */
let exit: int => 'a
/** Register the given function to be called at program termination
time. The functions registered with [at_exit] will be called when
the program does any of the following:
- executes {!Pervasives.exit}
- terminates, either normally or because of an uncaught
exception
- executes the C function [caml_shutdown].
The functions are called in 'last in, first out' order: the
function most recently added with [at_exit] is called first. */
let at_exit: (unit => unit) => unit
let valid_float_lexem: string => string