Skip to main content

BitStringHelper

A collection of helper functions used throughout the module. They should be used by the users when working with dynamically-sized fields.

Index

Constructors

Methods

Constructors

constructor

Methods

staticcanFitSigned

  • canFitSigned(value: number, bits: number): boolean

  • Parameters

    • value: number

      an integer. The value to be encoded.

    • bits: number

      a non-negative integer between 0 and SAFE_INTEGER_BITS, inclusive. The amount of bits the value should be encoded in.

    Returns boolean

    Whether we can encode a signed value in bits bits.

staticcanFitUnsigned

  • canFitUnsigned(value: number, bits: number): boolean

  • Parameters

    • value: number

      a non-negative integer. The value to be encoded.

    • bits: number

      a non-negative integer between 0 and SAFE_INTEGER_BITS, inclusive. The amount of bits the value should be encoded in.

    Returns boolean

    Whether we can encode an unsigned value in bits bits.

staticgetBitsCountForSigned

  • getBitsCountForSigned(value: number): number

  • Parameters

    • value: number

      an integer. The value to be encoded.

    Returns number

    The minimal amount of bits required to encode a given signed value. For zero values returns zero.

staticgetBitsCountForUnsigned

  • getBitsCountForUnsigned(value: number): number

  • Parameters

    • value: number

      a non-negative integer. The value to be encoded.

    Returns number

    The minimal amount of bits required to encode a given unsigned value. For zero values returns zero.

staticmaxSignedInBits

  • maxSignedInBits(bits: number): number

  • The maximum signed number which can fit into a given number of bits.

    Parameters

    • bits: number

    Returns number

staticmaxUnsignedInBits

  • maxUnsignedInBits(bits: number): number

  • The maximum unsigned number which can fit into a given number of bits.

    Parameters

    • bits: number

    Returns number

staticminSignedInBits

  • minSignedInBits(bits: number): number

  • The minimum signed number which can fit into a given number of bits.

    Parameters

    • bits: number

    Returns number

Page Options