Range

Utilities for working with ranges.

A range represents an interval—a set of values with a beginning and an end.

All functions in this module treat ranges as exclusive, but inclusive versions of all APIs are available in the Inclusive submodule.

1

from "range" include Range

Values

Functions and constants included in the Range module.

Range.inRange

1

inRange : (value: Number, range: Range<Number>) => Bool

Checks if the given number is within the range.

Parameters:

Returns:

Examples:

1

Range.inRange(1, { rangeStart: 0, rangeEnd: 2 }) == true

1

Range.inRange(10, { rangeStart: 0, rangeEnd: 2 }) == false

Range.forEach

1

forEach : (fn: (Number => Void), range: Range<Number>) => Void

Calls the given function with each number in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Examples:

1

Range.forEach(val => print(val), { rangeStart: 0, rangeEnd: 2 })

Range.map

1

map : (fn: (Number => a), range: Range<Number>) => List<a>

Produces a list by calling the given function on each number included in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Returns:

Examples:

1

Range.map(val => val * 2, { rangeStart: 0, rangeEnd: 3 }) == [0, 2, 4]

Range.Inclusive

Values

Functions and constants included in the Range.Inclusive module.

Range.Inclusive.inRange

1

inRange : (value: Number, range: Range<Number>) => Bool

Checks if the given number is within the range.

Parameters:

Returns:

Examples:

1

Range.Inclusive.inRange(1, { rangeStart: 0, rangeEnd: 1 }) == true

1

Range.Inclusive.inRange(10, { rangeStart: 0, rangeEnd: 2 }) == false

Range.Inclusive.forEach

1

forEach : (fn: (Number => Void), range: Range<Number>) => Void

Calls the given function with each number in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Examples:

1

Range.Inclusive.forEach(val => print(val), { rangeStart: 0, rangeEnd: 2 })

Range.Inclusive.map

1

map : (fn: (Number => a), range: Range<Number>) => List<a>

Produces a list by calling the given function on each number included in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Returns:

Examples:

1

Range.Inclusive.map(val => val * 2, { rangeStart: 0, rangeEnd: 2 }) == [0, 2, 4]