gyro

README

gyro

Decimal over a int128 implementation

⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⣤⣶⣎⠭⠭⠦⣄⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣠⠴⠚⣩⠔⣋⣥⠶⠀⠀⠀⣄⠉⠓⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠁⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⢀⡠⠴⠊⠁⠀⢸⠟⣡⠾⠋⠀⣠⡶⠀⠀⢻⣇⣀⣿⡤⠤⠤⣤⣄⣤⣤⠔⠂⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⣀⣤
⠀⠀⠀⠀⠀⠀⣠⢞⡭⠀⢠⣶⡀⢠⠏⡼⠋⢀⣤⡿⠋⢀⣾⢀⣾⣋⣿⠿⠒⠚⠛⠋⠉⠉⠁⠀⣀⣀⣠⣤⣶⣶⣶⣾⣿⣿⣿⣿⣿⣿
⠀⠀⠀⠀⠀⣾⣴⣏⠀⠀⠈⠻⣷⡼⠀⠀⠰⠟⠁⠀⣰⠿⣣⣾⣧⣴⡿⠶⠆⢀⣠⣤⢶⣶⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⣶⣿⣿⣿⣿
⠀⠀⠀⠀⡴⠛⠉⢹⣧⠀⠀⠀⢈⣿⣄⠀⠀⢠⠴⢛⡡⠞⢉⡩⠟⠀⣠⣴⡾⠋⠉⠀⠈⣿⣿⣽⣿⣿⣿⣿⣛⣛⠿⢿⣿⣿⣿⣿⡿⠁
⠀⠀⠀⠀⡷⠒⠉⠉⠉⠁⠲⡖⠉⣿⣿⣷⣤⣴⣮⣭⠴⠒⢉⣤⡶⠛⠉⠀⣿⣴⣦⣄⠀⠻⣿⣿⣿⡿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠟⠀⠀
⠀⠀⢀⡞⣡⡶⠀⠀⠒⢦⡀⠱⣤⣿⣿⠟⠿⠿⠏⠀⣠⣴⣿⣥⣤⣤⣤⣴⠟⣷⠈⠙⠳⣄⠀⠐⢽⡻⢷⣮⣽⣿⣿⣿⣿⣟⠁⣀⣀⠀
⠀⠀⣾⣾⢋⣴⡶⠂⠀⢸⡗⢳⡿⣯⠀⠀⠀⢀⣴⣞⣻⣿⡿⢚⡿⠿⣿⣯⣀⠙⢶⣖⣒⠚⠀⢠⣄⠈⢦⠈⠙⠻⣿⡟⠁⠈⠉⢀⣼⠤
⠀⠀⢿⠃⣼⠟⢀⣼⡇⣾⢃⣾⠁⠿⢃⠖⣠⡿⢿⣾⠟⢹⣧⣬⣽⡿⣫⠿⠯⢷⡈⠛⠛⡃⠀⣷⡈⣦⡈⡇⠀⠀⠈⢳⣄⡀⠀⠀⠀⠀
⠀⠀⠈⢾⣏⢀⣼⣋⡴⢛⡿⠁⢀⠞⣡⣾⣿⡀⠀⠑⠒⠀⠀⠀⠉⠋⠀⠀⠀⠀⠹⡀⠀⠹⡔⠻⣿⡏⠁⣹⣄⠀⠀⠀⠙⢿⠒⠤⣀⠀
⠀⠀⠀⠀⠈⠙⠛⠣⣶⡟⠁⡰⢃⡴⠿⣛⣿⣷⣤⠶⠦⠤⡀⠀⠀⠀⠀⠀⠀⠀⠀⣇⢠⡤⢧⢠⠟⢀⡰⠃⠘⠢⡀⠀⢱⡈⠆⢢⠀⠙
⠀⠀⠀⠀⠀⠀⠀⣰⣿⢀⠞⣡⣿⣀⣴⢿⣽⣿⡇⠀⠀⢀⣸⡀⠀⠀⠀⠀⠀⠀⠀⠘⠀⢇⠘⣿⣶⡏⠀⠀⢤⡀⠈⢢⠀⢷⡘⠈⡄⠀
⠀⠀⠀⠀⠀⠀⣴⠉⣩⢃⣼⡇⠈⢩⠁⠈⠻⡼⣧⣄⠀⢀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⢻⠉⡇⠀⠀⢠⢹⡦⡀⢣⠘⣇⠸⠇⠀
⠀⠀⠀⠀⠀⣰⢃⡜⢡⡞⠋⠻⣾⣏⠀⠀⠀⢿⣄⣨⡽⠿⢻⠿⠿⢷⣦⠀⠀⠀⠀⠀⠀⣠⣄⡸⠀⣿⣦⣄⠀⠳⣵⡌⠢⡇⢸⠁⠀⠀
⠀⠀⠀⠀⣰⣣⠋⣰⣿⡇⠀⢀⠨⢿⣄⠀⠀⠀⠉⢟⢶⣖⠋⣀⡤⠖⠋⠀⡀⠀⠀⠀⠰⡇⢸⠇⠀⣿⣿⣿⣦⡀⠙⣿⡄⢹⠸⡇⠀⠀
⠀⠀⠀⣼⡿⢁⣾⠯⣿⣧⣠⡸⣄⠀⠻⡆⠀⠀⠀⠈⠃⠛⠛⠉⠀⠀⣀⣼⠇⠀⠀⠀⠀⢹⠏⠀⢠⣿⣿⣿⣿⣿⣄⠈⢧⢸⣾⡇⠀⠀
⠀⢀⡼⠋⣠⣿⣿⡄⣿⣿⣿⡄⠈⢻⡗⣻⣶⣄⠀⠀⠀⢰⣤⣴⠾⠛⠉⠁⠀⢠⡒⠉⢷⡿⠀⠀⣼⣯⣟⢿⣿⣿⣿⣷⣼⣿⣿⠀⠀⢀
⢀⠞⢁⣼⣿⣿⣿⣣⣿⣿⣿⣇⠀⠀⡟⢻⣿⣿⣷⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢣⣴⢻⠃⠀⢀⣿⣿⣿⣧⠉⢻⣿⣿⣿⠃⠁⠀⢀⣌
⠏⣠⣿⣯⣿⣿⣿⣿⣿⣿⣿⣿⡀⠀⣇⢸⢿⣿⣿⣿⣷⣤⡒⢆⠀⠀⢀⣠⣴⣾⡿⢁⡎⠀⠀⣼⠿⣿⣿⣿⣇⢸⣿⣿⡇⠀⠀⢠⡿⠃
⣾⣿⠿⠟⣛⣿⣿⣿⣿⣿⣿⣿⣇⠀⢻⣾⢸⡘⣿⣿⣿⣿⣿⣬⣷⣾⣿⣿⣿⠟⠀⠈⠀⠀⢠⡿⠀⢻⣿⣟⣿⢸⣿⣿⠃⠀⣰⡿⠁⠀
⠀⣠⠴⠿⠿⠿⠿⠿⣿⣿⣿⣿⣿⡄⠈⣿⡀⢷⣿⣿⡟⣿⣿⣿⣧⣿⣿⡿⠋⠀⠀⠀⠀⢠⣿⡇⢠⣿⢟⣾⠟⣸⣿⡿⢀⣼⡿⠃⠀⠀
⠉⠀⠀⠉⣉⠽⠋⠉⢀⡤⢈⠏⢻⣧⠀⢹⣇⠘⣿⣿⣷⣏⡿⣿⣸⣿⡿⠁⠀⠀⠀⠀⢠⡿⢻⣥⣿⣿⣿⡟⢰⣿⡟⢡⡾⡽⠁⠀⠀⠐
⠙⢿⣿⣞⠙⢷⣶⣿⡿⠖⠉⢀⡄⠹⡄⠈⢟⡆⢸⣟⢿⣿⣿⣿⣿⣽⣇⠀⠀⠀⠀⠀⠘⠃⣾⣷⣿⣿⡟⢠⡿⠋⡰⢋⡞⢁⡠⠂⢈⡆

Documentation

Index

• Constants
• type Gyro
  • func New(coeff i128.I128, exp int32) Gyro
  • func NewFromInt32Raw(coeff int32, exp int32) Gyro
  • func NewFromInt64(coeff int64) Gyro
  • func NewFromInt64Raw(coeff int64, exp int32) Gyro
  • func NewFromString(s string) (Gyro, error)
  • func NewHundred() Gyro
  • func NewMinusOne() Gyro
  • func NewOne() Gyro
  • func NewTen() Gyro
  • func NewZero() Gyro
  • func (g Gyro) Abs() Gyro
  • func (g Gyro) Add(g2 Gyro) Gyro
  • func (g Gyro) Cmp(g2 Gyro) int
  • func (g Gyro) Div(g2 Gyro) Gyro
  • func (g Gyro) DivRound(g2 Gyro, scale int32) Gyro
  • func (g Gyro) Equal(other Gyro) bool
  • func (g Gyro) Float64() float64
  • func (g Gyro) Int64() int64
  • func (g Gyro) IsFloat64Exact() bool
  • func (g Gyro) Mul(g2 Gyro) Gyro
  • func (g Gyro) QuoRem(g2 Gyro, precision int32) (Gyro, Gyro)
  • func (g Gyro) Round(places int32) Gyro
  • func (g Gyro) String() string
  • func (g Gyro) Sub(g2 Gyro) Gyro
• type GyroErr
  • func NewGyroErr(info any) *GyroErr
  • func (e *GyroErr) Error() string
• type GyroExponentNANErr
  • func NewGyroExponentNANErr(info any) *GyroExponentNANErr
• type GyroFractionalTooLongErr
  • func NewGyroFractionalTooLongErr(info any) *GyroFractionalTooLongErr
• type GyroInvalidErr
• type GyroOverflowErr
  • func NewGyroInvalidErr(info any) *GyroOverflowErr
  • func NewGyroOverflowErr(info any) *GyroOverflowErr
• type GyroTooManyDecimals
  • func NewGyroTooManyDecimals(info any) *GyroTooManyDecimals

Constants

const (
	MaxScale         = 16
	MaxDivisionScale = 15
)

Types

type Gyro

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

func New

func New(coeff i128.I128, exp int32) Gyro

New returns a new Gyro with the given coefficient and exponent. if exp greater than maxScale, it will be clamped to maxScale. if exp is positive, will multiply the coefficient by 10^exp.

func NewFromInt32Raw

func NewFromInt32Raw(coeff int32, exp int32) Gyro

NewFromInt32Raw returns a new Gyro with the given int32 coefficient and exponent.

func NewFromInt64

func NewFromInt64(coeff int64) Gyro

func NewFromInt64Raw

func NewFromInt64Raw(coeff int64, exp int32) Gyro

NewFromInt64Raw returns a new Gyro with the given coefficient and exponent.

func NewFromString

func NewFromString(s string) (Gyro, error)

NewFromString returns a string representation of a Gyro Decimal

func NewHundred

func NewHundred() Gyro

func NewMinusOne

func NewMinusOne() Gyro

func NewOne

func NewOne() Gyro

func NewTen

func NewTen() Gyro

func NewZero

func NewZero() Gyro

func (Gyro) Abs

func (g Gyro) Abs() Gyro

func (Gyro) Add

func (g Gyro) Add(g2 Gyro) Gyro

func (Gyro) Cmp

func (g Gyro) Cmp(g2 Gyro) int

Cmp compares the numbers represented by d and d2 and returns:

-1 if d <  d2
 0 if d == d2
+1 if d >  d2

func (Gyro) Div

func (g Gyro) Div(g2 Gyro) Gyro

Div returns the quotient of two Gyros. Uses MaxDivisionScale digits of precision.

func (Gyro) DivRound

func (g Gyro) DivRound(g2 Gyro, scale int32) Gyro

DivRound divides two Gyros and rounds the result to the given scale. Do not use over MaxDivisionScale digits of precision.

func (Gyro) Equal

func (g Gyro) Equal(other Gyro) bool

func (Gyro) Float64

func (g Gyro) Float64() float64

func (Gyro) Int64

func (g Gyro) Int64() int64

func (Gyro) IsFloat64Exact

func (g Gyro) IsFloat64Exact() bool

func (Gyro) Mul

func (g Gyro) Mul(g2 Gyro) Gyro

func (Gyro) QuoRem

func (g Gyro) QuoRem(g2 Gyro, precision int32) (Gyro, Gyro)

func (Gyro) Round

func (g Gyro) Round(places int32) Gyro

func (Gyro) String

func (g Gyro) String() string

func (Gyro) Sub

func (g Gyro) Sub(g2 Gyro) Gyro

type GyroErr

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

func NewGyroErr

func NewGyroErr(info any) *GyroErr

func (*GyroErr) Error

func (e *GyroErr) Error() string

type GyroExponentNANErr

type GyroExponentNANErr struct {
	*GyroErr
}

func NewGyroExponentNANErr

func NewGyroExponentNANErr(info any) *GyroExponentNANErr

type GyroFractionalTooLongErr

type GyroFractionalTooLongErr struct {
	*GyroErr
}

func NewGyroFractionalTooLongErr

func NewGyroFractionalTooLongErr(info any) *GyroFractionalTooLongErr

type GyroInvalidErr

type GyroInvalidErr struct {
	*GyroErr
}

type GyroOverflowErr

type GyroOverflowErr struct {
	*GyroErr
}

func NewGyroInvalidErr

func NewGyroInvalidErr(info any) *GyroOverflowErr

func NewGyroOverflowErr

func NewGyroOverflowErr(info any) *GyroOverflowErr

type GyroTooManyDecimals

type GyroTooManyDecimals struct {
	*GyroErr
}

func NewGyroTooManyDecimals

func NewGyroTooManyDecimals(info any) *GyroTooManyDecimals