LaTeX | Physics Math

Support for LaTex formatting of our expressions and data.

Index

Enumerations

NumberFormat

Classes

Interfaces

StyleContextHolder

Type aliases

Variables

Functions

Object literals

DEFAULT_STYLE_FNS

Type aliases

RGB6Color

RGB6Color: string

We take our colors in 6 RGB hex digits, e.g. RRGGBB, {RR, GG, BB} ∈ 00..FF.

StyleFnFor

StyleFnFor<K>: K extends "applyUnit" | "applyUnitFunction" ? StylerFn<string | number, [IUnitBase]> : K extends "unit" | "unitSymbol" ? StylerFn<IUnitBase> : K extends "unitFraction" ? StylerFn<string, [string]> : K extends StyleKeyString | StyleKeyNumber ? StyleMap[K] extends Styler<infer S> ? StylerFn<S> : never : K extends StyleKey ? StyleMap[K] : never

Type parameters

K: keyof StyleMap

StyleFnMap

StyleFnMap: {}

Type declaration

StyleKey

StyleKey: StyleKeyString | StyleKeyNumber | StyleKeyOther | StyleKeyData | StyleKeyStyle

The valid style keys to be used with setStyle.

StyleKeyData

StyleKeyData: "numberSpecials" | "numberPrecision" | "numberFormat" | "numberTrimTrailingZero"

StyleKeyNumber

StyleKeyNumber: "number"

StyleKeyOther

StyleKeyOther: "applyUnits" | "applyUnitFunction" | "unit" | "unitSymbol" | "unitFraction"

StyleKeyString

StyleKeyString: "function" | "call" | "variable"

StyleKeyStyle

StyleKeyStyle: "exponentStyle"

StyleMap

StyleMap: {} & {} & {} & {} & {} & {} & { numberFormat: NumberFormat; numberPrecision: number; numberSpecials: Map<number, string>; numberTrimTrailingZero: boolean }

A type map of StyleKey to Styler (plus the supporting data items).

Styler

Styler<I, R>: (continuation: StylerFn, thisStyle: Style) => StylerFn<I, R>

A styler takes a LaTeX fragment and transforms it in some way.

A Styler is required to be synchronous; no use of await or promises is allowed.

Type parameters

I
R: any[]

Type declaration

- (continuation: StylerFn, thisStyle: Style): StylerFn<I, R>
- Parameters
 - continuation: StylerFn
 - thisStyle: Style
 Returns StylerFn<I, R>

StylerFn

StylerFn<I, R>: (ctx: StyleContext, arg: I, ...rest: R) => string

Type parameters

I
R: any[]

Type declaration

- (ctx: StyleContext, arg: I, ...rest: R): string
- Parameters
  - ctx: StyleContext
  - arg: I
  - Rest ...rest: R
  Returns string

Variables

Const DEFAULTS

DEFAULTS: StyleMap = Object.freeze({unit: colorStyler('ff0000'),unitFraction: () => (_ctx, numer, denom) => tex`\Large{\frac{${numer}}{${denom}}}`,unitSymbol: () => (_ctx, unit) => tex`\text{${unit.symbol}}`,function: () => (_ctx, op) => tex`\operatorname{${op}}`,call: () => (_ctx, s) => s,variable: () => (_ctx, s: string) => tex`{${s}}`,applyUnit: () => (ctx, v: string|number, u: IUnitBase) => tex`{{${v}}\ {${ctx.unit(u)}}}`,applyUnitFunction: () => (ctx, v: string|number, u: IUnitBase) => tex`{{${v}} \Leftarrow {${ctx.unit(u)}}}`,number: chain(specialNumber, formatNumber),numberFormat: NumberFormat.scientific,numberPrecision: 4,numberSpecials: SPECIAL_NUMBERS,numberTrimTrailingZero: true,exponentStyle: exponentStyle})

The stylers. These handle adding style formatting to the syntactic expressions components.

Const INITIAL_STYLE

INITIAL_STYLE: Style = new Style(DEFAULTS)

The initial [[DEFAULT_STYLE]].

Const LATEX_STYLE_KEYS

LATEX_STYLE_KEYS: StyleKey[] = Object.keys(DEFAULT_STYLE) as StyleKey[]

List of the valid style keys for setStyle.

Let SPECIAL_NUMBERS

SPECIAL_NUMBERS: Map<number, string> = ((m = new Map<number, string>()) => {for (const [numer, denom] of fractions()) {if (denom) {m.set(numer / denom, tex`\frac{${numer}}{${denom}}`);}for (const [v, sym] of specials) {if (!denom) {// Integerm.set(numer * v, numer === 1 ? sym : tex`${numer}${sym}`);} else {m.set(numer * v / denom,numer === 1? tex`\frac{${sym}}{${denom}}`: tex`\frac{${numer}${sym}}{${denom}}`);}}}return Object.freeze(m) as Map<number, string>;})()

Const exponentStyle

exponentStyle: Style = Object.freeze(new Style({unit: colorStyler('ff0000'),unitFraction: () => (_ctx, numer, denom) => tex`\Large{\frac{${numer}}{${denom}}}`,unitSymbol: () => (_ctx, unit) => tex`\text{${unit.symbol}}`,function: () => (_ctx, op) => tex`\operatorname{${op}}`,call: () => (_ctx, s) => s,variable: () => (_ctx, s: string) => tex`{${s}}`,applyUnit: () => (ctx, v: string | number, u: IUnitBase) => tex`{{${v}}\ {${ctx.unit(u)}}}`,applyUnitFunction: () => (ctx, v: string | number, u: IUnitBase) => tex`{{${v}} \Leftarrow {${ctx.unit(u)}}}`,number: chain(specialNumber, formatNumber),numberFormat: NumberFormat.normal,numberPrecision: 0,numberSpecials: SPECIAL_NUMBERS,numberTrimTrailingZero: true,exponentStyle: 'self'}))

Const specials

specials: Array<[number, string]> = [[Math.PI, tex`\pi`],[Math.sqrt(2), tex`\sqrt{2}`],[Math.E, tex`\mathrm{e}`]]

Functions

Const chain

chain(...stylers: Styler[]): Styler

- Defined in src/latex.ts:358
Type parameters
- I
Parameters
- Rest ...stylers: Styler[]
Returns Styler

Const colorStyler

colorStyler(color: RGB6Color): Styler<any>

- Defined in src/latex.ts:366
Create a Styler that changes the color.

Parameters
- color: RGB6Color
 
 an RGB6Color
Returns Styler<any>

Const formatNumber

formatNumber(continuation: StylerFn<number>, _style: Style): (Anonymous function)

- Defined in src/latex.ts:323
Parameters
- continuation: StylerFn<number>
- _style: Style
Returns (Anonymous function)

fractions

fractions(max?: number, maxDenom?: number): Generator<number[], void, unknown>

- Defined in src/latex.ts:277
Parameters
- Default value max: number = 10
- Default value maxDenom: number = 10
Returns Generator<number[], void, unknown>

Const setStyle

setStyle(style: Style): Style

- Defined in src/latex.ts:445
Set the default style to be used.

Parameters
- style: Style
Returns Style

Const specialNumber

specialNumber(continuation: StylerFn<number>, _style: Style): (Anonymous function)

- Defined in src/latex.ts:352
Parameters
- continuation: StylerFn<number>
- _style: Style
Returns (Anonymous function)

Object literals

Const DEFAULT_STYLE_FNS

DEFAULT_STYLE_FNS: object

exponentStyle

exponentStyle: "exponent" = "exponent"

numberFormat

numberFormat: scientific = NumberFormat.scientific

numberPrecision

numberPrecision: number = 4

numberSpecials

numberSpecials: Map<number, string> = SPECIAL_NUMBERS

numberTrimTrailingZero

numberTrimTrailingZero: true = true

applyUnit

applyUnit(ctx: StyleContext, s: string | number, u: IUnitBase<{}>): string

- Defined in src/latex.ts:378
Parameters
- ctx: StyleContext
- s: string | number
- u: IUnitBase<{}>
Returns string

applyUnitFunction

applyUnitFunction(ctx: StyleContext, s: string | number, u: IUnitBase<{}>): string

- Defined in src/latex.ts:379
Parameters
- ctx: StyleContext
- s: string | number
- u: IUnitBase<{}>
Returns string

call

call(_ctx: StyleContext, s: string): string

- Defined in src/latex.ts:376
Parameters
- _ctx: StyleContext
- s: string
Returns string

function

function(_ctx: StyleContext, s: string): string

- Defined in src/latex.ts:375
Parameters
- _ctx: StyleContext
- s: string
Returns string

number

number(_ctx: StyleContext, s: number): string

- Defined in src/latex.ts:380
Parameters
- _ctx: StyleContext
- s: number
Returns string

unit

unit(_ctx: StyleContext, u: IUnitBase<{}>): string

- Defined in src/latex.ts:372
Parameters
- _ctx: StyleContext
- u: IUnitBase<{}>
Returns string

unitFraction

unitFraction(_ctx: StyleContext, numer: string, denom: string): string

- Defined in src/latex.ts:373
Parameters
- _ctx: StyleContext
- numer: string
- denom: string
Returns string

unitSymbol

unitSymbol(_ctx: StyleContext, unit: IUnitBase<{}>): string

- Defined in src/latex.ts:374
Parameters
- _ctx: StyleContext
- unit: IUnitBase<{}>
Returns string

variable

variable(_ctx: StyleContext, s: string): string

- Defined in src/latex.ts:377
Parameters
- _ctx: StyleContext
- s: string
Returns string

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

RGB6Color

StyleFnFor

Type parameters

K: keyof StyleMap

StyleFnMap

Type declaration

StyleKey

StyleKeyData

StyleKeyNumber

StyleKeyOther

StyleKeyString

StyleKeyStyle

StyleMap

Styler

Type parameters

I

R: any[]

Type declaration

Parameters

continuation: StylerFn<I>

thisStyle: Style

Returns StylerFn<I, R>

StylerFn

Type parameters

I

R: any[]

Type declaration

Parameters

ctx: StyleContext

arg: I

Rest ...rest: R

Returns string

Variables

Const DEFAULTS

Const INITIAL_STYLE

Const LATEX_STYLE_KEYS

Let SPECIAL_NUMBERS

Const exponentStyle

Const specials

Functions

Const chain

Type parameters

I

Parameters

Rest ...stylers: Styler<I>[]

Returns Styler<I>

Const colorStyler

Parameters

color: RGB6Color

Returns Styler<any>

Const formatNumber

Parameters

continuation: StylerFn<number>

_style: Style

Returns (Anonymous function)

fractions

Parameters

Default value max: number = 10

Default value maxDenom: number = 10

Returns Generator<number[], void, unknown>

Const setStyle

Parameters

style: Style

Returns Style

Const specialNumber

Parameters

continuation: StylerFn<number>

_style: Style

Returns (Anonymous function)

Object literals

Const DEFAULT_STYLE_FNS