Rational

Utilities for working with the Rational type.

1

from "rational" include Rational

1

1/2r

1

3/4r

Values

Functions and constants included in the Rational module.

Rational.fromNumber

1

fromNumber: (number: Number) => Rational

Converts a Number to a Rational.

Parameters:

Returns:

Rational.toNumber

1

toNumber: (rational: Rational) => Number

Converts a Rational to a Number.

Parameters:

Returns:

Rational.numerator

1

numerator: (x: Rational) => Number

Finds the numerator of the rational number.

Parameters:

Returns:

Rational.denominator

1

denominator: (x: Rational) => Number

Finds the denominator of the rational number.

Parameters:

Returns:

Rational.toIntegerRatio

1

toIntegerRatio: (x: Rational) => (Number, Number)

Gets the numerator and denominator of the rational.

Parameters:

Returns:

Examples:

1

Rational.toIntegerRatio(1/2r) == (1, 2)

1

Rational.toIntegerRatio(2/8r) == (1, 4)

Rational.fromIntegerRatio

1

fromIntegerRatio: (numerator: Number, denominator: Number) => Rational

Creates a rational from a numerator and denominator.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• If the numerator is not an integer
• If the denominator is not an integer

Examples:

1

Rational.fromIntegerRatio(1, 2) == 1/2r

1

Rational.fromIntegerRatio(2, 8) == 1/4r

Rational.(+)

1

(+): (x: Rational, y: Rational) => Rational

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (+) }
assert 1/2r + 1/4r == 3/4r

Rational.(-)

1

(-): (x: Rational, y: Rational) => Rational

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (-) }
assert 1/2r - 1/4r == 1/4r

Rational.(*)

1

(*): (x: Rational, y: Rational) => Rational

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (*) }
assert 1/2r * 1/4r == 1/8r

Rational.(/)

1

(/): (x: Rational, y: Rational) => Rational

Computes the quotient of its operands.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (/) }
assert 1/2r / 1/4r == 2/1r

Rational.(==)

1

(==): (x: Rational, y: Rational) => Bool

Checks if the first value is equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (==) }
assert 1/2r == 1/2r

Rational.(!=)

1

(!=): (x: Rational, y: Rational) => Bool

Checks if the first value is not equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (!=) }
assert 1/2r != 1/4r

Rational.(<)

1

(<): (x: Rational, y: Rational) => Bool

Checks if the first value is less than the second value.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (<) }
assert 1/4r < 1/2r

Rational.(>)

1

(>): (x: Rational, y: Rational) => Bool

Checks if the first value is greater than the second value.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (>) }
assert 1/2r > 1/4r

Rational.(<=)

1

(<=): (x: Rational, y: Rational) => Bool

Checks if the first value is less than or equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (<=) }
assert 1/4r <= 1/2r

1
2

use Rational.{ (<=) }
assert 1/2r <= 1/2r

Rational.(>=)

1

(>=): (x: Rational, y: Rational) => Bool

Checks if the first value is greater than or equal to the second value.

Parameters:

Returns:

Examples:

1
2

use Rational.{ (>=) }
assert 1/2r >= 1/4r

1
2

use Rational.{ (>=) }
assert 1/2r >= 1/2r