Class Batch

Hierarchy

Batch

Index

Constructors

Properties

pars runStatuses solutions tEnd tStart

Accessors

errors successfulVaryingParams

Methods

compute extreme run valueAtTime

Constructors

constructor

new Batch(run: singleBatchRun, pars: BatchPars, tStart: number, tEnd: number, nPointsForExtremes?: number): Batch
Construct a batch run, which will run the model many times
Parameters
- run: singleBatchRun
- pars: BatchPars
  
  Parameters of the model, and information about the one to vary. Most easily generated with batchParsRange or batchParsDisplace.
- tStart: number
  
  Start of the integration (often 0)
- tEnd: number
  
  End of the integration (must be greater than tStart)
- nPointsForExtremes: number = 501
  
  Number of points to use when computing extremes. Larger numbers will be more accurate.
Returns Batch

Properties

`Readonly` pars

pars: BatchPars

The parameters used for this batch run

`Readonly` runStatuses

runStatuses: RunStatus[]

An array of objects recording success/failure of each run, along with any error message

`Readonly` solutions

solutions: InterpolatedSolution[]

An array of solutions

`Readonly` tEnd

tEnd: number

The end time of the solution

`Readonly` tStart

tStart: number

The start time of the solution

Accessors

errors

get errors(): RunStatus[]
Returns only those run statuses which are failures

Returns RunStatus[]

successfulVaryingParams

get successfulVaryingParams(): UserType[]
Returns those varying parameter values which successfully ran. The array returned should correspond by index to the solutions in the result

Returns UserType[]

Methods

compute

compute(): boolean
Compute the next parameter set in the batch. If all have been computed, the method will return very quickly but not error.

Returns
true if all parameter sets have been computed, false otherwise.

Returns boolean

extreme

extreme(name: keyof Extremes<UserTypeSeriesSet>): UserTypeSeriesSet
Return one of the extremes
Parameters
- name: keyof Extremes<UserTypeSeriesSet>
  The name of the extreme to look up; one of
  - "yMin": The minimum value of each series
  - "yMax": The maximum value of each series
  - "tMin": The time that each series reached its minimum
  - "tMax": The time that each series reached its maximum
Returns UserTypeSeriesSet

run

run(): void
Convenience function for computing all parameter sets in one blocking loop.

Returns void

valueAtTime

valueAtTime(time: number): UserTypeSeriesSet
Compute an the value of each series at a particular point in the solution
Parameters
- time: number
  
  The time; you can use -Infinity and Infinity to represent the beginning and end of the solution
Returns UserTypeSeriesSet

Generated using TypeDoc