mayo v0.1.0 Mayo.Number

Summary

Functions

Check if the number is even

Checks the maximum value of a number

Checks the minimum value of a number

Checks if the number is negative

Check if the number is odd

Checks if the number is positive

Functions

even(value)

Check if the number is even.

iex> Mayo.Number.even(2)
2

iex> Mayo.Number.even(1)
{:error, %Mayo.Error{type: "number.even"}}
max(value, limit)

Checks the maximum value of a number.

iex> Mayo.Number.max(4, 5)
4

iex> Mayo.Number.max(6, 5)
{:error, %Mayo.Error{type: "number.max"}}
min(value, limit)

Checks the minimum value of a number.

iex> Mayo.Number.min(4, 3)
4

iex> Mayo.Number.min(1, 3)
{:error, %Mayo.Error{type: "number.min"}}
negative(value)

Checks if the number is negative.

iex> Mayo.Number.negative(-2)
-2

iex> Mayo.Number.negative(0)
0

iex> Mayo.Number.negative(2)
{:error, %Mayo.Error{type: "number.negative"}}
odd(value)

Check if the number is odd.

iex> Mayo.Number.odd(1)
1

iex> Mayo.Number.odd(2)
{:error, %Mayo.Error{type: "number.odd"}}
positive(value)

Checks if the number is positive.

iex> Mayo.Number.positive(2)
2

iex> Mayo.Number.positive(0)
0

iex> Mayo.Number.positive(-2)
{:error, %Mayo.Error{type: "number.positive"}}