Class TimeBasket

Distribution over a number of dates

Hierarchy

Map<Natural, Real>
- TimeBasket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TimeBasket(dates: Date[], values: Real[]): TimeBasket

- Defined in ql/cashflows/timebasket.ts:10
Parameters
- dates: Date[]
- values: Real[]
Returns TimeBasket

Properties

[Symbol.toStringTag]

[Symbol.toStringTag]: string

size

size: number

Static Map

Map: MapConstructor

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[Natural, Real]>

Inherited from TimeBasket.[Symbol.iterator]
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[Natural, Real]>

adda

adda(other: TimeBasket): TimeBasket

- Defined in ql/cashflows/timebasket.ts:25
Parameters
- other: TimeBasket
Returns TimeBasket

clear

clear(): void

Inherited from TimeBasket.clear
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.collection.d.ts:22
Returns void

delete

delete(key: Natural): boolean

Inherited from TimeBasket.delete
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters
- key: Natural
Returns boolean

entries

entries(): IterableIterator<[Natural, Real]>

Inherited from TimeBasket.entries
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[Natural, Real]>

forEach

forEach(callbackfn: (value: Real, key: Natural, map: Map<Natural, Real>) => void, thisArg?: any): void

Inherited from TimeBasket.forEach
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.collection.d.ts:24
Parameters
- callbackfn: (value: Real, key: Natural, map: Map<Natural, Real>) => void
  - - (value: Real, key: Natural, map: Map<Natural, Real>): void
    - Parameters
      - value: Real
      - key: Natural
      - map: Map<Natural, Real>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: Natural): Real | undefined

Inherited from TimeBasket.get
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.collection.d.ts:25
Parameters
- key: Natural
Returns Real | undefined

has

has(key: Natural): boolean

Inherited from TimeBasket.has
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: Natural
Returns boolean

hasDate

hasDate(d: Date): boolean

- Defined in ql/cashflows/timebasket.ts:21
Parameters
- d: Date
Returns boolean

keys

keys(): IterableIterator<Natural>

Inherited from TimeBasket.keys
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
Returns an iterable of keys in the map

Returns IterableIterator<Natural>

rebin

rebin(buckets: Date[]): TimeBasket

- Defined in ql/cashflows/timebasket.ts:39
Parameters
- buckets: Date[]
Returns TimeBasket

set

set(key: Natural, value: Real): this

Inherited from TimeBasket.set
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.collection.d.ts:27
Parameters
- key: Natural
- value: Real
Returns this

suba

suba(other: TimeBasket): TimeBasket

- Defined in ql/cashflows/timebasket.ts:32
Parameters
- other: TimeBasket
Returns TimeBasket

values

values(): IterableIterator<Real>

Inherited from TimeBasket.values
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
Returns an iterable of values in the map

Returns IterableIterator<Real>