Functions

absolute_value

</>
``pub fn absolute_value(float: Float) -> Float``

Returns the absolute value of the input as a `Float`.

Examples

``````> absolute_value(-12.5)
12.5

> absolute_value(10.2)
10.2
``````

ceiling

</>
``pub fn ceiling(float: Float) -> Float``

Rounds the value to the next highest whole number as a `Float`.

Examples

``````> ceiling(2.3)
3.0
``````

clamp

</>
``pub fn clamp(n: Float, min min_bound: Float, max max_bound: Float) -> Float``

Restricts a `Float` between a lower and upper bound.

Examples

``````> clamp(1.2, min: 1.4, max: 1.6)
1.4
``````

compare

</>
``pub fn compare(a: Float, with b: Float) -> Order``

Compares two `Float`s, returning an order.

Examples

``````> compare(2.0, 2.3)
Lt
``````

floor

</>
``pub fn floor(float: Float) -> Float``

Rounds the value to the next lowest whole number as a `Float`.

Examples

``````> floor(2.3)
2.0
``````

loosely_compare

</>
``pub fn loosely_compare(a: Float, with b: Float, tolerating tolerance: Float) -> Order``

Compares two `Float`s within a tolerance. Keep in mind that as this are floats the tolerance won’t be exact e.g. 5.3 - 5.0 is not exactly 0.3 in a float

Examples

``````> loosely_compare(5.0, with: 5.3, tolerating: 0.5)
Eq
``````

max

</>
``pub fn max(a: Float, b: Float) -> Float``

Compares two `Float`s, returning the larger of the two.

Examples

``````> max(2.0, 2.3)
2.3
``````

min

</>
``pub fn min(a: Float, b: Float) -> Float``

Compares two `Float`s, returning the smaller of the two.

Examples

``````> min(2.0, 2.3)
2.0
``````

negate

</>
``pub fn negate(x: Float) -> Float``

Returns the negative of the value provided.

Examples

``````> negate(1.)
-1.
``````

parse

</>
``pub fn parse(string: String) -> Result(Float, Nil)``

Attempts to parse a string as a `Float`, returning `Error(Nil)` if it was not possible.

Examples

``````> parse("2.3")
Ok(2.3)

> parse("ABC")
Error(Nil)
``````

power

</>
``pub fn power(base: Float, exponent: Float) -> Float``

Returns the results of the base being raised to the power of the exponent, as a `Float`.

Examples

``````> power(2.0, 2.0)
4.0

> power(8.0, 1.5)
22.627416997969522
``````

product

</>
``pub fn product(numbers: List(Float)) -> Float``

Multiplies a list of `Float`s and returns the product.

Example

``````> product([2.5, 3.2, 4.2])
33.6
``````

round

</>
``pub fn round(float: Float) -> Int``

Rounds the value to the nearest whole number as an `Int`.

Examples

``````> round(2.3)
2

> round(2.5)
3
``````

square_root

</>
``pub fn square_root(number: Float) -> Result(Float, Nil)``

Returns the square root of the input as a `Float`.

Examples

``````> square_root(4.0)
Ok(2.0)

> square_root(-16.0)
Error(Nil)
``````

sum

</>
``pub fn sum(numbers: List(Float)) -> Float``

Sums a list of `Float`s.

Example

``````> sum([1.0, 2.2, 3.3])
6.5
``````

to_string

</>
``pub fn to_string(f: Float) -> String``

Returns the string representation of the provided `Float`.

Examples

``````> to_string(2.3)
"2.3"
``````

truncate

</>
``pub fn truncate(float: Float) -> Int``

Returns the value as an `Int`, truncating all decimal digits.

Examples

``````> truncate(2.4343434847383438)
2
``````