Class Interval

A connected set represented by its endpoints lowerBound and upperBound.

Remarks

Consider using the aliases described down below instead of specifying bound inclusion by hand.

Some common intervals are already defined like Real and NonNegative.

All intervals can be constructed with a NumberTransform that can be used to

include sanity checks like Number.isSafeInteger(x) (think of them as type constraints)
actually transform the bounds, for example clamping the values to nonnegative numbers

The NumberTransform is propagated by all functions returning Interval or NumberSet using the NumberTransform from the called Interval.

Note: If your NumberTransform throws then all functions that use it can throw as well!
Note: The NumberTransform should be idempotent!

Aliases:

Hierarchy

Interval

Index

Constructors

constructor

new Interval(__namedParameters: {
    lowerBound: number;
    lowerBoundIncluded: boolean;
    numberTransform?: NumberTransform;
    upperBound: number;
    upperBoundIncluded: boolean;
}): Interval
Parameters
- __namedParameters: {
      lowerBound: number;
      lowerBoundIncluded: boolean;
      numberTransform?: NumberTransform;
      upperBound: number;
      upperBoundIncluded: boolean;
  }
  - lowerBound: number
  - lowerBoundIncluded: boolean
  - Optional numberTransform?: NumberTransform
  - upperBound: number
  - upperBoundIncluded: boolean
Returns Interval
- Defined in src/Interval.ts:45

Properties

`Readonly` lowerBound

lowerBound: number

`Readonly` lowerBoundIncluded

lowerBoundIncluded: boolean

`Readonly` numberTransform

numberTransform: NumberTransform

`Readonly` upperBound

upperBound: number

`Readonly` upperBoundIncluded

upperBoundIncluded: boolean

`Static` `Readonly` BottomClosed

BottomClosed: ((lowerBound: number, upperBound: number, numberTransform?: NumberTransform) => Interval) = ...

Type declaration

- (lowerBound: number, upperBound: number, numberTransform?: NumberTransform): Interval
- See Interval for more information
  
  Returns
  [lowerBound,upperBound)
  Parameters
  - lowerBound: number
  - upperBound: number
  - Optional numberTransform: NumberTransform
  Returns Interval

`Static` `Readonly` BottomOpen

BottomOpen: ((lowerBound: number, upperBound: number, numberTransform?: NumberTransform) => Interval) = ...

Type declaration

- (lowerBound: number, upperBound: number, numberTransform?: NumberTransform): Interval
- Same as TopClosed See Interval for more information
  
  Returns
  (lowerBound,upperBound]
  Parameters
  - lowerBound: number
  - upperBound: number
  - Optional numberTransform: NumberTransform
  Returns Interval

`Static` `Readonly` Closed

Closed: ((lowerBound: number, upperBound: number, numberTransform?: NumberTransform) => Interval) = ...

Type declaration

- (lowerBound: number, upperBound: number, numberTransform?: NumberTransform): Interval
- See Interval for more information
  
  Returns
  [lowerBound,upperBound]
  Parameters
  - lowerBound: number
  - upperBound: number
  - Optional numberTransform: NumberTransform
  Returns Interval

`Static` `Readonly` Open

Open: ((lowerBound: number, upperBound: number, numberTransform?: NumberTransform) => Interval) = ...

Type declaration

- (lowerBound: number, upperBound: number, numberTransform?: NumberTransform): Interval
- See Interval for more information
  
  Returns
  (lowerBound,upperBound)
  Parameters
  - lowerBound: number
  - upperBound: number
  - Optional numberTransform: NumberTransform
  Returns Interval

`Static` `Readonly` TopClosed

TopClosed: ((lowerBound: number, upperBound: number, numberTransform?: NumberTransform) => Interval) = ...

Type declaration

- (lowerBound: number, upperBound: number, numberTransform?: NumberTransform): Interval
- See Interval for more information
  
  Returns
  (lowerBound,upperBound]
  Parameters
  - lowerBound: number
  - upperBound: number
  - Optional numberTransform: NumberTransform
  Returns Interval

`Static` `Readonly` TopOpen

TopOpen: ((lowerBound: number, upperBound: number, numberTransform?: NumberTransform) => Interval) = ...

Type declaration

- (lowerBound: number, upperBound: number, numberTransform?: NumberTransform): Interval
- Same as BottomClosed See Interval for more information
  
  Returns
  [lowerBound,upperBound)
  Parameters
  - lowerBound: number
  - upperBound: number
  - Optional numberTransform: NumberTransform
  Returns Interval

Methods

center

center(): number
Returns
The Interval's center(midpoint) if it exists and NaN if the Interval is empty

Returns number
- Defined in src/Interval.ts:420

closure

closure(): Interval
Returns
The Interval's closure (the Interval with its endpoints included) if it's not empty, the Interval itself otherwise

Returns Interval
- Defined in src/Interval.ts:385

contains

contains(x: number): boolean
Returns
True if x is included in this Interval
Parameters
- x: number
  
  Number to search for
Returns boolean
- Defined in src/Interval.ts:177

diameter

diameter(): number
Returns
The Interval's diameter(/length/width)

Returns number
- Defined in src/Interval.ts:400

equals

equals(other: Interval): boolean
Returns
True if the Intervals represent the same set
Parameters
- other: Interval
  
  Interval to compare to
Returns boolean
- Defined in src/Interval.ts:162

interior

interior(): Interval
Returns
The Interval's interior (the Interval without its endpoints)

Returns Interval
- Defined in src/Interval.ts:372

intersection

intersection(other: Interval): Interval
Returns
The overlap of both Intervals, e.g. a new Interval containing all elements included in both of the source Intervals
Parameters
- other: Interval
  
  Interval to intersect with
Returns Interval
- Defined in src/Interval.ts:284

intersects

intersects(other: Interval): boolean
Returns
True if the Intervals overlap, e.g. their intersection is not the empty set
Parameters
- other: Interval
  
  Interval to check for overlap
Returns boolean
- Defined in src/Interval.ts:261

isEmpty

isEmpty(): boolean
Returns
True if this Interval equals an empty set

Returns boolean
- Defined in src/Interval.ts:149

radius

radius(): number
Returns
The Interval's radius(diameter/2)

Returns number
- Defined in src/Interval.ts:411

scaledBy

scaledBy(factor: number): Interval
Example
```
Interval.Closed(0,1).scaleBy(-2) // "[-2,0]"
```
Returns
The Interval scaled by the factor

Throws
RangeError if factor === Infinity or factor === -Infinity
Parameters
- factor: number
  
  scale factor
Returns Interval
- Defined in src/Interval.ts:454

symDiff

symDiff(other: Interval): NumberSet
Returns
The symmetric difference of both Intervals, e.g. a new Interval containing all elements included in exactly one of the Intervals
Parameters
- other: Interval
Returns NumberSet
- Defined in src/Interval.ts:360

toSet

toSet(): NumberSet
Returns
NumberSet equivalent to this Interval

Returns NumberSet
- Defined in src/Interval.ts:141

toString

toString(): string
Transforms the Interval to its string representation using square brackets for included and parentheses for excluded endpoints

Example
```
console.log(Interval.BottomClosed(0,1)) // "[0,1)"
```
Returns
This interval's string representation
Returns string
- Defined in src/Interval.ts:75

touches

touches(other: Interval): boolean
Returns
True if the Interval's union is connected, e.g. their union is an interval
Parameters
- other: Interval
  
  Interval
Returns boolean
- Defined in src/Interval.ts:240

translatedBy

translatedBy(offset: number): Interval
Returns
The Interval translated by the offset
Parameters
- offset: number
  
  offset to apply to the Interval
Returns Interval
- Defined in src/Interval.ts:432

union

union(other: Interval): NumberSet
Returns
The union of both Intervals, e.g. a new Interval containing all elements included in either of the source Intervals
Parameters
- other: Interval
  
  Interval to merge with
Returns NumberSet
- Defined in src/Interval.ts:190

without

without(other: Interval): NumberSet
Returns
The difference of both Intervals, e.g. a new Interval containing all elements included in this and not in other
Parameters
- other: Interval
  
  Interval to subtract
Returns NumberSet
- Defined in src/Interval.ts:332

`Static` `Readonly` Point

Point(x: number, numberTransform?: NumberTransform): Interval
See Interval for more information

Returns
[x,x]
Parameters
- x: number
- Optional numberTransform: NumberTransform
Returns Interval
- Defined in src/Interval.ts:528

`Static` fromString

fromString(s: string, numberTransform?: NumberTransform): Interval
Constructs an Interval from a string representation

Remarks
Included endpoints are denoted by square brackets and excluded ones by either parentheses or reversed square brackets. Prefer constructing directly from number values instead of strings if possible

Example
```
Interval.fromString("[0,1)").equals(Interval.BottomClosed(0,1)) // true
Interval.fromString("[0,1[").equals(Interval.fromString("[0,1)")) // true
```
Returns
Interval corresponding to the string representation

Throws
ParseError if s is malformed
Parameters
- s: string
  
  String representation of the Interval
- Optional numberTransform: NumberTransform
  
  See Interval for more information
Returns Interval
- Defined in src/Interval.ts:100

Class Interval

Remarks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { lowerBound: number; lowerBoundIncluded: boolean; numberTransform?: NumberTransform; upperBound: number; upperBoundIncluded: boolean; }

lowerBound: number

lowerBoundIncluded: boolean

Optional numberTransform?: NumberTransform

upperBound: number

upperBoundIncluded: boolean

Returns Interval

Properties

Readonly lowerBound

Readonly lowerBoundIncluded

Readonly numberTransform

Readonly upperBound

Readonly upperBoundIncluded

Static Readonly BottomClosed

Type declaration

Returns

Parameters

lowerBound: number

upperBound: number

Optional numberTransform: NumberTransform

Returns Interval

Static Readonly BottomOpen

Type declaration

Returns

Parameters

lowerBound: number

upperBound: number

Optional numberTransform: NumberTransform

Returns Interval

Static Readonly Closed

Type declaration

Returns

Parameters

lowerBound: number

upperBound: number

Optional numberTransform: NumberTransform

Returns Interval

Static Readonly Open

Type declaration

Returns

Parameters

lowerBound: number

upperBound: number

Optional numberTransform: NumberTransform

Returns Interval

Static Readonly TopClosed

Type declaration

Returns

Parameters

lowerBound: number

upperBound: number

Optional numberTransform: NumberTransform

Returns Interval

Static Readonly TopOpen

Type declaration

Returns

Parameters

lowerBound: number

upperBound: number

Optional numberTransform: NumberTransform

Returns Interval

Methods

center

Returns

Returns number

closure

Returns

Returns Interval

contains

Returns

__namedParameters: {
lowerBound: number;
lowerBoundIncluded: boolean;
numberTransform?: NumberTransform;
upperBound: number;
upperBoundIncluded: boolean;
}

`Optional` numberTransform?: NumberTransform

`Readonly` lowerBound

`Readonly` lowerBoundIncluded

`Readonly` numberTransform

`Readonly` upperBound

`Readonly` upperBoundIncluded

`Static` `Readonly` BottomClosed

`Optional` numberTransform: NumberTransform

`Static` `Readonly` BottomOpen

`Optional` numberTransform: NumberTransform

`Static` `Readonly` Closed

`Optional` numberTransform: NumberTransform

`Static` `Readonly` Open

`Optional` numberTransform: NumberTransform

`Static` `Readonly` TopClosed

`Optional` numberTransform: NumberTransform

`Static` `Readonly` TopOpen

`Optional` numberTransform: NumberTransform

`Static` `Readonly` Point