Interface ComparableSystem<TData>

Interface which extends System by adding functionality to compare system state with observed data.

interface ComparableSystem<TData> {
    state: Readonly<SystemState>;
    time: number;
    compareData(data: TData | TData[]): NdArray;
    runToTime(time: number): void;
    setStateInitial(): void;
}

Type Parameters

  • TData

    Type of each data point which will be compared with system state.

Hierarchy (View Summary)

Implemented by

Properties

state: Readonly<SystemState>

The current state of each particle in the system

time: number

The current time in the system

Methods

  • Compares the state of all particles in the syatem with observed data, and returns an NdArray of log likelihoods of each particle state given the data, where the NdArray has shape [nGroups, nParticles]

    Parameters

    • data: TData | TData[]

      Observed data to compare against system state

    Returns NdArray

  • Runs the system from its current time to the given time, causing its state to be updated

    Parameters

    • time: number

      The time to run to

    Returns void