Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPFunctionBase<R, U, N>

Type parameters

Hierarchy

Implemented by

Index

Properties

Methods

Properties

f

f: IPCompiled<R, U, N, IPFunction<R, U, N, Divide<U, Unit<CompleteTerms<{ time: 1 }>>>, Multiply<U, Unit<CompleteTerms<{ time: 1 }>>>>>

Readonly html

html: ViewOf<IPFunctionBase<R, U, N>> & Element

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

param

Optional Readonly name

name: undefined | string

nargs

nargs: N

Readonly returnType

returnType: TYPE

Readonly tex

tex: string

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

param

The parameter name (or expression)

Optional tex_

tex_: undefined | string

Optional Readonly timestep

timestep: undefined | number

Readonly unit

unit: U

Methods

compile

equiv

  • Determine if two functions are known to be equivalent. If so, returns the preferred one, otherwise null

    Type parameters

    • T

    Parameters

    • f: T

    Returns null | IPFunctionBase<R, U, N> | T

simplify

  • Return the simplest form of this function we are capable of. The notion of "simplest" is variable, such as whether to prefer factored forms or distribute the multiplications. These behaviors can be altered via the options argument.

    Parameters

    • Optional options: any

    Returns IPFunctionBase<R, U, N>

toHtml

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

    Parameters

    • Optional varName: string
    • Optional block: boolean
    • Optional ctx: StyleContext

    Returns ViewOf<IPFunctionBase<R, U, N>> & Element

toTex

  • Compute the LaTeX representation of this function.

    Parameters

    Returns string

toTexWithUnits

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

  • Compute the LaTeX representation of this function including units.

    Parameters

    Returns string

Generated using TypeDoc