Documentation ¶
Index ¶
- Constants
- Variables
- func AbsDifferenceWithSign(a, b sdk.Dec) (sdk.Dec, bool)
- func DecApproxEq(t *testing.T, d1 BigDec, d2 BigDec, tol BigDec) (*testing.T, bool, string, string, string)
- func DecEq(t *testing.T, exp, got BigDec) (*testing.T, bool, string, string, string)
- func DecsEqual(d1s, d2s []BigDec) bool
- func GetPowPrecision() sdk.Dec
- func IntEq(t *testing.T, exp, got BigInt) (*testing.T, bool, string, string, string)
- func Pow(base sdk.Dec, exp sdk.Dec) sdk.Dec
- func PowApprox(base sdk.Dec, exp sdk.Dec, precision sdk.Dec) sdk.Dec
- func SigFigRound(d sdk.Dec, tenToSigFig sdk.Int) sdk.Dec
- func SortableDecBytes(dec BigDec) []byte
- func ValidSortableDec(dec BigDec) bool
- type BigDec
- func MaxDec(d1, d2 BigDec) BigDec
- func MinDec(d1, d2 BigDec) BigDec
- func MustNewDecFromStr(s string) BigDec
- func NewBigDec(i int64) BigDec
- func NewDecFromBigInt(i *big.Int) BigDec
- func NewDecFromBigIntWithPrec(i *big.Int, prec int64) BigDec
- func NewDecFromInt(i BigInt) BigDec
- func NewDecFromIntWithPrec(i BigInt, prec int64) BigDec
- func NewDecFromStr(str string) (BigDec, error)
- func NewDecWithPrec(i, prec int64) BigDec
- func OneDec() BigDec
- func SmallestDec() BigDec
- func ZeroDec() BigDec
- func (d BigDec) Abs() BigDec
- func (d BigDec) Add(d2 BigDec) BigDec
- func (d BigDec) ApproxRoot(root uint64) (guess BigDec, err error)
- func (d BigDec) ApproxSqrt() (BigDec, error)
- func (d BigDec) BigInt() *big.Int
- func (d BigDec) Ceil() BigDec
- func (d BigDec) Equal(d2 BigDec) bool
- func (d BigDec) Float64() (float64, error)
- func (d BigDec) Format(s fmt.State, verb rune)
- func (d BigDec) GT(d2 BigDec) bool
- func (d BigDec) GTE(d2 BigDec) bool
- func (d BigDec) IsInteger() bool
- func (d BigDec) IsNegative() bool
- func (d BigDec) IsNil() bool
- func (d BigDec) IsPositive() bool
- func (d BigDec) IsZero() bool
- func (d BigDec) LT(d2 BigDec) bool
- func (d BigDec) LTE(d2 BigDec) bool
- func (d BigDec) Marshal() ([]byte, error)
- func (d BigDec) MarshalAmino() ([]byte, error)
- func (d BigDec) MarshalJSON() ([]byte, error)
- func (d *BigDec) MarshalTo(data []byte) (n int, err error)
- func (d BigDec) MarshalYAML() (interface{}, error)
- func (d BigDec) Mul(d2 BigDec) BigDec
- func (d BigDec) MulInt(i BigInt) BigDec
- func (d BigDec) MulInt64(i int64) BigDec
- func (d BigDec) MulTruncate(d2 BigDec) BigDec
- func (d BigDec) MustFloat64() float64
- func (d BigDec) Neg() BigDec
- func (d BigDec) Power(power uint64) BigDec
- func (d BigDec) Quo(d2 BigDec) BigDec
- func (d BigDec) QuoInt(i BigInt) BigDec
- func (d BigDec) QuoInt64(i int64) BigDec
- func (d BigDec) QuoRoundUp(d2 BigDec) BigDec
- func (d BigDec) QuoTruncate(d2 BigDec) BigDec
- func (d BigDec) RoundInt() BigInt
- func (d BigDec) RoundInt64() int64
- func (d *BigDec) Size() int
- func (d BigDec) String() string
- func (d BigDec) Sub(d2 BigDec) BigDec
- func (d BigDec) TruncateDec() BigDec
- func (d BigDec) TruncateInt() BigInt
- func (d BigDec) TruncateInt64() int64
- func (d *BigDec) Unmarshal(data []byte) error
- func (d *BigDec) UnmarshalAmino(bz []byte) error
- func (d *BigDec) UnmarshalJSON(bz []byte) error
- type BigInt
- func MaxInt(i, i2 BigInt) BigInt
- func MinInt(i1, i2 BigInt) BigInt
- func NewInt(n int64) BigInt
- func NewIntFromBigInt(i *big.Int) BigInt
- func NewIntFromString(s string) (res BigInt, ok bool)
- func NewIntFromUint64(n uint64) BigInt
- func NewIntWithDecimal(n int64, dec int) BigInt
- func OneInt() BigInt
- func ZeroInt() BigInt
- func (i BigInt) Abs() BigInt
- func (i BigInt) Add(i2 BigInt) (res BigInt)
- func (i BigInt) AddRaw(i2 int64) BigInt
- func (i BigInt) BigInt() *big.Int
- func (i BigInt) Equal(i2 BigInt) bool
- func (i BigInt) GT(i2 BigInt) bool
- func (i BigInt) GTE(i2 BigInt) bool
- func (i BigInt) Int64() int64
- func (i BigInt) IsInt64() bool
- func (i BigInt) IsNegative() bool
- func (i BigInt) IsNil() bool
- func (i BigInt) IsPositive() bool
- func (i BigInt) IsUint64() bool
- func (i BigInt) IsZero() bool
- func (i BigInt) LT(i2 BigInt) bool
- func (i BigInt) LTE(i2 BigInt) bool
- func (i BigInt) Marshal() ([]byte, error)
- func (i BigInt) MarshalAmino() ([]byte, error)
- func (i BigInt) MarshalJSON() ([]byte, error)
- func (i *BigInt) MarshalTo(data []byte) (n int, err error)
- func (i BigInt) MarshalYAML() (interface{}, error)
- func (i BigInt) Mod(i2 BigInt) BigInt
- func (i BigInt) ModRaw(i2 int64) BigInt
- func (i BigInt) Mul(i2 BigInt) (res BigInt)
- func (i BigInt) MulRaw(i2 int64) BigInt
- func (i BigInt) Neg() (res BigInt)
- func (i BigInt) Quo(i2 BigInt) (res BigInt)
- func (i BigInt) QuoRaw(i2 int64) BigInt
- func (i BigInt) Sign() int
- func (i *BigInt) Size() int
- func (i BigInt) String() string
- func (i BigInt) Sub(i2 BigInt) (res BigInt)
- func (i BigInt) SubRaw(i2 int64) BigInt
- func (i BigInt) ToDec() BigDec
- func (i BigInt) Uint64() uint64
- func (i *BigInt) Unmarshal(data []byte) error
- func (i *BigInt) UnmarshalAmino(bz []byte) error
- func (i *BigInt) UnmarshalJSON(bz []byte) error
Constants ¶
const ( // number of decimal places Precision = 18 // bytes required to represent the above precision // Ceiling[Log2[999 999 999 999 999 999]] DecimalPrecisionBits = 60 )
Variables ¶
var ( ErrEmptyDecimalStr = errors.New("decimal string cannot be empty") ErrInvalidDecimalLength = errors.New("invalid decimal length") ErrInvalidDecimalStr = errors.New("invalid decimal string") )
Decimal errors
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 AbsDifferenceWithSign ¶
AbsDifferenceWithSign returns | a - b |, (a - b).sign() a is mutated and returned.
func DecApproxEq ¶
func GetPowPrecision ¶
Returns the internal "power precision". All fractional exponentiation in osmosis is expected to be accurate up to powPrecision. *technically* the error term can be greater than this powPrecision, but for small bases this bound applies. See comments in the PowApprox function for more detail.
func Pow ¶
Pow computes base^(exp) However since the exponent is not an integer, we must do an approximation algorithm. TODO: In the future, lets add some optimized routines for common exponents, e.g. for common wIn / wOut ratios Many simple exponents like 2:1 pools.
func SortableDecBytes ¶
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 ¶
ValidSortableDec ensures that a Dec is within the sortable bounds, a BigDec can't have a precision of less than 10^-18. Max sortable decimal was set to the reciprocal of SmallestDec.
Types ¶
type BigDec ¶
type BigDec struct {
// contains filtered or unexported fields
}
NOTE: never use new(BigDec) or else we will panic unmarshalling into the nil embedded big.Int
func MustNewDecFromStr ¶
Decimal from string, panic on error
func NewDecFromBigInt ¶
create a new BigDec from big integer assuming whole numbers CONTRACT: prec <= Precision
func NewDecFromBigIntWithPrec ¶
create a new BigDec from big integer assuming whole numbers CONTRACT: prec <= Precision
func NewDecFromInt ¶
create a new BigDec from big integer assuming whole numbers CONTRACT: prec <= Precision
func NewDecFromIntWithPrec ¶
create a new BigDec from big integer with decimal place at prec CONTRACT: prec <= Precision
func NewDecFromStr ¶
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 ¶
create a new BigDec from integer with decimal place at prec CONTRACT: prec <= Precision
func SmallestDec ¶
func SmallestDec() BigDec
func (BigDec) ApproxRoot ¶
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 (BigDec) ApproxSqrt ¶
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 (BigDec) Ceil ¶
Ceil returns the smallest interger value (as a decimal) that is greater than or equal to the given decimal.
func (BigDec) Float64 ¶
Float64 returns the float64 representation of a BigDec. Will return the error if the conversion failed.
func (BigDec) IsNegative ¶
func (BigDec) IsPositive ¶
func (BigDec) MarshalAmino ¶
Override Amino binary serialization by proxying to protobuf.
func (BigDec) MarshalJSON ¶
MarshalJSON marshals the decimal
func (BigDec) MarshalYAML ¶
MarshalYAML returns the YAML representation.
func (BigDec) MustFloat64 ¶
MustFloat64 returns the float64 representation of a BigDec. Would panic if the conversion failed.
func (BigDec) RoundInt64 ¶
RoundInt64 rounds the decimal using bankers rounding
func (BigDec) TruncateDec ¶
TruncateDec truncates the decimals from the number and returns a Dec
func (BigDec) TruncateInt ¶
TruncateInt truncates the decimals from the number and returns an Int
func (BigDec) TruncateInt64 ¶
TruncateInt64 truncates the decimals from the number and returns an int64
func (*BigDec) UnmarshalAmino ¶
func (*BigDec) UnmarshalJSON ¶
UnmarshalJSON defines custom decoding scheme
type BigInt ¶
type BigInt struct {
// contains filtered or unexported fields
}
Int wraps big.Int with a 257 bit range bound Checks overflow, underflow and division by zero Exists in range from -(2^256 - 1) to 2^256 - 1
func NewIntFromBigInt ¶
NewIntFromBigInt constructs Int from big.Int. If the provided big.Int is nil, it returns an empty instance. This function panics if the bit length is > 256.
func NewIntFromString ¶
NewIntFromString constructs Int from string
func NewIntFromUint64 ¶
NewIntFromUint64 constructs an Int from a uint64.
func NewIntWithDecimal ¶
NewIntWithDecimal constructs Int with decimal Result value is n*10^dec
func (BigInt) IsNegative ¶
IsNegative returns true if Int is negative
func (BigInt) IsPositive ¶
IsPositive returns true if Int is positive
func (BigInt) MarshalAmino ¶
Override Amino binary serialization by proxying to protobuf.
func (BigInt) MarshalJSON ¶
MarshalJSON defines custom encoding scheme
func (BigInt) MarshalYAML ¶
MarshalYAML returns the YAML representation.
func (*BigInt) UnmarshalAmino ¶
func (*BigInt) UnmarshalJSON ¶
UnmarshalJSON defines custom decoding scheme