binaryFixedPoint

function binaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>(
    signedness,
    totalBits,
    fractionalBits,
): (
    input,
    rounding?,
) => BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>;

Returns a factory that constructs BinaryFixedPoint values from decimal strings.

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

The input string is parsed as a decimal number and scaled by 2 ** fractionalBits to compute the raw bigint. Values that cannot be represented exactly in binary (such as "0.1") trigger the rounding behaviour documented on RoundingMode, with 'strict' throwing SOLANA_ERROR__FIXED_POINTS__STRICT_MODE_PRECISION_LOSS by default.

Type Parameters

Parameters

Returns

(input, rounding?): BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>;

Parameters

Returns

BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>

Example

const audioSample = binaryFixedPoint('signed', 16, 15);
audioSample('0.5');          // raw === 16384n (exact)
audioSample('0.1');          // throws under the default 'strict' mode
audioSample('0.1', 'round'); // raw === 3277n

See

• BinaryFixedPoint
• rawBinaryFixedPoint
• ratioBinaryFixedPoint