Class VarsHistory

Collects data from a VarsList and provides ways to print or access that data. The data is stored in a HistoryList with each entry being an array of numbers (a 'data sample') representing the value of the variables at a point in time.

The data is stored whenever memorize is called. As a Memorizable the VarsHistory can be connected to a MemoList such as SimRunner. In most myPhysicsLab apps the following commands entered in Terminal will set this up:

var hist = new VarsHistory(sim.getVarsList());
simRun.addMemo(hist);

To memorize the starting initial conditions, call the memorize function once before starting the simulation.

hist.memorize()

Run the simulation as long as desired. After the simulation run is completed, print the data:

hist.output()

The resulting text can then be copied from the Terminal text box, saved as a text document and imported into a spreadsheet program or graphed with a Python script.

The default separator between numbers is the tab character. To instead use comma separated values:

hist.setSeparator(', ')

To change which variables are sampled or the order of the variables within each sample use setVariables. For example:

hist.setVariables([9,0,1,2,3])

Note that setVariables erases all stored data, so you would need to call memorize afterwards to store initial conditions.

The default format for printing numbers gives 5 decimal places, but if the number is too small then switches to exponential format. Use setNumberFormat to change the formatting function. For example:

hist.setNumberFormat((n) => n.toFixed(2));

That example uses an arrow function but you can provide any function that takes one numeric argument and returns a string.

To process the data using Javascript use the toArray method

var a = hist.toArray()

Implements

Constructors

constructor

Properties

numberFormat separator varIndex_

Methods

getDataPoints getVariables memorize output reset setNumberFormat setSeparator setVariables toArray toString toStringShort

Constructors

constructor

Properties

numberFormat

numberFormat: ((n) => string) = Util.NF5E

number formatting function

Type declaration

    • (n): string

    • number formatting function

      Parameters

      • n: number

      Returns string

separator

separator: string = '\t'

separator between numbers

Private varIndex_

varIndex_: number[]

Set of index numbers into VarsList, specifies which variables to memorize.

Methods

getDataPoints

getVariables

  • getVariables(): number[]

  • Returns the array of variable index numbers specifying which variables to remember.

    Returns number[]

    array of variable index numbers specifying which variables to remember

memorize

output

  • output(opt_localized?): string

  • Returns string form of the data points. One line for each sample, using the number formatting function and text separator specified by the properties numberFormat and separator.

    Parameters

    • Optional opt_localized: boolean

      true means print the localized versions of the variable names; false means print the language independent variable names; default is true

    Returns string

reset

setNumberFormat

  • setNumberFormat(numberFormatFn): void

  • Parameters

    • numberFormatFn: ((n) => string)

      the number formatting function; takes one numeric argument, returns a string.

        • (n): string

        • Parameters

          • n: number

          Returns string

    Returns void

setSeparator

  • setSeparator(separator): void

  • Set the separator string to print between numbers

    Parameters

    • separator: string

      the separator string to print between numbers. Default is a comma and space.

    Returns void

setVariables

  • setVariables(varIndex): void

  • Sets the array of variable index numbers specifying which variables to memorize. This calls reset which erases all stored data.

    Parameters

    • varIndex: number[]

      array of variable index numbers specifying which variables to memorize

    Returns void

toArray

  • toArray(): number[][]

  • Returns arrays of the data points, one array for each sample.

    Returns number[][]

toString

toStringShort

  • toStringShort(): string

  • Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

    For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:

    DisplayShape{polygon:Polygon{'chain3'}}

    Returns string

    a minimal string representation of this object.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc