Class Numberu32

Hierarchy

BN
- Numberu32

Index

Constructors

constructor

Properties

BN wordSize

Constructors

constructor

new Numberu32(number, base?, endian?): Numberu32
Parameters
- number: string | number | number[] | Uint8Array | Buffer | BN
- Optional base: number | "hex"
- Optional endian: Endianness
Returns Numberu32
Inherited from BN.constructor
- Defined in node_modules/@types/bn.js/index.d.ts:25
new Numberu32(number, endian?): Numberu32
Parameters
- number: string | number | number[] | Uint8Array | Buffer | BN
- Optional endian: Endianness
Returns Numberu32
Inherited from BN.constructor
- Defined in node_modules/@types/bn.js/index.d.ts:30

Properties

`Static` BN

BN: typeof BN

`Static` wordSize

wordSize: 26

Methods

abs

abs(): BN
Returns BN
Description
absolute value
Inherited from BN.abs
- Defined in node_modules/@types/bn.js/index.d.ts:228

add

add(b): BN
Parameters
- b: BN
Returns BN
Description
addition
Inherited from BN.add
- Defined in node_modules/@types/bn.js/index.d.ts:238

addn

addn(b): BN
Parameters
- b: number
Returns BN
Description
addition
Inherited from BN.addn
- Defined in node_modules/@types/bn.js/index.d.ts:248

and

and(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BN.and
- Defined in node_modules/@types/bn.js/index.d.ts:379

andln

andln(b): BN
Parameters
- b: number
Returns BN
Description
and (NOTE: andln is going to be replaced with andn in future)
Inherited from BN.andln
- Defined in node_modules/@types/bn.js/index.d.ts:399

bincn

bincn(b): BN
Parameters
- b: number
Returns BN
Description
add 1 << b to the number
Inherited from BN.bincn
- Defined in node_modules/@types/bn.js/index.d.ts:483

bitLength

bitLength(): number
Returns number
Description
get number of bits occupied
Inherited from BN.bitLength
- Defined in node_modules/@types/bn.js/index.d.ts:108

byteLength

byteLength(): number
Returns number
Description
return number of bytes occupied
Inherited from BN.byteLength
- Defined in node_modules/@types/bn.js/index.d.ts:118

clone

clone(): BN
Returns BN
Description
clone number
Inherited from BN.clone
- Defined in node_modules/@types/bn.js/index.d.ts:63

cmp

cmp(b): -1 | 0 | 1
Parameters
- b: BN
Returns -1 | 0 | 1
Description
compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result
Inherited from BN.cmp
- Defined in node_modules/@types/bn.js/index.d.ts:143

cmpn

cmpn(b): -1 | 0 | 1
Parameters
- b: number
Returns -1 | 0 | 1
Description
compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result
Inherited from BN.cmpn
- Defined in node_modules/@types/bn.js/index.d.ts:153

div

div(b): BN
Parameters
- b: BN
Returns BN
Description
divide
Inherited from BN.div
- Defined in node_modules/@types/bn.js/index.d.ts:313

divRound

divRound(b): BN
Parameters
- b: BN
Returns BN
Description
rounded division
Inherited from BN.divRound
- Defined in node_modules/@types/bn.js/index.d.ts:354

divmod

divmod(b, mode?, positive?): {
div: BN;
mod: BN;
}
Parameters
- b: BN
- Optional mode: "div" | "mod"
- Optional positive: boolean
Returns {
div: BN;
mod: BN;
}
- div: BN
- mod: BN
Description
division with remainder
Inherited from BN.divmod
- Defined in node_modules/@types/bn.js/index.d.ts:328

divn

divn(b): BN
Parameters
- b: number
Returns BN
Description
divide
Inherited from BN.divn
- Defined in node_modules/@types/bn.js/index.d.ts:318

egcd

egcd(b): {
    a: BN;
    b: BN;
    gcd: BN;
}
Parameters
- b: BN
Returns {
    a: BN;
    b: BN;
    gcd: BN;
}
- a: BN
- b: BN
- gcd: BN
Description
Extended GCD results ({ a: ..., b: ..., gcd: ... })
Inherited from BN.egcd
- Defined in node_modules/@types/bn.js/index.d.ts:503

eq

eq(b): boolean
Parameters
- b: BN
Returns boolean
Description
a equals b
Inherited from BN.eq
- Defined in node_modules/@types/bn.js/index.d.ts:198

eqn

eqn(b): boolean
Parameters
- b: number
Returns boolean
Description
a equals b
Inherited from BN.eqn
- Defined in node_modules/@types/bn.js/index.d.ts:203

fromTwos

fromTwos(width): BN
Parameters
- width: number
Returns BN
Description
convert from two's complement representation, where width is the bit width
Inherited from BN.fromTwos
- Defined in node_modules/@types/bn.js/index.d.ts:213

gcd

gcd(b): BN
Parameters
- b: BN
Returns BN
Description
GCD
Inherited from BN.gcd
- Defined in node_modules/@types/bn.js/index.d.ts:498

gt

gt(b): boolean
Parameters
- b: BN
Returns boolean
Description
a greater than b
Inherited from BN.gt
- Defined in node_modules/@types/bn.js/index.d.ts:178

gte

gte(b): boolean
Parameters
- b: BN
Returns boolean
Description
a greater than or equals b
Inherited from BN.gte
- Defined in node_modules/@types/bn.js/index.d.ts:188

gten

gten(b): boolean
Parameters
- b: number
Returns boolean
Description
a greater than or equals b
Inherited from BN.gten
- Defined in node_modules/@types/bn.js/index.d.ts:193

gtn

gtn(b): boolean
Parameters
- b: number
Returns boolean
Description
a greater than b
Inherited from BN.gtn
- Defined in node_modules/@types/bn.js/index.d.ts:183

iabs

iabs(): BN
Returns BN
Description
absolute value
Inherited from BN.iabs
- Defined in node_modules/@types/bn.js/index.d.ts:233

iadd

iadd(b): BN
Parameters
- b: BN
Returns BN
Description
addition
Inherited from BN.iadd
- Defined in node_modules/@types/bn.js/index.d.ts:243

iaddn

iaddn(b): BN
Parameters
- b: number
Returns BN
Description
addition
Inherited from BN.iaddn
- Defined in node_modules/@types/bn.js/index.d.ts:253

iand

iand(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BN.iand
- Defined in node_modules/@types/bn.js/index.d.ts:384

idivn

idivn(b): BN
Parameters
- b: number
Returns BN
Description
divide
Inherited from BN.idivn
- Defined in node_modules/@types/bn.js/index.d.ts:323

imaskn

imaskn(b): BN
Parameters
- b: number
Returns BN
Description
clear bits with indexes higher or equal to b
Inherited from BN.imaskn
- Defined in node_modules/@types/bn.js/index.d.ts:479

imul

imul(b): BN
Parameters
- b: BN
Returns BN
Description
multiply
Inherited from BN.imul
- Defined in node_modules/@types/bn.js/index.d.ts:283

imuln

imuln(b): BN
Parameters
- b: number
Returns BN
Description
multiply
Inherited from BN.imuln
- Defined in node_modules/@types/bn.js/index.d.ts:293

ineg

ineg(): BN
Returns BN
Description
negate sign
Inherited from BN.ineg
- Defined in node_modules/@types/bn.js/index.d.ts:223

inotn

inotn(w): BN
Parameters
- w: number
Returns BN
Description
not (for the width specified by w)
Inherited from BN.inotn
- Defined in node_modules/@types/bn.js/index.d.ts:493

invm

invm(b): BN
Parameters
- b: BN
Returns BN
Description
inverse a modulo b
Inherited from BN.invm
- Defined in node_modules/@types/bn.js/index.d.ts:508

ior

ior(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BN.ior
- Defined in node_modules/@types/bn.js/index.d.ts:364

isEven

isEven(): boolean
Returns boolean
Description
check if value is even
Inherited from BN.isEven
- Defined in node_modules/@types/bn.js/index.d.ts:128

isNeg

isNeg(): boolean
Returns boolean
Description
true if the number is negative
Inherited from BN.isNeg
- Defined in node_modules/@types/bn.js/index.d.ts:123

isOdd

isOdd(): boolean
Returns boolean
Description
check if value is odd
Inherited from BN.isOdd
- Defined in node_modules/@types/bn.js/index.d.ts:133

isZero

isZero(): boolean
Returns boolean
Description
check if value is zero
Inherited from BN.isZero
- Defined in node_modules/@types/bn.js/index.d.ts:138

ishln

ishln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BN.ishln
- Defined in node_modules/@types/bn.js/index.d.ts:434

ishrn

ishrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)
Inherited from BN.ishrn
- Defined in node_modules/@types/bn.js/index.d.ts:454

isqr

isqr(): BN
Returns BN
Description
square
Inherited from BN.isqr
- Defined in node_modules/@types/bn.js/index.d.ts:303

isub

isub(b): BN
Parameters
- b: BN
Returns BN
Description
subtraction
Inherited from BN.isub
- Defined in node_modules/@types/bn.js/index.d.ts:263

isubn

isubn(b): BN
Parameters
- b: number
Returns BN
Description
subtraction
Inherited from BN.isubn
- Defined in node_modules/@types/bn.js/index.d.ts:273

iuand

iuand(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BN.iuand
- Defined in node_modules/@types/bn.js/index.d.ts:394

iuor

iuor(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BN.iuor
- Defined in node_modules/@types/bn.js/index.d.ts:374

iushln

iushln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BN.iushln
- Defined in node_modules/@types/bn.js/index.d.ts:444

iushrn

iushrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
Inherited from BN.iushrn
- Defined in node_modules/@types/bn.js/index.d.ts:464

iuxor

iuxor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BN.iuxor
- Defined in node_modules/@types/bn.js/index.d.ts:419

ixor

ixor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BN.ixor
- Defined in node_modules/@types/bn.js/index.d.ts:409

lt

lt(b): boolean
Parameters
- b: BN
Returns boolean
Description
a less than b
Inherited from BN.lt
- Defined in node_modules/@types/bn.js/index.d.ts:158

lte

lte(b): boolean
Parameters
- b: BN
Returns boolean
Description
a less than or equals b
Inherited from BN.lte
- Defined in node_modules/@types/bn.js/index.d.ts:168

lten

lten(b): boolean
Parameters
- b: number
Returns boolean
Description
a less than or equals b
Inherited from BN.lten
- Defined in node_modules/@types/bn.js/index.d.ts:173

ltn

ltn(b): boolean
Parameters
- b: number
Returns boolean
Description
a less than b
Inherited from BN.ltn
- Defined in node_modules/@types/bn.js/index.d.ts:163

maskn

maskn(b): BN
Parameters
- b: number
Returns BN
Description
clear bits with indexes higher or equal to b
Inherited from BN.maskn
- Defined in node_modules/@types/bn.js/index.d.ts:474

mod

mod(b): BN
Parameters
- b: BN
Returns BN
Description
reduct
Inherited from BN.mod
- Defined in node_modules/@types/bn.js/index.d.ts:333

modn

modn(b): number
Parameters
- b: number
Returns number
Deprecated
Description
reduct
Inherited from BN.modn
- Defined in node_modules/@types/bn.js/index.d.ts:344

modrn

modrn(b): number
Parameters
- b: number
Returns number
Description
reduct
Inherited from BN.modrn
- Defined in node_modules/@types/bn.js/index.d.ts:349

mul

mul(b): BN
Parameters
- b: BN
Returns BN
Description
multiply
Inherited from BN.mul
- Defined in node_modules/@types/bn.js/index.d.ts:278

muln

muln(b): BN
Parameters
- b: number
Returns BN
Description
multiply
Inherited from BN.muln
- Defined in node_modules/@types/bn.js/index.d.ts:288

neg

neg(): BN
Returns BN
Description
negate sign
Inherited from BN.neg
- Defined in node_modules/@types/bn.js/index.d.ts:218

notn

notn(w): BN
Parameters
- w: number
Returns BN
Description
not (for the width specified by w)
Inherited from BN.notn
- Defined in node_modules/@types/bn.js/index.d.ts:488

or

or(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BN.or
- Defined in node_modules/@types/bn.js/index.d.ts:359

pow

pow(b): BN
Parameters
- b: BN
Returns BN
Description
raise a to the power of b
Inherited from BN.pow
- Defined in node_modules/@types/bn.js/index.d.ts:308

setn

setn(b, value): BN
Parameters
- b: number
- value: boolean | 0 | 1
Returns BN
Description
set specified bit to value
Inherited from BN.setn
- Defined in node_modules/@types/bn.js/index.d.ts:424

shln

shln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BN.shln
- Defined in node_modules/@types/bn.js/index.d.ts:429

shrn

shrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
Inherited from BN.shrn
- Defined in node_modules/@types/bn.js/index.d.ts:449

sqr

sqr(): BN
Returns BN
Description
square
Inherited from BN.sqr
- Defined in node_modules/@types/bn.js/index.d.ts:298

sub

sub(b): BN
Parameters
- b: BN
Returns BN
Description
subtraction
Inherited from BN.sub
- Defined in node_modules/@types/bn.js/index.d.ts:258

subn

subn(b): BN
Parameters
- b: number
Returns BN
Description
subtraction
Inherited from BN.subn
- Defined in node_modules/@types/bn.js/index.d.ts:268

testn

testn(b): boolean
Parameters
- b: number
Returns boolean
Description
test if specified bit is set
Inherited from BN.testn
- Defined in node_modules/@types/bn.js/index.d.ts:469

toArray

toArray(endian?, length?): number[]
Parameters
- Optional endian: Endianness
- Optional length: number
Returns number[]
Description
convert to byte Array, and optionally zero pad to length, throwing if already exceeding
Inherited from BN.toArray
- Defined in node_modules/@types/bn.js/index.d.ts:83

toArrayLike

toArrayLike(ArrayType, endian?, length?): Buffer
Parameters
- ArrayType: BufferConstructor
- Optional endian: Endianness
- Optional length: number
Returns Buffer
Description
convert to an instance of type, which must behave like an Array
Inherited from BN.toArrayLike
- Defined in node_modules/@types/bn.js/index.d.ts:88
toArrayLike(ArrayType, endian?, length?): any[]
Parameters
- ArrayType: any[]
- Optional endian: Endianness
- Optional length: number
Returns any[]
Inherited from BN.toArrayLike
- Defined in node_modules/@types/bn.js/index.d.ts:94

toBuffer

toBuffer(): Buffer
Convert to Buffer representation

Returns Buffer
Overrides BN.toBuffer
- Defined in src/util/scoreHelpers.ts:65

toJSON

toJSON(): string
Returns string
Description
convert to JSON compatible hex string (alias of toString(16))
Inherited from BN.toJSON
- Defined in node_modules/@types/bn.js/index.d.ts:78

toNumber

toNumber(): number
Returns number
Description
convert to Javascript Number (limited to 53 bits)
Inherited from BN.toNumber
- Defined in node_modules/@types/bn.js/index.d.ts:73

toRed

toRed(reductionContext): RedBN
Parameters
- reductionContext: ReductionContext
Returns RedBN
Description
Convert number to red
Inherited from BN.toRed
- Defined in node_modules/@types/bn.js/index.d.ts:513

toString

toString(base?, length?): string
Parameters
- Optional base: number | "hex"
- Optional length: number
Returns string
Description
convert to base-string and pad with zeroes
Inherited from BN.toString
- Defined in node_modules/@types/bn.js/index.d.ts:68

toTwos

toTwos(width): BN
Parameters
- width: number
Returns BN
Description
convert to two's complement representation, where width is bit width
Inherited from BN.toTwos
- Defined in node_modules/@types/bn.js/index.d.ts:208

uand

uand(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BN.uand
- Defined in node_modules/@types/bn.js/index.d.ts:389

ucmp

ucmp(b): -1 | 0 | 1
Parameters
- b: BN
Returns -1 | 0 | 1
Description
compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result
Inherited from BN.ucmp
- Defined in node_modules/@types/bn.js/index.d.ts:148

umod

umod(b): BN
Parameters
- b: BN
Returns BN
Description
reduct
Inherited from BN.umod
- Defined in node_modules/@types/bn.js/index.d.ts:338

uor

uor(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BN.uor
- Defined in node_modules/@types/bn.js/index.d.ts:369

ushln

ushln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BN.ushln
- Defined in node_modules/@types/bn.js/index.d.ts:439

ushrn

ushrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
Inherited from BN.ushrn
- Defined in node_modules/@types/bn.js/index.d.ts:459

uxor

uxor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BN.uxor
- Defined in node_modules/@types/bn.js/index.d.ts:414

xor

xor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BN.xor
- Defined in node_modules/@types/bn.js/index.d.ts:404

zeroBits

zeroBits(): number
Returns number
Description
return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)
Inherited from BN.zeroBits
- Defined in node_modules/@types/bn.js/index.d.ts:113

`Static` fromBuffer

fromBuffer(buffer): BN
Construct a Numberu32 from Buffer representation
Parameters
- buffer: any
Returns BN
- Defined in src/util/scoreHelpers.ts:80

`Static` isBN

isBN(b): b is BN
Parameters
- b: any
Returns b is BN
Description
returns true if the supplied object is a BN.js instance
Inherited from BN.isBN
- Defined in node_modules/@types/bn.js/index.d.ts:48

`Static` max

max(left, right): BN
Parameters
- left: BN
- right: BN
Returns BN
Description
returns the maximum of 2 BN instances.
Inherited from BN.max
- Defined in node_modules/@types/bn.js/index.d.ts:53

`Static` min

min(left, right): BN
Parameters
- left: BN
- right: BN
Returns BN
Description
returns the minimum of 2 BN instances.
Inherited from BN.min
- Defined in node_modules/@types/bn.js/index.d.ts:58

`Static` mont

mont(num): ReductionContext
Parameters
- num: BN
Returns ReductionContext
Description
create a reduction context with the Montgomery trick.
Inherited from BN.mont
- Defined in node_modules/@types/bn.js/index.d.ts:43

`Static` red

red(reductionContext): ReductionContext
Parameters
- reductionContext: IPrimeName | BN
Returns ReductionContext
Description
create a reduction context
Inherited from BN.red
- Defined in node_modules/@types/bn.js/index.d.ts:38

Class Numberu32

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Numberu32

Parameters

Returns Numberu32

Properties

Static BN

Static wordSize

Methods

abs

Returns BN

Description

add

Parameters

Returns BN

Description

addn

Parameters

Returns BN

Description

and

Parameters

Returns BN

Description

andln

Parameters

Returns BN

Description

bincn

Parameters

Returns BN

Description

bitLength

Returns number

Description

byteLength

Returns number

Description

clone

Returns BN

Description

cmp

Parameters

Returns -1 | 0 | 1

Description

cmpn

Parameters

Returns -1 | 0 | 1

Description

div

Parameters

Returns BN

Description

divRound

Parameters

Returns BN

Description

divmod

Parameters

Returns { div: BN; mod: BN; }

div: BN

mod: BN

Description

divn

Parameters

Returns BN

Description

egcd

Parameters

Returns { a: BN; b: BN; gcd: BN; }

a: BN

b: BN

gcd: BN

`Static` BN

`Static` wordSize

Returns {
div: BN;
mod: BN;
}

Returns {
a: BN;
b: BN;
gcd: BN;
}