Class Period

This class provides a Period (length + TimeUnit) class and implements a limited algebra.

test self-consistency of algebra is checked.

Hierarchy

Period

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Period(): Period

- Defined in ql/time/period.ts:17
Returns Period

Properties

Private _length

_length: Integer = 0

Private _units

_units: TimeUnit

Methods

add

add(p: Period): Period

- Defined in ql/time/period.ts:264
Parameters
- p: Period
Returns Period

adda

adda(p: Period): void

- Defined in ql/time/period.ts:170
Parameters
- p: Period
Returns void

div

div(n: Integer): Period

- Defined in ql/time/period.ts:313
Parameters
- n: Integer
Returns Period

diva

diva(n: Integer): Period

- Defined in ql/time/period.ts:276
Parameters
- n: Integer
Returns Period

frequency

frequency(): Frequency

- Defined in ql/time/period.ts:81
Returns Frequency

init1

init1(n: Integer, units: TimeUnit): Period

- Defined in ql/time/period.ts:24
Parameters
- n: Integer
- units: TimeUnit
Returns Period

init2

init2(frequency: Frequency): Period

- Defined in ql/time/period.ts:31
Parameters
- frequency: Frequency
Returns Period

length

length(): Integer

- Defined in ql/time/period.ts:73
Returns Integer

normalize

normalize(): void

- Defined in ql/time/period.ts:126
Returns void

sub

sub(p: Period): Period

- Defined in ql/time/period.ts:270
Parameters
- p: Period
Returns Period

suba

suba(p: Period): void

- Defined in ql/time/period.ts:259
Parameters
- p: Period
Returns void

toString

toString(): string

- Defined in ql/time/period.ts:145
Returns string

units

units(): TimeUnit

- Defined in ql/time/period.ts:77
Returns TimeUnit

valueOf

valueOf(): Integer

- Defined in ql/time/period.ts:149
Returns Integer

Static days

days(p: Period): Real

- Defined in ql/time/period.ts:409
Parameters
- p: Period
Returns Real

Static daysMinMax

daysMinMax(p: Period): [Integer, Integer]

- Defined in ql/time/period.ts:337
Parameters
- p: Period
Returns [Integer, Integer]

Static equal

equal(p1: Period, p2: Period): boolean

- Defined in ql/time/period.ts:471
Parameters
- p1: Period
- p2: Period
Returns boolean

Static greaterOrEqual

greaterOrEqual(p1: Period, p2: Period): boolean

- Defined in ql/time/period.ts:483
Parameters
- p1: Period
- p2: Period
Returns boolean

Static greaterThan

greaterThan(p1: Period, p2: Period): boolean

- Defined in ql/time/period.ts:467
Parameters
- p1: Period
- p2: Period
Returns boolean

Static lessOrEqual

lessOrEqual(p1: Period, p2: Period): boolean

- Defined in ql/time/period.ts:479
Parameters
- p1: Period
- p2: Period
Returns boolean

Static lessThan

lessThan(p1: Period, p2: Period): boolean

- Defined in ql/time/period.ts:428
Parameters
- p1: Period
- p2: Period
Returns boolean

Static months

months(p: Period): Real

- Defined in ql/time/period.ts:371
Parameters
- p: Period
Returns Real

Static mulScalar

mulScalar(p: Period, n: Integer): Period

- Defined in ql/time/period.ts:487
Parameters
- p: Period
- n: Integer
Returns Period

Static notEqual

notEqual(p1: Period, p2: Period): boolean

- Defined in ql/time/period.ts:475
Parameters
- p1: Period
- p2: Period
Returns boolean

Static weeks

weeks(p: Period): Real

- Defined in ql/time/period.ts:390
Parameters
- p: Period
Returns Real

Static years

years(p: Period): Real

- Defined in ql/time/period.ts:352
Parameters
- p: Period
Returns Real