utils

package
v0.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 11, 2023 License: Apache-2.0 Imports: 8 Imported by: 1

Documentation

Index

Constants

View Source 
const (

	// number of decimal places
	Precision = 6

	// bytes required to represent the above precision
	// Ceiling[Log2[999 999 999 999 999 999]]
	DecimalPrecisionBits = 60
)
View Source 
const (
	FisDenom = "ufis"
)

Variables

View Source 
var (
	ErrEmptyDecimalStr      = errors.New("decimal string cannot be empty")
	ErrInvalidDecimalLength = errors.New("invalid decimal length")
	ErrInvalidDecimalStr    = errors.New("invalid decimal string")
)

Decimal errors

View Source 
var MaxSortableDec = OneDec().Quo(SmallestDec())

MaxSortableDec is the largest Dec that can be passed into SortableDecBytes() Its negative form is the least Dec that can be passed in.

Functions

func DecEq 

func DecEq(t *testing.T, exp, got Dec) (*testing.T, bool, string, string, string)

intended to be used with require/assert: require.True(DecEq(...))

func DecsEqual 

func DecsEqual(d1s, d2s []Dec) bool

test if two decimal arrays are equal

func SortableDecBytes 

func SortableDecBytes(dec Dec) []byte

SortableDecBytes returns a byte slice representation of a Dec that can be sorted. Left and right pads with 0s so there are 18 digits to left and right of the decimal point. For this reason, there is a maximum and minimum value for this, enforced by ValidSortableDec.

func ValidSortableDec 

func ValidSortableDec(dec Dec) bool

ValidSortableDec ensures that a Dec is within the sortable bounds, a Dec can't have a precision of less than 10^-18. Max sortable decimal was set to the reciprocal of SmallestDec.

Types

type CustomProtobufType 

type CustomProtobufType interface {
	Marshal() ([]byte, error)
	MarshalTo(data []byte) (n int, err error)
	Unmarshal(data []byte) error
	Size() int

	MarshalJSON() ([]byte, error)
	UnmarshalJSON(data []byte) error
}

CustomProtobufType defines the interface custom gogo proto types must implement in order to be used as a "customtype" extension.

ref: https://github.com/gogo/protobuf/blob/master/custom_types.md

type Dec 

type Dec struct {
	// contains filtered or unexported fields
}

NOTE: never use new(Dec) or else we will panic unmarshalling into the nil embedded big.Int

func MaxDec 

func MaxDec(d1, d2 Dec) Dec

maximum decimal between two

func MinDec 

func MinDec(d1, d2 Dec) Dec

minimum decimal between two

func MustNewDecFromStr 

func MustNewDecFromStr(s string) Dec

Decimal from string, panic on error

func NewDec 

func NewDec(i int64) Dec

create a new Dec from integer assuming whole number

func NewDecFromBigInt 

func NewDecFromBigInt(i *big.Int) Dec

create a new Dec from big integer assuming whole numbers CONTRACT: prec <= Precision

func NewDecFromBigIntWithPrec 

func NewDecFromBigIntWithPrec(i *big.Int, prec int64) Dec

create a new Dec from big integer assuming whole numbers CONTRACT: prec <= Precision

func NewDecFromInt 

func NewDecFromInt(i sdk.Int) Dec

create a new Dec from big integer assuming whole numbers CONTRACT: prec <= Precision

func NewDecFromIntWithPrec 

func NewDecFromIntWithPrec(i sdk.Int, prec int64) Dec

create a new Dec from big integer with decimal place at prec CONTRACT: prec <= Precision

func NewDecFromStr 

func NewDecFromStr(str string) (Dec, error)

create a decimal from an input decimal string. valid must come in the form: 

(-) whole integers (.) decimal integers

examples of acceptable input include: 

-123.456
456.7890
345
-456789

NOTE - An error will return if more decimal places are provided in the string than the constant Precision.

CONTRACT - This function does not mutate the input str.

func NewDecWithPrec 

func NewDecWithPrec(i, prec int64) Dec

create a new Dec from integer with decimal place at prec CONTRACT: prec <= Precision

func OneDec 

func OneDec() Dec

func SmallestDec 

func SmallestDec() Dec

func ZeroDec 

func ZeroDec() Dec

func (Dec) Abs 

func (d Dec) Abs() Dec

func (Dec) Add 

func (d Dec) Add(d2 Dec) Dec

addition

func (Dec) ApproxRoot 

func (d Dec) ApproxRoot(root uint64) (guess Dec, err error)

ApproxRoot returns an approximate estimation of a Dec's positive real nth root using Newton's method (where n is positive). The algorithm starts with some guess and computes the sequence of improved guesses until an answer converges to an approximate answer. It returns `|d|.ApproxRoot() * -1` if input is negative. A maximum number of 100 iterations is used a backup boundary condition for cases where the answer never converges enough to satisfy the main condition.

func (Dec) ApproxSqrt 

func (d Dec) ApproxSqrt() (Dec, error)

ApproxSqrt is a wrapper around ApproxRoot for the common special case of finding the square root of a number. It returns -(sqrt(abs(d)) if input is negative.

func (Dec) BigInt 

func (d Dec) BigInt() *big.Int

BigInt returns a copy of the underlying big.Int.

func (Dec) Ceil 

func (d Dec) Ceil() Dec

Ceil returns the smallest interger value (as a decimal) that is greater than or equal to the given decimal.

func (Dec) Equal 

func (d Dec) Equal(d2 Dec) bool

func (Dec) Float64 

func (d Dec) Float64() (float64, error)

Float64 returns the float64 representation of a Dec. Will return the error if the conversion failed.

func (Dec) Format 

func (d Dec) Format(s fmt.State, verb rune)

format decimal state

func (Dec) GT 

func (d Dec) GT(d2 Dec) bool

func (Dec) GTE 

func (d Dec) GTE(d2 Dec) bool

func (Dec) IsInteger 

func (d Dec) IsInteger() bool

is integer, e.g. decimals are zero

func (Dec) IsNegative 

func (d Dec) IsNegative() bool

func (Dec) IsNil 

func (d Dec) IsNil() bool

func (Dec) IsPositive 

func (d Dec) IsPositive() bool

func (Dec) IsZero 

func (d Dec) IsZero() bool

func (Dec) LT 

func (d Dec) LT(d2 Dec) bool

func (Dec) LTE 

func (d Dec) LTE(d2 Dec) bool

func (Dec) Marshal 

func (d Dec) Marshal() ([]byte, error)

Marshal implements the gogo proto custom type interface.

func (Dec) MarshalAmino 

func (d Dec) MarshalAmino() ([]byte, error)

Override Amino binary serialization by proxying to protobuf.

func (Dec) MarshalJSON 

func (d Dec) MarshalJSON() ([]byte, error)

MarshalJSON marshals the decimal

func (*Dec) MarshalTo 

func (d *Dec) MarshalTo(data []byte) (n int, err error)

MarshalTo implements the gogo proto custom type interface.

func (Dec) MarshalYAML 

func (d Dec) MarshalYAML() (interface{}, error)

MarshalYAML returns the YAML representation.

func (Dec) Mul 

func (d Dec) Mul(d2 Dec) Dec

multiplication

func (Dec) MulInt 

func (d Dec) MulInt(i sdk.Int) Dec

multiplication

func (Dec) MulInt64 

func (d Dec) MulInt64(i int64) Dec

MulInt64 - multiplication with int64

func (Dec) MulTruncate 

func (d Dec) MulTruncate(d2 Dec) Dec

multiplication truncate

func (Dec) MustFloat64 

func (d Dec) MustFloat64() float64

MustFloat64 returns the float64 representation of a Dec. Would panic if the conversion failed.

func (Dec) Neg 

func (d Dec) Neg() Dec

func (Dec) Power 

func (d Dec) Power(power uint64) Dec

Power returns a the result of raising to a positive integer power

func (Dec) Quo 

func (d Dec) Quo(d2 Dec) Dec

quotient

func (Dec) QuoInt 

func (d Dec) QuoInt(i sdk.Int) Dec

quotient

func (Dec) QuoInt64 

func (d Dec) QuoInt64(i int64) Dec

QuoInt64 - quotient with int64

func (Dec) QuoRoundUp 

func (d Dec) QuoRoundUp(d2 Dec) Dec

quotient, round up

func (Dec) QuoTruncate 

func (d Dec) QuoTruncate(d2 Dec) Dec

quotient truncate

func (Dec) RoundInt 

func (d Dec) RoundInt() sdk.Int

RoundInt round the decimal using bankers rounding

func (Dec) RoundInt64 

func (d Dec) RoundInt64() int64

RoundInt64 rounds the decimal using bankers rounding

func (*Dec) Size 

func (d *Dec) Size() int

Size implements the gogo proto custom type interface.

func (Dec) String 

func (d Dec) String() string

func (Dec) Sub 

func (d Dec) Sub(d2 Dec) Dec

subtraction

func (Dec) TruncateDec 

func (d Dec) TruncateDec() Dec

TruncateDec truncates the decimals from the number and returns a Dec

func (Dec) TruncateInt 

func (d Dec) TruncateInt() sdk.Int

TruncateInt truncates the decimals from the number and returns an Int

func (Dec) TruncateInt64 

func (d Dec) TruncateInt64() int64

TruncateInt64 truncates the decimals from the number and returns an int64

func (*Dec) Unmarshal 

func (d *Dec) Unmarshal(data []byte) error

Unmarshal implements the gogo proto custom type interface.

func (*Dec) UnmarshalAmino 

func (d *Dec) UnmarshalAmino(bz []byte) error

func (*Dec) UnmarshalJSON 

func (d *Dec) UnmarshalJSON(bz []byte) error

UnmarshalJSON defines custom decoding scheme

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.