Namespace Interval

Copyright (c) 2017 mol* contributors, licensed under MIT, See LICENSE file for more info.

author: David Sehnal david.sehnal@gmail.com

Variables

Empty

Empty: <internal>.Interval

Functions

Const areEqual

areEqual<T>(a: <internal>.Interval<T>, b: <internal>.Interval<T>): boolean

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:36
Test if two intervals are identical

Type parameters
- T: number = number
Parameters
- a: <internal>.Interval<T>
- b: <internal>.Interval<T>
Returns boolean

Const areIntersecting

areIntersecting<T>(a: <internal>.Interval<T>, b: <internal>.Interval<T>): boolean

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:38
Test if two intervals are intersecting, i.e. their bounds overlap

Type parameters
- T: number = number
Parameters
- a: <internal>.Interval<T>
- b: <internal>.Interval<T>
Returns boolean

Const end

end<T>(interval: <internal>.Interval<T>): T

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:24
End value of the Interval, same as max + 1

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
Returns T

Const findPredecessorIndex

findPredecessorIndex<T>(interval: <internal>.Interval<T>, x: T): number

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:41
Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
- x: T
Returns number

Const findPredecessorIndexInInterval

findPredecessorIndexInInterval<T>(interval: <internal>.Interval<T>, x: T, bounds: <internal>.Interval<number>): number

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:42
Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
- x: T
- bounds: <internal>.Interval<number>
Returns number

Const findRange

findRange<T>(interval: <internal>.Interval<T>, min: T, max: T): <internal>.Interval<number>

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:43
Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
- min: T
- max: T
Returns <internal>.Interval<number>

Const getAt

getAt<T>(interval: <internal>.Interval<T>, i: number): T

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:20
Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
- i: number
Returns T

Const has

has<T>(interval: <internal>.Interval<T>, x: T): boolean

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:17
Test if a value is within the bounds of the interval

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
- x: T
Returns boolean

Const hashCode

hashCode<T>(interval: <internal>.Interval<T>): number

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:32
Hash code describing the interval

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
Returns number

Const indexOf

indexOf<T>(interval: <internal>.Interval<T>, x: T): number

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:19
Returns the index of x in set or -1 if not found.

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
- x: T
Returns number

Const intersect

intersect<T>(a: <internal>.Interval<T>, b: <internal>.Interval<T>): <internal>.Interval<T>

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:47
Get a new interval that is the intersection of the two intervals

Type parameters
- T: number = number
Parameters
- a: <internal>.Interval<T>
- b: <internal>.Interval<T>
Returns <internal>.Interval<T>

Const intersectionSize

intersectionSize<T>(a: <internal>.Interval<T>, b: <internal>.Interval<T>): number

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:45
Size of the intersection of the two intervals

Type parameters
- T: number = number
Parameters
- a: <internal>.Interval<T>
- b: <internal>.Interval<T>
Returns number

Const is

is<T>(v: any): v is <internal>.Interval<T>

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:15
Type parameters
- T: number = number
Parameters
- v: any
Returns v is <internal>.Interval<T>

Const isSubInterval

isSubInterval<T>(a: <internal>.Interval<T>, b: <internal>.Interval<T>): boolean

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:40
Test if interval b is fully included in interval a

Type parameters
- T: number = number
Parameters
- a: <internal>.Interval<T>
- b: <internal>.Interval<T>
Returns boolean

Const max

max<T>(interval: <internal>.Interval<T>): T

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:28
Max value of the Interval, same as end - 1

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
Returns T

Const min

min<T>(interval: <internal>.Interval<T>): T

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:26
Min value of the Interval, same as start value

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
Returns T

Const ofBounds

ofBounds<T>(start: T, end: T): <internal>.Interval<T>

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:12
Create interval from bounds [start, end), i.e. [start, end - 1]

Type parameters
- T: number = number
Parameters
- start: T
- end: T
Returns <internal>.Interval<T>

Const ofLength

ofLength<T>(length: T): <internal>.Interval<T>

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:14
Create interval from length [0, length), i.e. [0, length - 1]

Type parameters
- T: number = number
Parameters
- length: T
Returns <internal>.Interval<T>

Const ofRange

ofRange<T>(min: T, max: T): <internal>.Interval<T>

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:10
Create interval from range [min, max]

Type parameters
- T: number = number
Parameters
- min: T
- max: T
Returns <internal>.Interval<T>

Const ofSingleton

ofSingleton<T>(value: T): <internal>.Interval<T>

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:8
Type parameters
- T: number = number
Parameters
- value: T
Returns <internal>.Interval<T>

Const size

size<T>(interval: <internal>.Interval<T>): number

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:30
Number of values in the interval

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
Returns number

Const start

start<T>(interval: <internal>.Interval<T>): T

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:22
Start value of the Interval, same as min value

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
Returns T

Const toString

toString<T>(interval: <internal>.Interval<T>): string

- Defined in node_modules/molstar/lib/mol-data/int/interval.d.ts:34
String representation of the interval

Type parameters
- T: number = number
Parameters
- interval: <internal>.Interval<T>
Returns string

Generated using TypeDoc