forked from rescript-lang/rescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBelt_Float.resi
122 lines (97 loc) · 3.37 KB
/
Belt_Float.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
/* Copyright (C) 2017 Authors of ReScript
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* In addition to the permissions granted to you by the LGPL, you may combine
* or link a "work that uses the Library" with a publicly distributed version
* of this file to produce a combined library or application, then distribute
* that combined work under the terms of your choosing, with no requirement
* to comply with the obligations normally placed on you by section 4 of the
* LGPL version 3 (or the corresponding section of a later version of the LGPL
* should you choose to use a later version).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
/*** This module includes convenience methods for handling `float` types. */
/**
Converts a given `float` to an `int`.
## Examples
```rescript
Js.log(Belt.Float.toInt(1.0) === 1) /* true */
```
*/
external toInt: float => int = "%intoffloat"
/**
Converts a given `int` to a `float`.
## Examples
```rescript
Js.log(Belt.Float.fromInt(1) === 1.0) /* true */
```
*/
external fromInt: int => float = "%identity"
/**
Converts a given `string` to a `float`. Returns `Some(float)` when the input is a number, `None` otherwise.
## Examples
```rescript
Js.log(Belt.Float.fromString("1.0") === Some(1.0)) /* true */
```
*/
let fromString: string => option<float>
@val
/**
Converts a given `float` to a `string`. Uses the JavaScript `String` constructor under the hood.
## Examples
```rescript
Js.log(Belt.Float.toString(1.0) === "1.0") /* true */
```
*/
external toString: float => string = "String"
/**
Addition of two `float` values.
Can be opened in a module to avoid dot-notation (`+.`), however this yields a shadow warning (Warning number 44) in the default configuration.
## Examples
```rescript
open Belt.Float
assertEqual(2.0 + 2.0, 4.0)
```
*/
external \"+": (float, float) => float = "%addfloat"
/**
Subtraction of two `float` values.
Can be opened in a module to avoid dot-notation (`-.`), however this yields a shadow warning (Warning number 44) in the default configuration.
## Examples
```rescript
open Belt.Float
assertEqual(2.0 - 1.0, 1.0)
```
*/
external \"-": (float, float) => float = "%subfloat"
/**
Multiplication of two `float` values.
Can be opened in a module to avoid dot-notation (`*.`), however this yields a shadow warning (Warning number 44) in the default configuration.
## Examples
```rescript
open Belt.Float
assertEqual(2.0 * 2.0, 4.0)
```
*/
external \"*": (float, float) => float = "%mulfloat"
/**
Division of two `float` values.
Can be opened in a module to avoid dot-notation (`/.`), however this yields a shadow warning (Warning number 44) in the default configuration.
## Examples
```rescript
open Belt.Float
assertEqual(4.0 / 2.0, 2.0)
```
*/
external \"/": (float, float) => float = "%divfloat"