Skip to main content
Version: Next

Range functions

A set of functions establish relationships between single scalar values and ranges of such values. All functions take two arguments and return true if the relationship between the argument holds, or false otherwise.

A scalar value must be of the following type:

  • number
  • date
  • time
  • date-time
  • days-time-duration
  • years-months-duration

range functions overview

before(point1, point2)​

Function signature

before(point1: Any, point2: Any): boolean

Examples

before(1, 10)
// true

before(10, 1)
// false

before(range, point)​

Function signature

before(range: range, point: Any): boolean

Examples

before([1..5], 10)
// true

before(point, range)​

Function signature

before(point: Any, range: range): boolean

Examples

before(1, [2..5])
// true

before(range1, range2)​

Function signature

before(range1: range, range2: range): boolean

Examples

before([1..5], [6..10])
// true

before([1..5),[5..10])
// true

after(point1, point2)​

Function signature

after(point1: Any, point2: Any): boolean

Examples

after(10, 1)
// true

after(1, 10)
// false

after(range, point)​

Function signature

after(range: range, point: Any): boolean

Examples

after([1..5], 10)
// false

after(point, range)​

Function signature

after(point: Any, range: range): boolean

Examples

after(12, [2..5])
// true

after(range1, range2)​

Function signature

after(range1: range, range2: range): boolean

Examples

after([6..10], [1..5])
// true

after([5..10], [1..5))
// true

meets(range1, range2)​

Function signature

meets(range1: range, range2: range): boolean

Examples

meets([1..5], [5..10])
// true

meets([1..3], [4..6])
// false

meets([1..3], [3..5])
// true

meets([1..5], (5..8])
// false

met by(range1, range2)​

Function signature

met by(range1: range, range2: range): boolean

Examples

met by([5..10], [1..5])
// true

met by([3..4], [1..2])
// false

met by([3..5], [1..3])
// true

met by((5..8], [1..5))
// false

met by([5..10], [1..5))
// false

overlaps(range1, range2)​

Function signature

overlaps(range1: range, range2: range): boolean

Examples

overlaps([5..10], [1..6])
// true

overlaps((3..7], [1..4])
// true

overlaps([1..3], (3..6])
// false

overlaps((5..8], [1..5))
// false

overlaps([4..10], [1..5))
// true

overlaps before(range1, range2)​

Function signature

overlaps before(range1: range, range2: range): boolean

Examples

overlaps before([1..5], [4..10])
// true

overlaps before([3..4], [1..2])
// false

overlaps before([1..3], (3..5])
// false

overlaps before([1..5), (3..8])
// true

overlaps before([1..5), [5..10])
// false

overlaps after(range1, range2)​

Function signature

overlaps after(range1: range, range2: range): boolean

Examples

overlaps after([4..10], [1..5])
// true

overlaps after([3..4], [1..2])
// false

overlaps after([3..5], [1..3))
// false

overlaps after((5..8], [1..5))
// false

overlaps after([4..10], [1..5))
// true

finishes(point, range)​

Function signature

finishes(point: Any, range: range): boolean

Examples

finishes(5, [1..5])
// true

finishes(10, [1..7])
// false

finishes(range1, range2)​

Function signature

finishes(range1: range, range2: range): boolean

Examples

finishes([3..5], [1..5])
// true

finishes((1..5], [1..5))
// false

finishes([5..10], [1..10))
// false

finished by(range, point)​

Function signature

finished by(range: range, point: Any): boolean

Examples

finished by([5..10], 10)
// true

finished by([3..4], 2)
// false

finished by(range1, range2)​

Function signature

finished by(range1: range, range2: range): boolean

Examples

finished by([1..5], [3..5])
// true

finished by((5..8], [1..5))
// false

finished by([5..10], (1..10))
// false

includes(range, point)​

Function signature

includes(range: range, point: Any): boolean

Examples

includes([5..10], 6)
// true

includes([3..4], 5)
// false

includes(range1, range2)​

Function signature

includes(range1: range, range2: range): boolean

Examples

includes([1..10], [4..6])
// true

includes((5..8], [1..5))
// false

includes([1..10], [1..5))
// true

during(point, range)​

Function signature

during(point: Any, range: range): boolean

Examples

during(5, [1..10])
// true

during(12, [1..10])
// false

during(1, (1..10])
// false

during(range1, range2)​

Function signature

during(range1: range, range2: range): boolean

Examples

during([4..6], [1..10))
// true

during((1..5], (1..10])
// true

starts(point, range)​

Function signature

starts(point: Any, range: range): boolean

Examples

starts(1, [1..5])
// true

starts(1, (1..8])
// false

starts(range1, range2)​

Function signature

starts(range1: range, range2: range): boolean

Examples

starts((1..5], [1..5])
// false

starts([1..10], [1..5])
// false

starts((1..5), (1..10))
// true

started by(range, point)​

Function signature

started by(range: range, point: Any): boolean

Examples

started by([1..10], 1)
// true

started by((1..10], 1)
// false

started by(range1, range2)​

Function signature

started by(range1: range, range2: range): boolean

Examples

started by([1..10], [1..5])
// true

started by((1..10], [1..5))
// false

started by([1..10], [1..10))
// true

coincides(point1, point2)​

Function signature

coincides(point1: Any, point2: Any): boolean

Examples

coincides(5, 5)
// true

coincides(3, 4)
// false

coincides(range1, range2)​

Function signature

coincides(range1: range, range2: range): boolean

Examples

coincides([1..5], [1..5])
// true

coincides((1..5], [1..5))
// false

coincides([1..5], [2..6])
// false