Class PkgWrapper

Hierarchy

PkgWrapper

Index

Constructors

Methods

getInternal getMetadata initial run setUser update random

Constructors

constructor

new PkgWrapper(Model: DustModelConstructable, pars: UserType, unusedUserAction: string, rng?: RngState): PkgWrapper

Parameters
- Model: DustModelConstructable
- pars: UserType
- unusedUserAction: string
- Optional rng: RngState
Returns PkgWrapper

Methods

getInternal

getInternal(): InternalStorage

Returns InternalStorage

getMetadata

getMetadata(): { info: DustModelInfo; names: string[]; size: number }

Returns { info: DustModelInfo; names: string[]; size: number }
- info: DustModelInfo
- names: string[]
- size: number

initial

initial(step: number): number[]

Parameters
- step: number
Returns number[]

run

run(step: number[], y: null | number[]): { size: number; y: number[] }

Parameters
- step: number[]
- y: null | number[]
Returns { size: number; y: number[] }
- size: number
- y: number[]

setUser

setUser(pars: UserType, unusedUserAction: string): void

Parameters
- pars: UserType
- unusedUserAction: string
Returns void

update

update(step: number, y: number[]): number[]

Parameters
- step: number
- y: number[]
Returns number[]

`Static` random

random(rng: RngState): Random

Parameters
- rng: RngState
Returns Random

Generated using TypeDoc