Range

Utilities for working with ranges. A range represents an interval—a set of values with a beginning and an end.

1

import Range from "range"

Types

Type declarations included in the Range module.

Range.Range

1
2
3
4

enum Range {
  Inclusive(Number, Number),
  Exclusive(Number, Number),
}

Ranges can be inclusive or exclusive. When Inclusive, the end value will be included in operations. When Exclusive, the end value will be excluded from operations.

Values

Functions and constants included in the Range module.

Range.inRange

1

inRange : (Number, Range) -> Bool

Checks if the given number is within the range.

Parameters:

Returns:

Examples:

1

Range.inRange(1, Range.Inclusive(0, 2)) == true

1

Range.inRange(10, Range.Inclusive(0, 2)) == false

Range.forEach

1

forEach : ((Number -> Void), Range) -> 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), Range.Exclusive(0, 2))

Range.map

1

map : ((Number -> a), Range) -> List<b>

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, Range.Inclusive(0, 2)) == [0, 2, 4]