Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PFunction<R, C, N>

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

  • new PFunction(__namedParameters: { name: undefined | string; nargs: undefined | N; unit: C; vars: string[] }): PFunction

  • Parameters

    • __namedParameters: { name: undefined | string; nargs: undefined | N; unit: C; vars: string[] }
      • name: undefined | string
      • nargs: undefined | N
      • unit: C
      • vars: string[]

    Returns PFunction

Properties

Optional f_

f_: IPCompiled<R, C, N>

Readonly name

name: string

Name of this PFunction, for disambiguation and well-known functions (such as constants).

Readonly nargs

nargs: N

Optional tex_

tex_: undefined | string

Cached LaTeX string

timestep

timestep: number = TIMESTEP

The time step to be used for numerical integration. Ignored for functions with a defined analytic integral.

Readonly unit

unit: C

Accessors

f

html

  • get html(): ViewOf<this> & Element

  • Produce HTML from the LaTeX representation. Produces a new HTML element on each reference, equivalent to:

    pFun.toHtml();

    Returns ViewOf<this> & Element

returnType

  • get returnType(): TYPE

tex

  • get tex(): string

  • Get the LaTeX representation of this function. The value is cached.

    Returns string

Methods

compile

Protected Abstract compileFn

equiv

  • equiv<T>(f: T): null | this | T

Private setName_

  • setName_(name: string): this

simplify

toHtml

  • toHtml(varName?: undefined | string, block?: undefined | false | true, ctx?: StyleContext): ViewOf<this> & Element

  • Produce HTML from the LaTeX representation. Produces a new HTML element on each call

    Parameters

    • Optional varName: undefined | string
    • Optional block: undefined | false | true
    • Default value ctx: StyleContext = DEFAULT_STYLE.context

    Returns ViewOf<this> & Element

toTex

  • Compute the LaTeX representation of this function.

    Parameters

    • Default value varName: string = "t"
    • Default value ctx: StyleContext = DEFAULT_STYLE.context

    Returns string

toTexWithUnits

  • toTexWithUnits(varName?: string, ctx?: StyleContext): string

Generated using TypeDoc