Class Piecewise<R, C, D, I, N>

Type parameters

R: BaseValueRelative
C: Unit
D: Unit
I: Unit
N: ArgCount

Hierarchy

PCalculus<R, C, D, I>
- Piecewise

Implements

IPFunctionBase<R, C, N>
IPFunctionCalculus<R, C, 1, D, I>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Piecewise(unit: Unit, type?: TYPE): Piecewise

Overrides PCalculus.constructor
- Defined in src/piecewise.ts:40
Parameters
- unit: Unit
- Default value type: TYPE = unit.attributes.type || TYPE.SCALAR
Returns Piecewise

Properties

Optional f_

f_: IPCompiled<R, C, N>

Private functions

functions: IPFunctionCalculus<R, C, 1, D, I>[] = []

Readonly name

name: string

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

Readonly nargs

nargs: N

Private start_times

start_times: number[] = []

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.

Private Readonly type

type: TYPE

Readonly unit

unit: C

Accessors

f

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

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

Returns IPCompiled<R, C, N>

html

get html(): ViewOf<this> & Element

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

Overrides PFunction.returnType
- Defined in src/piecewise.ts:146
Returns TYPE

tex

get tex(): string

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

Returns string

Methods

add

add(t: number, f: number | IPFunctionCalculus<R, C, 1, D, I>): this

- Defined in src/piecewise.ts:51
Add a piece of the function starting at t and continuing up to the next time.

Parameters
- t: number
- f: number | IPFunctionCalculus<R, C, 1, D, I>
Returns this

at

at(...pairs: TVPairs): this

- Defined in src/piecewise.ts:95
Add a series of segments, e.g. pw.at(t0, f0, t1, f1, t2, f2, ...);

Parameters
- Rest ...pairs: TVPairs
  
  alternating time and value pairs.
Returns this

compile

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

Implementation of IPFunctionCalculus.compile

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

Protected compileFn

compileFn(): IPCompileResult<R>

Overrides PFunction.compileFn
- Defined in src/piecewise.ts:110
Returns IPCompileResult<R>

derivative

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

Implementation of IPFunctionCalculus.derivative

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

differentiate

differentiate(): IPFunctionCalculus<R, D, 1, Divide<D, time>, C>

Overrides PCalculus.differentiate
- Defined in src/piecewise.ts:126
Returns IPFunctionCalculus<R, D, 1, Divide<D, time>, C>

equiv

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

Implementation of IPFunctionCalculus.equiv

Inherited from PFunction.equiv
- Defined in src/pfunction.ts:148
Type parameters
- T
Parameters
- f: T
Returns null | this | T

initial

initial(f: number | IPFunctionCalculus<R, C, 1, D, I>): this

- Defined in src/piecewise.ts:106
Add a value for t = -∞.

Parameters
- f: number | IPFunctionCalculus<R, C, 1, D, I>
Returns this

integral

integral(): IndefiniteIntegral<R, I, C>

Implementation of IPFunctionCalculus.integral

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

Returns IndefiniteIntegral<R, I, C>

integrate

integrate(): IndefiniteIntegral<R, I, C>

Overrides PCalculus.integrate
- Defined in src/piecewise.ts:134
Returns IndefiniteIntegral<R, I, C>

Private setName_

setName_(name: string): this

Implementation of IPFunctionCalculus.setName_

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

Parameters
- name: string
Returns this

simplify

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

Implementation of IPFunctionCalculus.simplify

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

toHtml

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

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

Parameters
- Optional varName: undefined | string
- Optional block: undefined | false | true
- Default value ctx: StyleContext = DEFAULT_STYLE.context
Returns ViewOf<this> & Element

toTex

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

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

toTexWithUnits

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

Inherited from PFunction.toTexWithUnits
- Defined in src/pfunction.ts:98
Parameters
- Default value varName: string = "t"
- Default value ctx: StyleContext = DEFAULT_STYLE.context
Returns string

Generated using TypeDoc