rawBinaryFixedPoint

function rawBinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>(
    signedness,
    totalBits,
    fractionalBits,
): (raw) => BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>;

Returns a factory that constructs BinaryFixedPoint values from a raw bigint in the smallest representable unit (i.e. already scaled by 2 ** fractionalBits).

The outer call validates the shape parameters once and the returned factory can be called many times to construct values of that shape.

The raw value is range-checked against the claimed totalBits and signedness; no rounding is ever required.

Type Parameters

Type Parameter
TSignedness extends Signedness
TTotalBits extends number
TFractionalBits extends number

Parameters

ParameterType
signednessTSignedness
totalBitsTTotalBits
fractionalBitsTFractionalBits

Returns

(raw): BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>;

Parameters

ParameterType
rawbigint

Returns

BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>

Example

const q1_15 = rawBinaryFixedPoint('signed', 16, 15);
q1_15(16384n); // Represents 0.5

See

On this page