Class Interval

Index

Constructors

Properties

Accessors

end length middle start

Methods

add addByNumber clone contains containsInterval expand includeInterval interpolate intersected intersection intersects isEqual isValid mul sub toString intersect invalid mul union

Constructors

constructor

new Interval(start, end): Interval
constructor
Parameters
- start: number
- end: number
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:29

Properties

`Private` _end

_end: any

`Private` _start

_start: any

Accessors

end

get end(): number
Get interval's end

Returns number
- Defined in packages/math/typings/base/Interval.d.ts:37

length

get length(): number
Get interval's length

Returns number
- Defined in packages/math/typings/base/Interval.d.ts:58

middle

get middle(): number
Get the middle number

Returns number
- Defined in packages/math/typings/base/Interval.d.ts:49

start

get start(): number
Get interval's start

Returns number
- Defined in packages/math/typings/base/Interval.d.ts:33

Methods

add

add(interval): Interval
interval add by number
Parameters
- interval: Interval
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:80

addByNumber

addByNumber(alpha): Interval
Parameters
- alpha: number
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:81

clone

clone(): Interval
Get the cloned object of this Interval.

Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:53

contains

contains(point, includeEnds, tolerance?): boolean
Indicates whether the given value is included in this interval.
Parameters
- point: number
- includeEnds: boolean
  Indicates whether to check the ends.
- Optional tolerance: number
  Tolerance to check on the ends.
Returns boolean
- Defined in packages/math/typings/base/Interval.d.ts:107

containsInterval

containsInterval(interval, includeEnds, tolerance?): boolean
Indicates whether the given interval is included in this interval.
Parameters
- interval: Interval
- includeEnds: boolean
  Indicates whether to check the ends.
- Optional tolerance: number
  Tolerance to check on the ends.
Returns boolean
- Defined in packages/math/typings/base/Interval.d.ts:115

expand

expand(length): Interval
Interval expand
Parameters
- length: number
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:99

includeInterval

includeInterval(interval): Interval
Combine with interval. If the intervals are not intersectant, we will return an invalid interval
Parameters
- interval: Interval
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:143

interpolate

interpolate(alpha): number
Interval interpolate
Parameters
- alpha: number
Returns number
- Defined in packages/math/typings/base/Interval.d.ts:93

intersected

intersected(interval, includeEnds, tolerance?): boolean
Indicates whether the given interval is intersected with this interval.
Parameters
- interval: Interval
- includeEnds: boolean
  Indicates whether to check the ends.
- Optional tolerance: number
  Intersection tolerance.
Returns boolean
- Defined in packages/math/typings/base/Interval.d.ts:131

intersection

intersection(interval): Interval
Get the intersect part with interval. If the intervals are not intersectant, we will return an invalid interval
Parameters
- interval: Interval
Returns Interval
| null
- Defined in packages/math/typings/base/Interval.d.ts:137

intersects

intersects(interval, includeEnds, tolerance?): boolean
Indicates whether the given interval is intersected with this interval.
Parameters
- interval: Interval
- includeEnds: boolean
  Indicates whether to check the ends.
- Optional tolerance: number
  Intersection tolerance.
Returns boolean
- Defined in packages/math/typings/base/Interval.d.ts:123

isEqual

isEqual(other, numTol?): boolean
Returns true if this interval is equal to another within specified tolerance.
Parameters
- other: Interval
- Optional numTol: number
Returns boolean
- Defined in packages/math/typings/base/Interval.d.ts:44

isValid

isValid(): boolean
Indicates whether the Interval is Valid

Returns boolean
- Defined in packages/math/typings/base/Interval.d.ts:68

mul

mul(alpha): Interval
interval mul by number
Parameters
- alpha: number
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:74

sub

sub(interval): Interval
interval sub by Interval
Parameters
- interval: Interval
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:87

toString

toString(): string
interval string

Returns string
- Defined in packages/math/typings/base/Interval.d.ts:63

`Static` intersect

intersect(intervals1, intervals2): Interval[]
Get the intersect intervals of two list of intervals.
Parameters
- intervals1: Interval[]
- intervals2: Interval[]
Returns Interval[]
List
- Defined in packages/math/typings/base/Interval.d.ts:15

`Static` invalid

invalid(): Interval
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:2

`Static` mul

mul(interval, alpha): Interval
interval mul by number
Parameters
- interval: Interval
- alpha: number
Returns Interval
- Defined in packages/math/typings/base/Interval.d.ts:8

`Static` union

union(intervals): Interval[]
Combine the intervals.Return the list of intervals after unioned
Parameters
- intervals: Interval[]
Returns Interval[]
- Defined in packages/math/typings/base/Interval.d.ts:21

Generated using TypeDoc