Unit | UNITS 1.6.3

The Unit class represents the units for a measure.

Hierarchy

Unit

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Unit(multiplier: number, dimensions: Dimensions, labels: string[]): Unit

- Defined in src/davinci-units/math/Unit.ts:216
Parameters
- multiplier: number
- dimensions: Dimensions
- labels: string[]
  
  The label strings to use for each dimension.
Returns Unit

Properties

dimensions

dimensions: Dimensions

labels

labels: string[]

The label strings to use for each dimension.

multiplier

multiplier: number

Static AMPERE

AMPERE: Unit = new Unit(1.0, Dimensions.CURRENT, SYMBOLS_SI)

Static CANDELA

CANDELA: Unit = new Unit(1.0, Dimensions.INTENSITY, SYMBOLS_SI)

Static COULOMB

COULOMB: Unit = new Unit(1.0, Dimensions.CHARGE, SYMBOLS_SI)

Static KELVIN

KELVIN: Unit = new Unit(1.0, Dimensions.TEMPERATURE, SYMBOLS_SI)

Static KILOGRAM

KILOGRAM: Unit = new Unit(1.0, Dimensions.MASS, SYMBOLS_SI)

Static METER

METER: Unit = new Unit(1.0, Dimensions.LENGTH, SYMBOLS_SI)

Static MOLE

MOLE: Unit = new Unit(1.0, Dimensions.AMOUNT, SYMBOLS_SI)

Static ONE

ONE: Unit = new Unit(1.0, Dimensions.ONE, SYMBOLS_SI)

Static SECOND

SECOND: Unit = new Unit(1.0, Dimensions.TIME, SYMBOLS_SI)

Static ZERO

ZERO: Unit = new Unit(0.0, Dimensions.ONE, SYMBOLS_SI)

Methods

add

__add__(rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:258
Parameters
- rhs: Unit
Returns Unit

div

__div__(other: number | Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:372
Parameters
- other: number | Unit
Returns Unit

mul

__mul__(rhs: number | Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:328
Parameters
- rhs: number | Unit
Returns Unit

neg

__neg__(): Unit

- Defined in src/davinci-units/math/Unit.ts:569
Returns Unit

pos

__pos__(): Unit

- Defined in src/davinci-units/math/Unit.ts:562
Returns Unit

radd

__radd__(lhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:271
Parameters
- lhs: Unit
Returns Unit

rdiv

__rdiv__(other: number | Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:384
Parameters
- other: number | Unit
Returns Unit

rmul

__rmul__(lhs: number | Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:344
Parameters
- lhs: number | Unit
Returns Unit

rsub

__rsub__(lhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:306
Parameters
- lhs: Unit
Returns Unit

sub

__sub__(rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:293
Parameters
- rhs: Unit
Returns Unit

add

add(rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:250
Parameters
- rhs: Unit
Returns Unit

compatible

compatible(rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:236
Parameters
- rhs: Unit
Returns Unit

div

div(rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:360
Parameters
- rhs: Unit
Returns Unit

divByScalar

divByScalar(α: number): Unit

- Defined in src/davinci-units/math/Unit.ts:368
Parameters
- α: number
Returns Unit

inv

inv(): Unit

- Defined in src/davinci-units/math/Unit.ts:429
Returns Unit

isOne

isOne(): boolean

- Defined in src/davinci-units/math/Unit.ts:443
Returns boolean

isZero

isZero(): boolean

- Defined in src/davinci-units/math/Unit.ts:450
Returns boolean

lerp

lerp(target: Unit, α: number): Unit

- Defined in src/davinci-units/math/Unit.ts:457
Parameters
- target: Unit
- α: number
Returns Unit

mul

mul(rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:320
Parameters
- rhs: Unit
Returns Unit

neg

neg(): Unit

- Defined in src/davinci-units/math/Unit.ts:436
Returns Unit

norm

norm(): Unit

- Defined in src/davinci-units/math/Unit.ts:464
Returns Unit

pattern

pattern(): string

- Defined in src/davinci-units/math/Unit.ts:399
Intentionaly undocumented.

Returns string

pow

pow(exponent: QQ): Unit

- Defined in src/davinci-units/math/Unit.ts:422
Parameters
- exponent: QQ
Returns Unit

quad

quad(): Unit

- Defined in src/davinci-units/math/Unit.ts:471
Returns Unit

reflect

reflect(n: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:479
Parameters
- n: Unit
Returns Unit

rotate

rotate(rotor: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:487
Parameters
- rotor: Unit
Returns Unit

scale

scale(α: number): Unit

- Defined in src/davinci-units/math/Unit.ts:495
Parameters
- α: number
Returns Unit

slerp

slerp(target: Unit, α: number): Unit

- Defined in src/davinci-units/math/Unit.ts:504
Parameters
- target: Unit
- α: number
Returns Unit

sqrt

sqrt(): Unit

- Defined in src/davinci-units/math/Unit.ts:511
Returns Unit

stress

stress(σ: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:519
Parameters
- σ: Unit
Returns Unit

sub

sub(rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:285
Parameters
- rhs: Unit
Returns Unit

toExponential

toExponential(fractionDigits?: number, compact?: boolean): string

- Defined in src/davinci-units/math/Unit.ts:528
Parameters
- Optional fractionDigits: number
- Optional compact: boolean
Returns string

toFixed

toFixed(fractionDigits?: number, compact?: boolean): string

- Defined in src/davinci-units/math/Unit.ts:537
Parameters
- Optional fractionDigits: number
- Optional compact: boolean
Returns string

toPrecision

toPrecision(precision?: number, compact?: boolean): string

- Defined in src/davinci-units/math/Unit.ts:546
Parameters
- Optional precision: number
- Optional compact: boolean
Returns string

toString

toString(radix?: number, compact?: boolean): string

- Defined in src/davinci-units/math/Unit.ts:555
Parameters
- Optional radix: number
- Optional compact: boolean
Returns string

Static assertDimensionless

assertDimensionless(uom: Unit): void

- Defined in src/davinci-units/math/Unit.ts:593
Parameters
- uom: Unit
Returns void

Static compatible

compatible(lhs: Unit, rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:604
Parameters
- lhs: Unit
- rhs: Unit
Returns Unit

Static div

div(lhs: Unit, rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:663
Parameters
- lhs: Unit
- rhs: Unit
Returns Unit

Static isOne

isOne(uom: Unit): boolean

- Defined in src/davinci-units/math/Unit.ts:577
Parameters
- uom: Unit
Returns boolean

Static mul

mul(lhs: Unit, rhs: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:638
Parameters
- lhs: Unit
- rhs: Unit
Returns Unit

Static sqrt

sqrt(uom: Unit): Unit

- Defined in src/davinci-units/math/Unit.ts:686
Parameters
- uom: Unit
Returns Unit

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

multiplier: number

dimensions: Dimensions

labels: string[]

Returns Unit

Properties

dimensions

labels

multiplier

Static AMPERE

Static CANDELA

Static COULOMB

Static KELVIN

Static KILOGRAM

Static METER

Static MOLE

Static ONE

Static SECOND

Static ZERO

Methods

__add__

Parameters

rhs: Unit

Returns Unit

__div__

Parameters

other: number | Unit

Returns Unit

__mul__

Parameters

rhs: number | Unit

Returns Unit

__neg__

Returns Unit

__pos__

Returns Unit

__radd__

Parameters

lhs: Unit

Returns Unit

__rdiv__

Parameters

other: number | Unit

Returns Unit

__rmul__

Parameters

lhs: number | Unit

Returns Unit

__rsub__

Parameters

lhs: Unit

Returns Unit

__sub__

Parameters

rhs: Unit

Returns Unit

add

Parameters

rhs: Unit

Returns Unit

compatible

Parameters

rhs: Unit

Returns Unit

div

Parameters

rhs: Unit

Returns Unit

divByScalar

Parameters

α: number

Returns Unit

inv

add

div

mul

neg

pos

radd

rdiv

rmul

rsub

sub