Class ScalarConstant<C>

Scalar constants

Type parameters

C: Unit = Unit

Hierarchy

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

Implements

Value<number, C>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Inherited from PCalculus.constructor
- Defined in src/scalar.ts:29
Type parameters
- C: Unit<UnitTerms, C> = Unit<UnitTerms>
Parameters
- value: number
- unit: C
Returns ScalarConstant<C>

Properties

Optional f_

f_: undefined | IPCompiled<number, C, 1, IPFunctionCalculus<number, C, 1, Divide<C, Unit<CompleteTerms<{ time: 1 }>>>, Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>>>

Readonly name

name: string

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

Readonly nargs

nargs: 1

Optional tex_

tex_: undefined | string

Cached LaTeX string

timestep

timestep: number = ...

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<R, C, N, IPFunction<R, C, N, Divide<C, Unit<CompleteTerms<{ time: 1 }>>>, Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>>>

- Defined in src/pfunction.ts:65
The implementing function

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

html

get html(): ViewOf<this> & Element

- 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

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

tex

get tex(): string

- 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, 1, IPFunctionCalculus<number, C, 1, Divide<C, Unit<CompleteTerms<{ time: 1 }>>>, Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>>>

Inherited from PCalculus.compile
- Defined in src/pfunction.ts:69
Returns IPCompiled<number, C, 1, IPFunctionCalculus<number, C, 1, Divide<C, Unit<CompleteTerms<{ time: 1 }>>>, Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>>>

Protected compileFn

compileFn(): IPCompileResult1<number>

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

derivative

derivative(): IPFunctionCalculus<number, Divide<C, Unit<CompleteTerms<{ time: 1 }>>>, 1, Divide<Divide<C, Unit<CompleteTerms<{ time: 1 }>>>, Unit<CompleteTerms<{ time: 1 }>>>, C>

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

differentiate

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

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

equiv

equiv<T>(f: T): null | ScalarConstant<C> | T

Overrides PCalculus.equiv
- Defined in src/scalar.ts:70
Type parameters
- T
Parameters
- f: T
Returns null | ScalarConstant<C> | T

integral

integral(): IndefiniteIntegral<number, Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>, C, Multiply<Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>, Unit<CompleteTerms<{ time: 1 }>>>>

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

Returns IndefiniteIntegral<number, Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>, C, Multiply<Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>, Unit<CompleteTerms<{ time: 1 }>>>>

integrate

integrate(): IndefiniteIntegral<number, Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>, C, Multiply<Multiply<C, Unit<CompleteTerms<{ time: 1 }>>>, Unit<CompleteTerms<{ time: 1 }>>>>

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

Private setName_

setName_(name: string): ScalarConstant<C>

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

Parameters
- name: string
Returns ScalarConstant<C>

simplify

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

Inherited from PCalculus.simplify
- Defined in src/pfunction.ts:163
Parameters
- options: any = ...
Returns IPFunctionBase<number, C, 1>

toHtml

toHtml(varName?: string, block?: boolean, ctx?: StyleContext): ViewOf<ScalarConstant<C>> & Element

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

Parameters
- varName: string = 't'
- block: boolean = false
- ctx: StyleContext = ...
Returns ViewOf<ScalarConstant<C>> & Element

toTex

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

Implementation of Value.toTex

Overrides PCalculus.toTex
- Defined in src/scalar.ts:41
Parameters
- varName: string = 't'
- ctx: StyleContext = ...
Returns string

toTexWithUnits

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

Overrides PCalculus.toTexWithUnits
- Defined in src/scalar.ts:45
Parameters
- varName: string = 't'
- ctx: StyleContext = ...
Returns string

Generated using TypeDoc