@grain/stdlib 0.6.5 → 0.7.0

package/float32.md

@@ -41,7 +41,7 @@ No other changes yet.
 </details>
 
 ```grain
-infinity : Float32
+infinity: Float32
 ```
 
 Infinity represented as a Float32 value.
@@ -55,7 +55,7 @@ No other changes yet.
 </details>
 
 ```grain
-nan : Float32
+nan: Float32
 ```
 
 NaN (Not a Number) represented as a Float32 value.
@@ -69,7 +69,7 @@ No other changes yet.
 </details>
 
 ```grain
-pi : Float32
+pi: Float32
 ```
 
 Pi represented as a Float32 value.
@@ -82,7 +82,7 @@ No other changes yet.
 </details>
 
 ```grain
-tau : Float32
+tau: Float32
 ```
 
 Tau represented as a Float32 value.
@@ -95,7 +95,7 @@ No other changes yet.
 </details>
 
 ```grain
-e : Float32
+e: Float32
 ```
 
 Euler's number represented as a Float32 value.
@@ -108,7 +108,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromNumber : (number: Number) => Float32
+fromNumber: (number: Number) => Float32
 ```
 
 Converts a Number to a Float32.
@@ -133,7 +133,7 @@ No other changes yet.
 </details>
 
 ```grain
-toNumber : (float: Float32) => Number
+toNumber: (float: Float32) => Number
 ```
 
 Converts a Float32 to a Number.
@@ -150,6 +150,76 @@ Returns:
 |----|-----------|
 |`Number`|The Float32 represented as a Number|
 
+### Float32.**reinterpretInt32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+reinterpretInt32: (value: Int32) => Float32
+```
+
+Interprets an Int32 as a Float32.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`value`|`Int32`|The value to convert|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The Int32 interpreted as an Float32|
+
+Examples:
+
+```grain
+assert Float32.reinterpretInt32(1065353216l) == 1.0f
+```
+
+```grain
+assert Float32.reinterpretInt32(-1082130432l) == -1.0f
+```
+
+### Float32.**reinterpretUint32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+reinterpretUint32: (value: Uint32) => Float32
+```
+
+Interprets an Uint32 as a Float32.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`value`|`Uint32`|The value to convert|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The Uint32 interpreted as an Float32|
+
+Examples:
+
+```grain
+assert Float32.reinterpretUint32(1065353216ul) == 1.0f
+```
+
+```grain
+assert Float32.reinterpretUint32(3212836864ul) == -1.0f
+```
+
 ### Float32.**(+)**
 
 <details>
@@ -165,7 +235,7 @@ Returns:
 </details>
 
 ```grain
-(+) : (x: Float32, y: Float32) => Float32
+(+): (x: Float32, y: Float32) => Float32
 ```
 
 Computes the sum of its operands.
@@ -205,7 +275,7 @@ assert 1.0f + 1.0f == 2.0f
 </details>
 
 ```grain
-(-) : (x: Float32, y: Float32) => Float32
+(-): (x: Float32, y: Float32) => Float32
 ```
 
 Computes the difference of its operands.
@@ -245,7 +315,7 @@ assert 1.0f - 1.0f == 0.0f
 </details>
 
 ```grain
-(*) : (x: Float32, y: Float32) => Float32
+(*): (x: Float32, y: Float32) => Float32
 ```
 
 Computes the product of its operands.
@@ -285,7 +355,7 @@ assert 2.0f * 2.0f == 4.0f
 </details>
 
 ```grain
-(/) : (x: Float32, y: Float32) => Float32
+(/): (x: Float32, y: Float32) => Float32
 ```
 
 Computes the quotient of its operands.
@@ -310,6 +380,39 @@ use Float32.{ (/) }
 assert 10.0f / 4.0f == 2.5f
 ```
 
+### Float32.**(\*\*)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(**): (base: Float32, power: Float32) => Float32
+```
+
+Computes the exponentiation of the given base and power.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`base`|`Float32`|The base float|
+|`power`|`Float32`|The exponent float|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The base raised to the given power|
+
+Examples:
+
+```grain
+use Float64.{ (**) }
+assert 2.0f ** 2.0f == 4.0f
+```
+
 ### Float32.**(<)**
 
 <details>
@@ -325,7 +428,7 @@ assert 10.0f / 4.0f == 2.5f
 </details>
 
 ```grain
-(<) : (x: Float32, y: Float32) => Bool
+(<): (x: Float32, y: Float32) => Bool
 ```
 
 Checks if the first value is less than the second value.
@@ -365,7 +468,7 @@ assert 1.0f < 2.0f
 </details>
 
 ```grain
-(>) : (x: Float32, y: Float32) => Bool
+(>): (x: Float32, y: Float32) => Bool
 ```
 
 Checks if the first value is greater than the second value.
@@ -405,7 +508,7 @@ assert 2.0f > 1.0f
 </details>
 
 ```grain
-(<=) : (x: Float32, y: Float32) => Bool
+(<=): (x: Float32, y: Float32) => Bool
 ```
 
 Checks if the first value is less than or equal to the second value.
@@ -450,7 +553,7 @@ assert -2.0f <= -2.0f
 </details>
 
 ```grain
-(>=) : (x: Float32, y: Float32) => Bool
+(>=): (x: Float32, y: Float32) => Bool
 ```
 
 Checks if the first value is greater than or equal to the second value.
@@ -480,6 +583,54 @@ use Float32.{ (>=) }
 assert 3.0f >= 3.0f
 ```
 
+### Float32.**isFinite**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isFinite: (x: Float32) => Bool
+```
+
+Checks if a float is finite.
+All values are finite exept for NaN, infinity or negative infinity.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The number to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the value is finite or `false` otherwise|
+
+Examples:
+
+```grain
+Float32.isFinite(0.5f)
+```
+
+```grain
+Float32.isFinite(1.0f)
+```
+
+```grain
+Float32.isFinite(Infinityf) == false
+```
+
+```grain
+Float32.isFinite(-Infinityf) == false
+```
+
+```grain
+Float32.isFinite(NaNf) == false
+```
+
 ### Float32.**isNaN**
 
 <details disabled>
@@ -488,7 +639,7 @@ No other changes yet.
 </details>
 
 ```grain
-isNaN : (x: Float32) => Bool
+isNaN: (x: Float32) => Bool
 ```
 
 Checks if the value is a float NaN value (Not A Number).
@@ -535,7 +686,7 @@ No other changes yet.
 </details>
 
 ```grain
-isInfinite : (x: Float32) => Bool
+isInfinite: (x: Float32) => Bool
 ```
 
 Checks if a float is infinite, that is either of positive or negative infinity.
@@ -574,6 +725,70 @@ Float32.isInfinite(0.5f) == false
 Float32.isInfinite(1.0f) == false
 ```
 
+### Float32.**min**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+min: (x: Float32, y: Float32) => Float32
+```
+
+Returns the smaller of its operands.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The first operand|
+|`y`|`Float32`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The smaller of the two operands|
+
+Examples:
+
+```grain
+Float32.min(5.0f, 2.0f) == 2.0f
+```
+
+### Float32.**max**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+max: (x: Float32, y: Float32) => Float32
+```
+
+Returns the larger of its operands.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The first operand|
+|`y`|`Float32`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The larger of the two operands|
+
+Examples:
+
+```grain
+Float32.max(5.0f, 2.0f) == 5.0f
+```
+
 ### Float32.**abs**
 
 <details disabled>
@@ -582,7 +797,7 @@ No other changes yet.
 </details>
 
 ```grain
-abs : (x: Float32) => Float32
+abs: (x: Float32) => Float32
 ```
 
 Returns the absolute value. That is, it returns `x` if `x` is positive or zero and the negation of `x` if `x` is negative.
@@ -617,7 +832,7 @@ No other changes yet.
 </details>
 
 ```grain
-neg : (x: Float32) => Float32
+neg: (x: Float32) => Float32
 ```
 
 Returns the negation of its operand.
@@ -644,3 +859,375 @@ Float32.neg(-1.0f) == 1.0f
 Float32.neg(1.0f) == -1.0f
 ```
 
+### Float32.**ceil**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+ceil: (x: Float32) => Float32
+```
+
+Rounds its operand up to the next largest whole value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The operand to ceil|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The next largest whole value of the operand|
+
+Examples:
+
+```grain
+Float32.ceil(5.5f) == 6.0f
+```
+
+```grain
+Float32.ceil(-5.5f) == -5.0f
+```
+
+### Float32.**floor**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+floor: (x: Float32) => Float32
+```
+
+Rounds its operand down to the largest whole value less than the operand.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The operand to floor|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The previous whole value of the operand|
+
+Examples:
+
+```grain
+Float32.floor(5.5f) == 5.0f
+```
+
+```grain
+Float32.floor(-5.5f) == -6.0f
+```
+
+### Float32.**trunc**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+trunc: (x: Float32) => Float32
+```
+
+Returns the whole value part of its operand, removing any fractional value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The operand to truncate|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The whole value part of the operand|
+
+Examples:
+
+```grain
+Float32.trunc(5.5f) == 5.0f
+```
+
+### Float32.**round**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+round: (x: Float32) => Float32
+```
+
+Returns its operand rounded to its nearest integer.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The operand to round|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The nearest integer to the operand|
+
+Examples:
+
+```grain
+Float32.round(5.5f) == 6.0f
+```
+
+```grain
+Float32.round(5.4f) == 5.0f
+```
+
+```grain
+Float32.round(-5.5f) == -6.0f
+```
+
+```grain
+Float32.round(-5.4f) == -5.0f
+```
+
+### Float32.**sqrt**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+sqrt: (x: Float32) => Float32
+```
+
+Computes the square root of its operand.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The operand to square root|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The square root of the operand|
+
+Examples:
+
+```grain
+Float32.sqrt(25.0f) == 5.0f
+```
+
+### Float32.**copySign**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+copySign: (x: Float32, y: Float32) => Float32
+```
+
+Copys the sign of the second operand to the first operand.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float32`|The operand to modify|
+|`y`|`Float32`|The operand to copy the sign from|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The first operand with the sign of the second operand|
+
+Examples:
+
+```grain
+Float32.copySign(2.0f, 1.0f) == 2.0f
+```
+
+```grain
+Float32.copySign(3.0f, -1.0f) == -3.0f
+```
+
+```grain
+Float32.copySign(-5.0f, 1.0f) == 5.0f
+```
+
+### Float32.**isClose**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isClose:
+  (a: Float32, b: Float32, ?relativeTolerance: Float32,
+   ?absoluteTolerance: Float32) => Bool
+```
+
+Determines whether two values are considered close to each other using a relative and absolute tolerance.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`a`|`Float32`|The first value|
+|`b`|`Float32`|The second value|
+|`?relativeTolerance`|`Float32`|The maximum tolerance to use relative to the larger absolute value `a` or `b`|
+|`?absoluteTolerance`|`Float32`|The absolute tolerance to use, regardless of the values of `a` or `b`|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the values are considered close to each other or `false` otherwise|
+
+Examples:
+
+```grain
+Float32.isClose(1.233f, 1.233f)
+```
+
+```grain
+Float32.isClose(1.233f, 1.233000001f)
+```
+
+```grain
+Float32.isClose(8.005f, 8.450f, absoluteTolerance=0.5f)
+```
+
+```grain
+Float32.isClose(4.0f, 4.1f, relativeTolerance=0.025f)
+```
+
+```grain
+Float32.isClose(1.233f, 1.24f) == false
+```
+
+```grain
+Float32.isClose(1.233f, 1.4566f) == false
+```
+
+```grain
+Float32.isClose(8.005f, 8.450f, absoluteTolerance=0.4f) == false
+```
+
+```grain
+Float32.isClose(4.0f, 4.1f, relativeTolerance=0.024f) == false
+```
+
+### Float32.**sin**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+sin: (radians: Float32) => Float32
+```
+
+Computes the sine of a float (in radians).
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`radians`|`Float32`|The input in radians|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The computed sine|
+
+Examples:
+
+```grain
+Float32.sin(0.0f) == 0.0f
+```
+
+### Float32.**cos**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+cos: (radians: Float32) => Float32
+```
+
+Computes the cosine of a float (in radians).
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`radians`|`Float32`|The input in radians|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The computed cosine|
+
+Examples:
+
+```grain
+Float32.cos(0.0f) == 1.0f
+```
+
+### Float32.**tan**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+tan: (radians: Float32) => Float32
+```
+
+Computes the tangent of a number (in radians).
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`radians`|`Float32`|The input in radians|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float32`|The computed tangent|
+
+Examples:
+
+```grain
+Float32.tan(0.0f) == 0.0f
+```
+