Interface IPFunctionCalculus<R, U, N, D, I>

Type parameters

R: BaseValueRelative
U: Unit = Unit
N: ArgCount = 1
D: Unit = Divide<U, time>
I: Unit = Multiply<U, time>

Hierarchy

IPFunctionBase<R, U, N>
IPCalculus<R, U, D, I>
- IPFunctionCalculus
  - IndefiniteIntegral

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

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

Inherited from IPFunctionBase.compile
- Defined in src/base.ts:253
Returns IPCompiled<R, U, N, IPFunction<R, U, N, Divide<U, Unit<CompleteTerms<{ time: 1 }>>>, Multiply<U, Unit<CompleteTerms<{ time: 1 }>>>>>

derivative

derivative(): IPFunctionCalculus<R, D, 1, Divide<D, Unit<CompleteTerms<{ time: 1 }>>>, U>

Inherited from IPCalculus.derivative
- Defined in src/base.ts:349
Returns the derivative of this IPFunction

Returns IPFunctionCalculus<R, D, 1, Divide<D, Unit<CompleteTerms<{ time: 1 }>>>, U>

equiv

equiv<T>(f: T): null | IPFunctionCalculus<R, U, N, D, I> | T

Inherited from IPFunctionBase.equiv
- Defined in src/base.ts:293
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 | IPFunctionCalculus<R, U, N, D, I> | T

integral

integral(): IndefiniteIntegral<R, I, U, Multiply<I, Unit<CompleteTerms<{ time: 1 }>>>>

Inherited from IPCalculus.integral
- Defined in src/base.ts:365
Returns the integral of this IPFunction.

Returns IndefiniteIntegral<R, I, U, Multiply<I, Unit<CompleteTerms<{ time: 1 }>>>>

simplify

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

Inherited from IPFunctionBase.simplify
- Defined in src/base.ts:301
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?: string, block?: boolean, ctx?: StyleContext): ViewOf<IPFunctionBase<R, U, N>> & Element

Inherited from IPFunctionBase.toHtml
- Defined in src/base.ts:281
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

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

Inherited from IPFunctionBase.toTex
- Defined in src/base.ts:260
Compute the LaTeX representation of this function.

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

toTexWithUnits

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

Inherited from IPFunctionBase.toTexWithUnits
- Defined in src/base.ts:267
Compute the LaTeX representation of this function including units.

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

Generated using TypeDoc