Interface: NumberUnitInterface<F, U>
A numeric value with unit type.
Type parameters
| Name | Type |
|---|---|
F | extends string |
U | extends Unit<F> = Unit<F> |
Implemented by
Properties
number
• number: number
This NumberUnit's numeric value.
Defined in
src/sdk/math/NumberUnit.ts:17
unit
• unit: U
This NumberUnit's unit type.
Defined in
src/sdk/math/NumberUnit.ts:20
Methods
abs
▸ abs<OU>(out): NumberUnit<F, OU>
Calculates the absolute value of this NumberUnit and returns the result.
Type parameters
| Name | Type |
|---|---|
OU | extends Unit<F> |
Parameters
| Name | Type | Description |
|---|---|---|
out | NumberUnit<F, OU> | The NumberUnit to which to write the result. |
Returns
NumberUnit<F, OU>
The absolute value.
Defined in
src/sdk/math/NumberUnit.ts:87
add
▸ add<OU>(value, out): NumberUnit<F, OU>
Adds a value to this NumberUnit and returns the result.
Type parameters
| Name | Type |
|---|---|
OU | extends Unit<F> |
Parameters
| Name | Type | Description |
|---|---|---|
value | NumberUnitInterface<F, Unit<F>> | The other value. |
out | NumberUnit<F, OU> | The NumberUnit to which to write the result. |
Returns
NumberUnit<F, OU>
The sum.
Throws
Error if the supplied value cannot be converted to this NumberUnit's unit type.
Defined in
src/sdk/math/NumberUnit.ts:29
▸ add<OU>(value, unit, out): NumberUnit<F, OU>
Adds a value to this NumberUnit and returns the result.
Type parameters
| Name | Type |
|---|---|
OU | extends Unit<F> |
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The other value. |
unit | Unit<F> | The unit type of the other value. |
out | NumberUnit<F, OU> | The NumberUnit to which to write the result. |
Returns
NumberUnit<F, OU>
The sum.
Throws
Error if the supplied value cannot be converted to this NumberUnit's unit type.
Defined in
src/sdk/math/NumberUnit.ts:38
asUnit
▸ asUnit(unit): number
Returns the numeric value of this NumberUnit after conversion to a specified unit.
Parameters
| Name | Type | Description |
|---|---|---|
unit | Unit<F> | The unit to which to convert. |
Returns
number
The converted numeric value.
Throws
Error if this NumberUnit's unit type cannot be converted to the specified unit.
Defined in
src/sdk/math/NumberUnit.ts:95
compare
▸ compare(value): number
Checks whether this NumberUnit is greater than, equal to, or less than another value.
Parameters
| Name | Type | Description |
|---|---|---|
value | NumberUnitInterface<F, Unit<F>> | The other value. |
Returns
number
0 if this NumberUnit is equal to the other value, -1 if this number is less, 1 if this number is greater.
Throws
Error if this NumberUnit cannot be compared to the other value.
Defined in
src/sdk/math/NumberUnit.ts:103
▸ compare(value, unit?): number
Checks whether this NumberUnit is greater than, equal to, or less than another value.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The other value. |
unit? | Unit<F> | The unit type of the other value. Defaults to this NumberUnit's unit type. |
Returns
number
0 if this NumberUnit is equal to the other value, -1 if this number is less, 1 if this number is greater.
Throws
Error if this NumberUnit cannot be compared to the other value.
Defined in
src/sdk/math/NumberUnit.ts:111
copy
▸ copy(): NumberUnit<F, U>
Copies this NumberUnit.
Returns
NumberUnit<F, U>
A copy of this NumberUnit.
Defined in
src/sdk/math/NumberUnit.ts:141
equals
▸ equals(value): boolean
Checks whether this NumberUnit is equal to another value. Two values are considered equal if and only if their
unit types are interconvertable and when converted to the same unit type, their numeric values are equal to each
other or both equal to NaN.
Parameters
| Name | Type | Description |
|---|---|---|
value | NumberUnitInterface<string, Unit<string>> | The other value. |
Returns
boolean
Whether this NumberUnit is equal to the other value.
Defined in
src/sdk/math/NumberUnit.ts:120
▸ equals(value, unit?): boolean
Checks whether this NumberUnit is equal to another value. Two values are considered equal if and only if their
unit types are interconvertable and when converted to the same unit type, their numeric values are equal to each
other or both equal to NaN.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The other value. |
unit? | Unit<string> | The unit type of the other value. Defaults to this NumberUnit's unit type. |
Returns
boolean
Whether this NumberUnit is equal to the other value.
Defined in
src/sdk/math/NumberUnit.ts:129
isNaN
▸ isNaN(): boolean
Checks whether this NumberUnit has a numeric value of NaN.
Returns
boolean
Whether this NumberUnit has a numeric value of NaN.
Defined in
src/sdk/math/NumberUnit.ts:135
ratio
▸ ratio(value): number
Finds the ratio of this NumberUnit to another value.
Parameters
| Name | Type | Description |
|---|---|---|
value | NumberUnitInterface<F, Unit<F>> | The other value. |
Returns
number
The ratio.
Throws
Error if the other value cannot be converted to this NumberUnit's unit type.
Defined in
src/sdk/math/NumberUnit.ts:72
▸ ratio(value, unit): number
Finds the ratio of this NumberUnit to another value.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The other value. |
unit | Unit<F> | The unit type of the other value. |
Returns
number
the ratio.
Throws
Error if the other value cannot be converted to this NumberUnit's unit type.
Defined in
src/sdk/math/NumberUnit.ts:80
scale
▸ scale<OU>(factor, out): NumberUnit<F, OU>
Scales this NumberUnit by a unit-less factor and returns the result.
Type parameters
| Name | Type |
|---|---|
OU | extends Unit<F> |
Parameters
| Name | Type | Description |
|---|---|---|
factor | number | The factor by which to scale. |
out | NumberUnit<F, OU> | The NumberUnit to which to write the result. |
Returns
NumberUnit<F, OU>
The scaled value.
Defined in
src/sdk/math/NumberUnit.ts:64
subtract
▸ subtract<OU>(value, out): NumberUnit<F, OU>
Subtracts a value from this NumberUnit and returns the result.
Type parameters
| Name | Type |
|---|---|
OU | extends Unit<F> |
Parameters
| Name | Type | Description |
|---|---|---|
value | NumberUnitInterface<F, Unit<F>> | The other value. |
out | NumberUnit<F, OU> | The NumberUnit to which to write the result. |
Returns
NumberUnit<F, OU>
The difference.
Throws
Error if the supplied value cannot be converted to this NumberUnit's unit type.
Defined in
src/sdk/math/NumberUnit.ts:47
▸ subtract<OU>(value, unit, out): NumberUnit<F, OU>
Subtracts a value from this NumberUnit and returns the result.
Type parameters
| Name | Type |
|---|---|
OU | extends Unit<F> |
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The other value. |
unit | Unit<F> | The unit type of the other value. |
out | NumberUnit<F, OU> | The NumberUnit to which to write the result. |
Returns
NumberUnit<F, OU>
The difference.
Throws
Error if the supplied value cannot be converted to this NumberUnit's unit type.
Defined in
src/sdk/math/NumberUnit.ts:56