amount

Documentation

Index

• type Amount
  • func New(amount decimal.Decimal, valuations []decimal.Decimal) Amount
  • func (a Amount) Amount() decimal.Decimal
  • func (a Amount) Equal(b Amount) bool
  • func (a Amount) Minus(b Amount) Amount
  • func (a Amount) Neg() Amount
  • func (a Amount) Plus(b Amount) Amount
  • func (a Amount) String() string
  • func (a Amount) Valuation(i int) decimal.Decimal
• type Vec
  • func NewVec(n int) Vec
  • func (v Vec) Add(u Vec)
  • func (v Vec) Neg()

Types

type Amount

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

Amount represents an amount in some commodity, along with a set of valuations.

func New

func New(amount decimal.Decimal, valuations []decimal.Decimal) Amount

New creates a new amount with value zero.

func (Amount) Amount

func (a Amount) Amount() decimal.Decimal

Amount returns the amount.

func (Amount) Equal

func (a Amount) Equal(b Amount) bool

Equal tests if both amounts are equal.

func (Amount) Minus

func (a Amount) Minus(b Amount) Amount

Minus computes the difference between two amounts.

func (Amount) Neg

func (a Amount) Neg() Amount

Neg computes the negation of this amount.

func (Amount) Plus

func (a Amount) Plus(b Amount) Amount

Plus computes the sum of two amounts.

func (Amount) String

func (a Amount) String() string

func (Amount) Valuation

func (a Amount) Valuation(i int) decimal.Decimal

Valuation returns the valuation at position i. If the valuation does not exist, 0 is returned.

type Vec

type Vec struct {
	Values []decimal.Decimal
}

Vec is a vector of decimals.

func NewVec

func NewVec(n int) Vec

NewVec creates a new vector.

func (Vec) Add

func (v Vec) Add(u Vec)

Add mutably adds the given vector to the receiver.

func (Vec) Neg

func (v Vec) Neg()

Neg mutably negates the given vector.