Class Uom

The Uom class represents the units for a measure.

Hierarchy (view full)

JsAtom
- Uom

Index

Constructors

Properties

dimensions end? labels name pos? type AMPERE CANDELA COULOMB KELVIN KILOGRAM METER MOLE ONE SECOND

Accessors

Constructors

constructor

new Uom(dimensions, labels): Uom
Parameters
- dimensions: Dimensions
- labels: string[]
  The label strings to use for each dimension.
Returns Uom
Overrides JsAtom.constructor
- Defined in packages/atoms/src/uom/Uom.ts:220

Properties

dimensions

dimensions: Dimensions

`Optional` `Readonly` end

end?: number

labels

labels: string[]

The label strings to use for each dimension.

`Readonly` name

name: string

`Optional` `Readonly` pos

pos?: number

`Readonly` type

type: "uom" = "uom"

`Static` AMPERE

AMPERE: Uom = ...

ampere

`Static` CANDELA

CANDELA: Uom = ...

candela

`Static` COULOMB

COULOMB: Uom = ...

coulomb

`Static` KELVIN

KELVIN: Uom = ...

kelvin

`Static` KILOGRAM

KILOGRAM: Uom = ...

kilogram

`Static` METER

METER: Uom = ...

meter or metre

`Static` MOLE

MOLE: Uom = ...

mole

`Static` ONE

ONE: Uom = ...

dimensionless

`Static` SECOND

SECOND: Uom = ...

second

Accessors

iscons

get iscons(): boolean
Returns boolean
Inherited from JsAtom.iscons
- Defined in packages/atoms/src/atom/JsAtom.ts:26

isnil

get isnil(): boolean
Returns boolean
Inherited from JsAtom.isnil
- Defined in packages/atoms/src/atom/JsAtom.ts:29

Methods

addRef

addRef(): void
Returns void
Inherited from JsAtom.addRef
- Defined in packages/atoms/src/atom/JsAtom.ts:14

compatible

compatible(rhs): Uom
Parameters
- rhs: Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:234

contains

contains(needle): boolean
Parameters
- needle: U
Returns boolean
Inherited from JsAtom.contains
- Defined in packages/atoms/src/atom/JsAtom.ts:16

div

div(rhs): Uom
Parameters
- rhs: Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:254

equals

equals(other): boolean
Parameters
- other: U
Returns boolean
Overrides JsAtom.equals
- Defined in packages/atoms/src/uom/Uom.ts:243

inv

inv(): Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:285

isOne

isOne(): boolean
Returns boolean
true if this unit is dimensionless.
- Defined in packages/atoms/src/uom/Uom.ts:292

mul

mul(rhs): Uom
Parameters
- rhs: Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:250

pow

pow(exponent): Uom
Parameters
- exponent: QQ
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:281

quad

quad(): Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:296

release

release(): void
Returns void
Inherited from JsAtom.release
- Defined in packages/atoms/src/atom/JsAtom.ts:15

sqrt

sqrt(): Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:300

toExponential

toExponential(fractionDigits?, compact?): string
Parameters
- Optional fractionDigits: number
- Optional compact: boolean
  Determines whether a multiplier of unity will be included in the result.
Returns string
- Defined in packages/atoms/src/uom/Uom.ts:309

toFixed

toFixed(fractionDigits?, compact?): string
Parameters
- Optional fractionDigits: number
- Optional compact: boolean
  Determines whether a multiplier of unity will be included in the result.
Returns string
- Defined in packages/atoms/src/uom/Uom.ts:318

toInfixString

toInfixString(): string
Returns string
- Defined in packages/atoms/src/uom/Uom.ts:322

toListString

toListString(): string
Returns string
- Defined in packages/atoms/src/uom/Uom.ts:328

toPrecision

toPrecision(precision?, compact?): string
Parameters
- Optional precision: number
- Optional compact: boolean
  Determines whether a multiplier of unity will be included in the result.
Returns string
- Defined in packages/atoms/src/uom/Uom.ts:338

toString

toString(radix?, compact?): string
Parameters
- Optional radix: number
- Optional compact: boolean
  Determines whether a multiplier of unity will be included in the result.
Returns string
Overrides JsAtom.toString
- Defined in packages/atoms/src/uom/Uom.ts:346

`Static` assertDimensionless

assertDimensionless(uom): void
Parameters
- uom: Uom
Returns void
- Defined in packages/atoms/src/uom/Uom.ts:366

`Static` compatible

compatible(lhs, rhs): Uom
Parameters
- lhs: Uom
- rhs: Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:376

`Static` div

div(lhs, rhs): Uom
Parameters
- lhs: Uom
- rhs: Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:426

`Static` isOne

isOne(uom): boolean
Parameters
- uom: Uom
Returns boolean
- Defined in packages/atoms/src/uom/Uom.ts:353

`Static` mul

mul(lhs, rhs): Uom
Parameters
- lhs: Uom
- rhs: Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:405

`Static` sqrt

sqrt(uom): Uom
Parameters
- uom: Uom
Returns Uom
- Defined in packages/atoms/src/uom/Uom.ts:446