Interface IPFunctionBase<R, U, N>

Type parameters

R: BaseValue
U: Unit
N: ArgCount

Hierarchy

AnyIPFunction
- IPFunctionBase

Implemented by

Index

Properties

Methods

Properties

f

f: IPCompiled<R, U, N>

Readonly html

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

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

param

name

name: 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

timestep

timestep: number

Readonly unit

unit: U

Methods

compile

compile(): IPCompiled<R, U, N>

- Defined in src/base.ts:266
Returns IPCompiled<R, U, N>

equiv

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

- Defined in src/base.ts:314
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 | this | T

Private setName_

setName_(name: string): this

- Defined in src/base.ts:308
Set a name of the function

Parameters
- name: string
Returns this

simplify

simplify(options?: any): IPFunctionBase<R, U, N>

- Defined in src/base.ts:322
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

toHtml(varName?: undefined | string, block?: undefined | false | true, ctx?: StyleContext): ViewOf<IPFunctionBase<R, U, N>> & Element

- Defined in src/base.ts:294
Produce HTML from the LaTeX representation. Produces a new HTML element on each call

Parameters
- Optional varName: undefined | string
- Optional block: undefined | false | true
- Optional ctx: StyleContext
Returns ViewOf<IPFunctionBase<R, U, N>> & Element

toTex

toTex(varName?: undefined | string, ctx?: StyleContext): string

- Defined in src/base.ts:273
Compute the LaTeX representation of this function.

Parameters
- Optional varName: undefined | string
- Optional ctx: StyleContext
Returns string

toTexWithUnits

toTexWithUnits(varName?: undefined | string, ctx?: StyleContext): string

- Defined in src/base.ts:280
Compute the LaTeX representation of this function including units.

Parameters
- Optional varName: undefined | string
- Optional ctx: StyleContext
Returns string

Generated using TypeDoc