amounts

Documentation

Index

• func FilterAccount(r *regexp.Regexp) filter.Filter[Key]
• func FilterCommodity(r *regexp.Regexp) filter.Filter[Key]
• func FilterDates(t time.Time) filter.Filter[Key]
• func FilterOther(r *regexp.Regexp) filter.Filter[Key]
• func Identity[T any](t T) T
• func SortByAccount(jctx journal.Context, w map[*journal.Account]float64) compare.Compare[Key]
• func SortByCommodity(k1, k2 Key) compare.Order
• func SortByDate(k1, k2 Key) compare.Order
• type Amounts
  • func (am Amounts) Add(k Key, d decimal.Decimal)
  • func (am Amounts) Amount(k Key) decimal.Decimal
  • func (am Amounts) Clone() Amounts
  • func (am Amounts) Commodities() map[*journal.Commodity]struct{}
  • func (am Amounts) CommoditiesSorted() []*journal.Commodity
  • func (am Amounts) Dates() map[time.Time]struct{}
  • func (am Amounts) DatesSorted() []time.Time
  • func (am Amounts) Index(cmp compare.Compare[Key]) []Key
  • func (am Amounts) Minus(a Amounts) Amounts
  • func (am Amounts) Plus(a Amounts) Amounts
  • func (am Amounts) SumBy(f func(k Key) bool, m func(k Key) Key) Amounts
  • func (am Amounts) SumIntoBy(as Amounts, f func(k Key) bool, m func(k Key) Key)
  • func (am Amounts) SumOver(f func(k Key) bool) decimal.Decimal
• type Key
  • func AccountCommodityKey(a *journal.Account, c *journal.Commodity) Key
  • func AccountKey(a *journal.Account) Key
  • func CommodityKey(c *journal.Commodity) Key
  • func DateCommodityKey(d time.Time, c *journal.Commodity) Key
  • func DateKey(d time.Time) Key
• type KeyMapper
  • func (km KeyMapper) Build() Mapper
• type Mapper

Functions

func FilterAccount

func FilterAccount(r *regexp.Regexp) filter.Filter[Key]

func FilterCommodity

func FilterCommodity(r *regexp.Regexp) filter.Filter[Key]

func FilterDates

func FilterDates(t time.Time) filter.Filter[Key]

func FilterOther

func FilterOther(r *regexp.Regexp) filter.Filter[Key]

func Identity

func Identity[T any](t T) T

func SortByAccount

func SortByAccount(jctx journal.Context, w map[*journal.Account]float64) compare.Compare[Key]

func SortByCommodity

func SortByCommodity(k1, k2 Key) compare.Order

func SortByDate

func SortByDate(k1, k2 Key) compare.Order

Types

type Amounts

type Amounts map[Key]decimal.Decimal

Amounts keeps track of amounts by account and commodity.

func (Amounts) Add

func (am Amounts) Add(k Key, d decimal.Decimal)

func (Amounts) Amount

func (am Amounts) Amount(k Key) decimal.Decimal

Amount returns the amount for the given key.

func (Amounts) Clone

func (am Amounts) Clone() Amounts

Clone clones these amounts.

func (Amounts) Commodities

func (am Amounts) Commodities() map[*journal.Commodity]struct{}

func (Amounts) CommoditiesSorted

func (am Amounts) CommoditiesSorted() []*journal.Commodity

func (Amounts) Dates

func (am Amounts) Dates() map[time.Time]struct{}

func (Amounts) DatesSorted

func (am Amounts) DatesSorted() []time.Time

func (Amounts) Index

func (am Amounts) Index(cmp compare.Compare[Key]) []Key

func (Amounts) Minus

func (am Amounts) Minus(a Amounts) Amounts

Minus mutably subtracts.

func (Amounts) Plus

func (am Amounts) Plus(a Amounts) Amounts

Plus mutably adds.

func (Amounts) SumBy

func (am Amounts) SumBy(f func(k Key) bool, m func(k Key) Key) Amounts

func (Amounts) SumIntoBy

func (am Amounts) SumIntoBy(as Amounts, f func(k Key) bool, m func(k Key) Key)

func (Amounts) SumOver

func (am Amounts) SumOver(f func(k Key) bool) decimal.Decimal

type Key

type Key struct {
	Date           time.Time
	Account, Other *journal.Account
	Commodity      *journal.Commodity
	Valuation      *journal.Commodity
}

Key represents a position.

func AccountCommodityKey

func AccountCommodityKey(a *journal.Account, c *journal.Commodity) Key

func AccountKey

func AccountKey(a *journal.Account) Key

func CommodityKey

func CommodityKey(c *journal.Commodity) Key

func DateCommodityKey

func DateCommodityKey(d time.Time, c *journal.Commodity) Key

func DateKey

func DateKey(d time.Time) Key

type KeyMapper

type KeyMapper struct {
	Date                 func(time.Time) time.Time
	Account, Other       func(*journal.Account) *journal.Account
	Commodity, Valuation func(*journal.Commodity) *journal.Commodity
}

func (KeyMapper) Build

func (km KeyMapper) Build() Mapper

type Mapper

type Mapper func(Key) Key