Class BCH

BCH (Bose-Chaudhuri-Hocquenghem) Error Correction Code class.

Index

Constructors

constructor

new BCH(t: number, poly: number): BCH
Initializes the ECC state with given parameters.
Parameters
- t: number
  Number of error correctable bits, max number of bit flips we can account for, increasing this increase the ecc length
- poly: number
  The polynomial used for ECC.
Returns BCH
- Defined in bchecc.ts:23

Properties

ECCstate

ECCstate: any

Methods

buildCyclic

buildCyclic(g: bigint[]): void
Builds a cyclic table for error correction.
Parameters
- g: bigint[]
  The generator polynomial.
Returns void
- Defined in bchecc.ts:532

ceilop

ceilop(a: number, b: number): number
Computes the ceiling of the division of two integers.
Parameters
- a: number
  The dividend.
- b: number
  The divisor.
Returns number
The ceiling of the division of a by b.
- Defined in bchecc.ts:699

convertAllBitsToBigInts

convertAllBitsToBigInts(bitArray: number[], chunkSize: number): bigint[]
Processes an array of bits in chunks, converting each chunk into a BigInt.
Parameters
- bitArray: number[]
  The array of bits to process.
- chunkSize: number
  The size of each chunk of bits to process.
Returns bigint[]
- An array of BigInt values representing chunks of the original bit array.
- Defined in bchecc.ts:744

convertBitsToBigInt

convertBitsToBigInt(bitArray: number[], bitLimit: number): bigint
Converts an array of bits into a single BigInt value.
Parameters
- bitArray: number[]
  The array of bits to convert.
- bitLimit: number
  The maximum number of bits to process.
Returns bigint
- The combined value of all bits in the array.
- Defined in bchecc.ts:723

convertBytesToBigInt

convertBytesToBigInt(byteArray: bigint[]): bigint
Converts an array of up to 4 bytes into a single BigInt value.
Parameters
- byteArray: bigint[]
  The array of bytes to convert.
Returns bigint
- The combined value of the bytes as a BigInt.
- Defined in bchecc.ts:772

decode

decode(data: number[], recvecc: number[]): any
Decodes the data and corrects errors using ECC.
Parameters
- data: number[]
  The input data array.
- recvecc: number[]
  The received ECC data.
Returns any
- The corrected data and status.
- Defined in bchecc.ts:256

deg

deg(x: number): number
Computes the degree of a polynomial represented as an integer.
Parameters
- x: number
  The polynomial represented as an integer.
Returns number
The degree of the polynomial.
- Defined in bchecc.ts:684

degBigInt

degBigInt(x: bigint): number
Computes the degree of a polynomial represented as a BigInt.
Parameters
- x: bigint
  The polynomial represented as a BigInt.
Returns number
The degree of the polynomial.
- Defined in bchecc.ts:708

encode

encode(data: number[]): Uint8Array
Encodes the data and generates ECC bytes.
Parameters
- data: number[]
  The input data array.
Returns Uint8Array
- The generated ECC bytes.
- Defined in bchecc.ts:164

g_div

g_div(instance: any, a: number, b: number): number
Divides two values in a Galois field.
Parameters
- instance: any
  The current context containing Galois field parameters.
- a: number
  The dividend.
- b: number
  The divisor.
Returns number
The quotient of the division in the Galois field.
- Defined in bchecc.ts:640

g_log

g_log(instance: any, x: number): number
Computes the logarithm of a value in a Galois field.
Parameters
- instance: any
  The current context containing Galois field parameters.
- x: number
  The value whose logarithm is to be computed.
Returns number
The logarithm of the value in the Galois field.
- Defined in bchecc.ts:613

g_mul

g_mul(instance: any, a: number, b: number): number
Multiplies two values in a Galois field.
Parameters
- instance: any
  The current context containing Galois field parameters.
- a: number
  The first value to be multiplied.
- b: number
  The second value to be multiplied.
Returns number
The product of the two values in the Galois field.
- Defined in bchecc.ts:624

g_pow

g_pow(instance: any, i: number): number
Computes the power of a value in a Galois field.
Parameters
- instance: any
  The current context containing Galois field parameters.
- i: number
  The exponent value.
Returns number
The result of raising a value to the power i in the Galois field.
- Defined in bchecc.ts:589

g_sqrt

g_sqrt(instance: any, a: number): number
Computes the square root of a value in a Galois field.
Parameters
- instance: any
  The current context containing Galois field parameters.
- a: number
  The value whose square root is to be computed.
Returns number
The square root of the value in the Galois field.
- Defined in bchecc.ts:599

getEccBits

getEccBits(): number
Gets the number of ECC bits.

Returns number
- The number of ECC bits.
- Defined in bchecc.ts:516

getEccBytes

getEccBytes(): number
Gets the number of ECC bytes.

Returns number
- The number of ECC bytes.
- Defined in bchecc.ts:524

getRoots

getRoots(instance: any, k: number, poly: any): number
Finds the roots of a polynomial.
Parameters
- instance: any
  The instance of the ECC state.
- k: number
  The degree of the polynomial.
- poly: any
  The polynomial.
Returns number
- The number of roots found.
- Defined in bchecc.ts:428

mod

mod(instance: any, v: number): number
Reduces a value modulo the Galois field size.
Parameters
- instance: any
  The current context containing Galois field parameters.
- v: number
  The value to be reduced.
Returns number
The value reduced modulo the Galois field size.
- Defined in bchecc.ts:656

modn

modn(instance: any, v: number): number
Reduces a value modulo the Galois field size.
Parameters
- instance: any
  The current context containing Galois field parameters.
- v: number
  The value to be reduced.
Returns number
The value reduced modulo the Galois field size.
- Defined in bchecc.ts:670

numberToBinaryString

numberToBinaryString(num: number, length: number): string
Converts a number to a binary string of a given length.
Parameters
- num: number
  The number to convert.
- length: number
  The desired length of the binary string.
Returns string
- The binary string representation of the number.
- Defined in bchecc.ts:805

toAsciiString

toAsciiString(data: any[]): string
Decodes a Uint8Array to a string using 7-bit ASCII encoding.
Parameters
- data: any[]
  The input byte array.
Returns string
- The decoded string.
- Defined in bchecc.ts:818

toBinString

toBinString(dataout: any[], datalen: number): string
Generates a binary string from data.
Parameters
- dataout: any[]
  The data output array.
- datalen: number
  The desired length of the binary string.
Returns string
- The binary string representation of the data.
- Defined in bchecc.ts:790

toHexString

toHexString(data: any[], datalen: number): string
Converts an array of numbers to a hexadecimal string.
Parameters
- data: any[]
  The array of numbers to convert.
- datalen: number
Returns string
- The hexadecimal string representation of the numbers.
- Defined in bchecc.ts:841