Class ScalarConstant<C, N>

Scalar constants

Type parameters

C: Unit
N: ArgCount

Hierarchy

PCalculus<number, C, Divide<C, time>, Multiply<C, time>>
- ScalarConstant

Implements

IPFunctionBase<number, C, N>
IPFunctionCalculus<number, C, 1, Divide<C, time>, Multiply<C, time>>
Value<number, C>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ScalarConstant(value: number, unit: C): ScalarConstant

Overrides PCalculus.constructor
- Defined in src/scalar.ts:29
Parameters
- value: number
- unit: C
Returns ScalarConstant

Properties

Optional f_

f_: IPCompiled<number, 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

Readonly value

value: number

Accessors

f

get f(): IPCompiled<number, C, N>

Inherited from PFunction.f
- Defined in src/pfunction.ts:65
The implementing function

Returns IPCompiled<number, C, N>

html

get html(): ViewOf<this> & Element

Inherited from PFunction.html
- Defined in src/pfunction.ts:135
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(): SCALAR

Overrides PFunction.returnType
- Defined in src/scalar.ts:66
Returns SCALAR

tex

get tex(): string

Inherited from PFunction.tex
- Defined in src/pfunction.ts:105
Get the LaTeX representation of this function. The value is cached.

Returns string

Methods

compile

compile(): IPCompiled<number, C, N>

Implementation of IPFunctionCalculus.compile

Inherited from PFunction.compile
- Defined in src/pfunction.ts:69
Returns IPCompiled<number, C, N>

Protected compileFn

compileFn(): IPCompileResult<number>

Overrides PFunction.compileFn
- Defined in src/scalar.ts:36
Returns IPCompileResult<number>

derivative

derivative(): IPFunctionCalculus<number, Divide<C, time>, 1, Divide<Divide<C, time>, time>, C>

Implementation of IPFunctionCalculus.derivative

Inherited from PCalculus.derivative
- Defined in src/pfunction.ts:199
Returns IPFunctionCalculus<number, Divide<C, time>, 1, Divide<Divide<C, time>, time>, C>

differentiate

differentiate(): ScalarConstant<Divide<C, time>> & IPFunctionCalculus<number, Divide<C, time>, 1, Multiply<C, time>, C>

Overrides PCalculus.differentiate
- Defined in src/scalar.ts:51
Returns ScalarConstant<Divide<C, time>> & IPFunctionCalculus<number, Divide<C, time>, 1, Multiply<C, time>, C>

equiv

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

Implementation of IPFunctionCalculus.equiv

Overrides PFunction.equiv
- Defined in src/scalar.ts:70
Type parameters
- T
Parameters
- f: T
Returns null | this | T

integral

integral(): IndefiniteIntegral<number, Multiply<C, time>, C>

Implementation of IPFunctionCalculus.integral

Inherited from PCalculus.integral
- Defined in src/pfunction.ts:211
Return the indefinite integral of this function.

Returns IndefiniteIntegral<number, Multiply<C, time>, C>

integrate

integrate(): IndefiniteIntegral<number, Multiply<C, time>, C>

Overrides PCalculus.integrate
- Defined in src/scalar.ts:59
Returns IndefiniteIntegral<number, Multiply<C, time>, C>

Private setName_

setName_(name: string): this

Inherited from PFunction.setName_
- Defined in src/pfunction.ts:146
Set a name of the function

Parameters
- name: string
Returns this

simplify

simplify(options?: any): IPFunctionBase<number, C, N>

Implementation of IPFunctionCalculus.simplify

Inherited from PFunction.simplify
- Defined in src/pfunction.ts:163
Parameters
- Default value options: any = {}
Returns IPFunctionBase<number, C, N>

toHtml

toHtml(varName?: Variable, block?: boolean, ctx?: StyleContext): ViewOf<this> & Element

Inherited from PFunction.toHtml
- Defined in src/pfunction.ts:115
Produce HTML from the LaTeX representation. Produces a new HTML element on each call

Parameters
- Default value varName: Variable = "t"
- Default value block: boolean = false
- Default value ctx: StyleContext = DEFAULT_STYLE.context
Returns ViewOf<this> & Element

toTex

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

Overrides PFunction.toTex
- Defined in src/scalar.ts:41
Parameters
- Default value varName: Variable = "t"
- Default value ctx: StyleContext = DEFAULT_STYLE.context
Returns string

toTexWithUnits

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

Overrides PFunction.toTexWithUnits
- Defined in src/scalar.ts:45
Parameters
- Default value varName: Variable = "t"
- Default value ctx: StyleContext = DEFAULT_STYLE.context
Returns string

Generated using TypeDoc