Class: NumberUnitReadOnly<F, U>
Defined in: src/sdk/math/NumberUnit.ts:486
A read-only interface for a WT_NumberUnit.
Type Parameters
Type Parameter | Default type |
---|---|
F extends string | - |
U extends Unit <F > | Unit <F > |
Implements
NumberUnitInterface
<F
,U
>
Constructors
Constructor
new NumberUnitReadOnly<
F
,U
>(source
):NumberUnitReadOnly
<F
,U
>
Defined in: src/sdk/math/NumberUnit.ts:491
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
source | NumberUnit <F , U > | the source of the new read-only NumberUnit. |
Returns
NumberUnitReadOnly
<F
, U
>
Accessors
number
Get Signature
get number():
number
Defined in: src/sdk/math/NumberUnit.ts:498
Gets this NumberUnit's numeric value.
Returns
number
This NumberUnit's numeric value.
This NumberUnit's numeric value.
Implementation of
unit
Get Signature
get unit():
U
Defined in: src/sdk/math/NumberUnit.ts:506
Gets this NumberUnit's unit type.
Returns
U
This NumberUnit's unit type.
This NumberUnit's unit type.
Implementation of
Methods
abs()
abs<
OU
>(out
):NumberUnit
<F
,OU
>
Defined in: src/sdk/math/NumberUnit.ts:607
Calculates the absolute value of this NumberUnit and returns the result.
Type Parameters
Type Parameter |
---|
OU extends Unit <F > |
Parameters
Parameter | Type | Description |
---|---|---|
out | NumberUnit <F , OU > | The NumberUnit to which to write the result. |
Returns
NumberUnit
<F
, OU
>
The absolute value.
Implementation of
add()
Call Signature
add<
OU
>(value
,out
):NumberUnit
<F
,OU
>
Defined in: src/sdk/math/NumberUnit.ts:517
Adds a value to this NumberUnit and returns the result.
Type Parameters
Type Parameter |
---|
OU extends Unit <F > |
Parameters
Parameter | Type | Description |
---|---|---|
value | NumberUnitInterface <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.
Implementation of
Call Signature
add<
OU
>(value
,unit
,out
):NumberUnit
<F
,OU
>
Defined in: src/sdk/math/NumberUnit.ts:526
Adds a value to this NumberUnit and returns the result.
Type Parameters
Type Parameter |
---|
OU extends Unit <F > |
Parameters
Parameter | 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.
Implementation of
asUnit()
asUnit(
unit
):number
Defined in: src/sdk/math/NumberUnit.ts:617
Returns the numeric value of this NumberUnit after conversion to a specified unit.
Parameters
Parameter | 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.
Implementation of
compare()
Call Signature
compare(
value
):number
Defined in: src/sdk/math/NumberUnit.ts:627
Checks whether this NumberUnit is greater than, equal to, or less than another value.
Parameters
Parameter | Type | Description |
---|---|---|
value | NumberUnitInterface <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.
Implementation of
Call Signature
compare(
value
,unit?
):number
Defined in: src/sdk/math/NumberUnit.ts:635
Checks whether this NumberUnit is greater than, equal to, or less than another value.
Parameters
Parameter | 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.
Implementation of
copy()
copy():
NumberUnit
<F
,U
>
Defined in: src/sdk/math/NumberUnit.ts:683
Copies this NumberUnit.
Returns
NumberUnit
<F
, U
>
A copy of this NumberUnit.
Implementation of
equals()
Call Signature
equals(
value
):boolean
Defined in: src/sdk/math/NumberUnit.ts:652
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
Parameter | Type | Description |
---|---|---|
value | NumberUnitInterface <string > | The other value. |
Returns
boolean
Whether this NumberUnit is equal to the other value.
Implementation of
Call Signature
equals(
value
,unit?
):boolean
Defined in: src/sdk/math/NumberUnit.ts:661
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
Parameter | 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.
Implementation of
isNaN()
isNaN():
boolean
Defined in: src/sdk/math/NumberUnit.ts:675
Checks whether this NumberUnit has a numeric value of NaN.
Returns
boolean
Whether this NumberUnit has a numeric value of NaN.
Implementation of
ratio()
Call Signature
ratio(
value
):number
Defined in: src/sdk/math/NumberUnit.ts:584
Finds the ratio of this NumberUnit to another value.
Parameters
Parameter | Type | Description |
---|---|---|
value | NumberUnitInterface <F > | The other value. |
Returns
number
The ratio.
Throws
Error if the other value cannot be converted to this NumberUnit's unit type.
Implementation of
Call Signature
ratio(
value
,unit
):number
Defined in: src/sdk/math/NumberUnit.ts:592
Finds the ratio of this NumberUnit to another value.
Parameters
Parameter | 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.
Implementation of
scale()
scale<
OU
>(factor
,out
):NumberUnit
<F
,OU
>
Defined in: src/sdk/math/NumberUnit.ts:574
Scales this NumberUnit by a unit-less factor and returns the result.
Type Parameters
Type Parameter |
---|
OU extends Unit <F > |
Parameters
Parameter | 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.
Implementation of
subtract()
Call Signature
subtract<
OU
>(value
,out
):NumberUnit
<F
,OU
>
Defined in: src/sdk/math/NumberUnit.ts:546
Subtracts a value from this NumberUnit and returns the result.
Type Parameters
Type Parameter |
---|
OU extends Unit <F > |
Parameters
Parameter | Type | Description |
---|---|---|
value | NumberUnitInterface <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.
Implementation of
Call Signature
subtract<
OU
>(value
,unit
,out
):NumberUnit
<F
,OU
>
Defined in: src/sdk/math/NumberUnit.ts:555
Subtracts a value from this NumberUnit and returns the result.
Type Parameters
Type Parameter |
---|
OU extends Unit <F > |
Parameters
Parameter | 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.