Header menu logo issie

NumberHelpers Module

Nested modules

Modules Description

Constants

Functions and values

Function or value Description

BigIntToPaddedString maxChars radix width fd

Full Usage: BigIntToPaddedString maxChars radix width fd

Parameters:
    maxChars : int
    radix : NumberBase
    width : int
    fd : bigint

Returns: string
maxChars : int
radix : NumberBase
width : int
fd : bigint
Returns: string

UInt32ToPaddedString maxChars radix width fd

Full Usage: UInt32ToPaddedString maxChars radix width fd

Parameters:
    maxChars : int
    radix : NumberBase
    width : int
    fd : uint32

Returns: string
maxChars : int
radix : NumberBase
width : int
fd : uint32
Returns: string

addCommasAndZeros width printedChars

Full Usage: addCommasAndZeros width printedChars

Parameters:
    width : int
    printedChars : string

Returns: string

Format a hex or bin printed string adding commas every 4 digits. If pad with 0s up to width bits. if width = 0 work ok with no padding

width : int
printedChars : string
Returns: string

addZeros width pFun n

Full Usage: addZeros width pFun n

Parameters:
    width : int
    pFun : int -> string
    n : int

Returns: string
width : int
pFun : int -> string
n : int
Returns: string

addZeros64 width pFun n

Full Usage: addZeros64 width pFun n

Parameters:
    width : int
    pFun : int64 -> string
    n : int64

Returns: string
width : int
pFun : int64 -> string
n : int64
Returns: string

big16

Full Usage: big16

Returns: BigInteger
Returns: BigInteger

big32

Full Usage: big32

Returns: BigInteger
Returns: BigInteger

big64

Full Usage: big64

Returns: BigInteger
Returns: BigInteger

big8

Full Usage: big8

Returns: BigInteger
Returns: BigInteger

bigValToPaddedString width radix x

Full Usage: bigValToPaddedString width radix x

Parameters:
Returns: string

print a bignum according to a radix. if

width : int
radix : NumberBase
x : BigInteger
Returns: string

bigValToString radix x

Full Usage: bigValToString radix x

Parameters:
Returns: string
radix : NumberBase
x : BigInteger
Returns: string

bin num

Full Usage: bin num

Parameters:
    num : int

Returns: string
num : int
Returns: string

bin64 num

Full Usage: bin64 num

Parameters:
    num : int64

Returns: string
num : int64
Returns: string

bitToString bit

Full Usage: bitToString bit

Parameters:
Returns: string

Convert a bit to string.

bit : Bit
Returns: string

checkWidth width num

Full Usage: checkWidth width num

Parameters:
    width : int
    num : int64

Returns: string option

Check a number is formed by at most bits.

width : int
num : int64
Returns: string option

convertBigIntToInt32 b

Full Usage: convertBigIntToInt32 b

Parameters:
    b : bigint

Returns: int32
b : bigint
Returns: int32

convertBigIntToUInt64 w b

Full Usage: convertBigIntToUInt64 w b

Parameters:
    w : int
    b : bigint

Returns: uint64
w : int
b : bigint
Returns: uint64

convertBigintToFastData width b

Full Usage: convertBigintToFastData width b

Parameters:
    width : int
    b : bigint

Returns: FastData
width : int
b : bigint
Returns: FastData

convertBinToDec bits

Full Usage: convertBinToDec bits

Parameters:
    bits : string

Returns: int64
bits : string
Returns: int64

convertFastDataToBigint d

Full Usage: convertFastDataToBigint d

Parameters:
Returns: bigint

convert to a bigint - always works. Bits < width will be correct.

d : FastData
Returns: bigint

convertFastDataToInt d

Full Usage: convertFastDataToInt d

Parameters:
Returns: uint32

convert to int with an exception if data is too large

d : FastData
Returns: uint32

convertFastDataToInt32 d

Full Usage: convertFastDataToInt32 d

Parameters:
Returns: int32

Lossy conversion of bigint to int32 without exceptions TODO: chnage this - and all dependencies with 32 bit int - to int64

d : FastData
Returns: int32

convertFastDataToInt64 d

Full Usage: convertFastDataToInt64 d

Parameters:
Returns: uint64

convert to 64 bits - if too large take LS 64 bits

d : FastData
Returns: uint64

convertFastDataToWireData fastDat

Full Usage: convertFastDataToWireData fastDat

Parameters:
Returns: WireData
fastDat : FastData
Returns: WireData

convertInt64ToBigInt width n

Full Usage: convertInt64ToBigInt width n

Parameters:
    width : int
    n : int64

Returns: BigInteger
width : int
n : int64
Returns: BigInteger

convertInt64ToFastData width n

Full Usage: convertInt64ToFastData width n

Parameters:
    width : int
    n : int64

Returns: FastData
width : int
n : int64
Returns: FastData

convertInt64ToUInt32 width n

Full Usage: convertInt64ToUInt32 width n

Parameters:
    width : int
    n : int64

Returns: uint32
width : int
n : int64
Returns: uint32

convertIntToFastData width n

Full Usage: convertIntToFastData width n

Parameters:
    width : int
    n : uint32

Returns: FastData
width : int
n : uint32
Returns: FastData

convertIntToWireData width num

Full Usage: convertIntToWireData width num

Parameters:
    width : int
    num : int64

Returns: WireData

Convert an int into a Bit list with the provided width. The Least Significant Bits are the one with low index (e.g. LSB is at position 0, MSB is at position N). Little Endian. If the number has more bits than width, then more bits will be returned.

width : int
num : int64
Returns: WireData

convertWireDataToFastData wd

Full Usage: convertWireDataToFastData wd

Parameters:
Returns: FastData
wd : WireData
Returns: FastData

convertWireDataToInt bits

Full Usage: convertWireDataToInt bits

Parameters:
Returns: int64

Convert a list of Bits into an int. The Least Significant Bits are the one with low index (e.g. LSB is at position 0, MSB is at position N). Little Endian.

bits : WireData
Returns: int64

dec num

Full Usage: dec num

Parameters:
    num : int

Returns: string
num : int
Returns: string

dec64 num

Full Usage: dec64 num

Parameters:
    num : int64

Returns: string
num : int64
Returns: string

emptyFastData

Full Usage: emptyFastData

Returns: FastData
Returns: FastData

fastDataToPaddedString maxChars radix fd

Full Usage: fastDataToPaddedString maxChars radix fd

Parameters:
Returns: string
maxChars : int
radix : NumberBase
fd : FastData
Returns: string

fillBin width

Full Usage: fillBin width

Parameters:
    width : int

Returns: int -> string
width : int
Returns: int -> string

fillBin64 width

Full Usage: fillBin64 width

Parameters:
    width : int

Returns: int64 -> string
width : int
Returns: int64 -> string

fillHex width

Full Usage: fillHex width

Parameters:
    width : int

Returns: int -> string
width : int
Returns: int -> string

fillHex64 width

Full Usage: fillHex64 width

Parameters:
    width : int

Returns: int64 -> string
width : int
Returns: int64 -> string

hex num

Full Usage: hex num

Parameters:
    num : int

Returns: string
num : int
Returns: string

hex64 num

Full Usage: hex64 num

Parameters:
    num : int64

Returns: string
num : int64
Returns: string

sDec64 num

Full Usage: sDec64 num

Parameters:
    num : int64

Returns: string
num : int64
Returns: string

strToInt str

Full Usage: strToInt str

Parameters:
    str : string

Returns: Result<int64, string>

Try to convert a string to an int, or return an error message if that was not possible.

str : string
Returns: Result<int64, string>

strToIntCheckWidth width str

Full Usage: strToIntCheckWidth width str

Parameters:
    width : int
    str : string

Returns: Result<int64, string>

Convert a string to a number making sure that it has no more bits than specified in width.

width : int
str : string
Returns: Result<int64, string>

toDecimal num numBase width

Full Usage: toDecimal num numBase width

Parameters:
    num : string
    numBase : string
    width : string

Returns: int64

Converts a binary, hex or decimal number to decimal

num : string
numBase : string
width : string
Returns: int64

valToPaddedString width radix value

Full Usage: valToPaddedString width radix value

Parameters:
Returns: string

Convert int64 to string according to radix. binary and hex numbers are zero padded to width binary is displayed as hex if width > 8

width : int
radix : NumberBase
value : int64
Returns: string

valToString radix value

Full Usage: valToString radix value

Parameters:
Returns: string

Convert int64 to string according to provided radix

radix : NumberBase
value : int64
Returns: string

Type something to start searching.