hledger-lib-1.12: Core data types, parsers and functionality for the hledger accounting tools

Safe Haskell | None
Language | Haskell2010

Hledger.Data.Amount

Contents

- Amount
  - arithmetic
  - rendering
- MixedAmount
  - arithmetic
  - rendering
- misc.
- Orphan instances

Description

A simple `Amount` is some quantity of money, shares, or anything else. It has a (possibly null) `CommoditySymbol` and a numeric quantity:

      $1
      £-50
      EUR 3.44
      GOOG 500
      1.5h
      90 apples
      0

It may also have an assigned `Price`, representing this amount's per-unit or total cost in a different commodity. If present, this is rendered like so:

      EUR 2 @ $1.50  (unit price)
      EUR 2 @@ $3   (total price)

A `MixedAmount` is zero or more simple amounts, so can represent multiple commodities; this is the type most often used:

      0
      $50 + EUR 3
      16h + $13.55 + AAPL 500 + 6 oranges

When a mixed amount has been "normalised", it has no more than one amount in each commodity and no zero amounts; or it has just a single zero amount and no others.

Limited arithmetic with simple and mixed amounts is supported, best used with similar amounts since it mostly ignores assigned prices and commodity exchange rates.

Synopsis

- amount :: Amount
- nullamt :: Amount
- missingamt :: Amount
- num :: Quantity -> Amount
- usd :: DecimalRaw Integer -> Amount
- eur :: DecimalRaw Integer -> Amount
- gbp :: DecimalRaw Integer -> Amount
- hrs :: Quantity -> Amount
- at :: Amount -> Amount -> Amount
- (@@) :: Amount -> Amount -> Amount
- amountWithCommodity :: CommoditySymbol -> Amount -> Amount
- costOfAmount :: Amount -> Amount
- divideAmount :: Quantity -> Amount -> Amount
- multiplyAmount :: Quantity -> Amount -> Amount
- divideAmountAndPrice :: Quantity -> Amount -> Amount
- multiplyAmountAndPrice :: Quantity -> Amount -> Amount
- amountValue :: Journal -> Day -> Amount -> Amount
- amountTotalPriceToUnitPrice :: Amount -> Amount
- amountstyle :: AmountStyle
- styleAmount :: Map CommoditySymbol AmountStyle -> Amount -> Amount
- showAmount :: Amount -> String
- cshowAmount :: Amount -> String
- showAmountWithZeroCommodity :: Amount -> String
- showAmountDebug :: Amount -> String
- showAmountWithoutPrice :: Amount -> String
- maxprecision :: Int
- maxprecisionwithpoint :: Int
- setAmountPrecision :: Int -> Amount -> Amount
- withPrecision :: Amount -> Int -> Amount
- setAmountInternalPrecision :: Int -> Amount -> Amount
- withInternalPrecision :: Amount -> Int -> Amount
- setAmountDecimalPoint :: Maybe Char -> Amount -> Amount
- withDecimalPoint :: Amount -> Maybe Char -> Amount
- canonicaliseAmount :: Map CommoditySymbol AmountStyle -> Amount -> Amount
- nullmixedamt :: MixedAmount
- missingmixedamt :: MixedAmount
- mixed :: [Amount] -> MixedAmount
- amounts :: MixedAmount -> [Amount]
- filterMixedAmount :: (Amount -> Bool) -> MixedAmount -> MixedAmount
- filterMixedAmountByCommodity :: CommoditySymbol -> MixedAmount -> MixedAmount
- normaliseMixedAmountSquashPricesForDisplay :: MixedAmount -> MixedAmount
- normaliseMixedAmount :: MixedAmount -> MixedAmount
- costOfMixedAmount :: MixedAmount -> MixedAmount
- divideMixedAmount :: Quantity -> MixedAmount -> MixedAmount
- multiplyMixedAmount :: Quantity -> MixedAmount -> MixedAmount
- divideMixedAmountAndPrice :: Quantity -> MixedAmount -> MixedAmount
- multiplyMixedAmountAndPrice :: Quantity -> MixedAmount -> MixedAmount
- averageMixedAmounts :: [MixedAmount] -> MixedAmount
- isNegativeAmount :: Amount -> Bool
- isNegativeMixedAmount :: MixedAmount -> Maybe Bool
- isZeroAmount :: Amount -> Bool
- isReallyZeroAmount :: Amount -> Bool
- isZeroMixedAmount :: MixedAmount -> Bool
- isReallyZeroMixedAmount :: MixedAmount -> Bool
- isReallyZeroMixedAmountCost :: MixedAmount -> Bool
- mixedAmountValue :: Journal -> Day -> MixedAmount -> MixedAmount
- mixedAmountTotalPriceToUnitPrice :: MixedAmount -> MixedAmount
- styleMixedAmount :: Map CommoditySymbol AmountStyle -> MixedAmount -> MixedAmount
- showMixedAmount :: MixedAmount -> String
- showMixedAmountOneLine :: MixedAmount -> String
- showMixedAmountDebug :: MixedAmount -> String
- showMixedAmountWithoutPrice :: MixedAmount -> String
- showMixedAmountOneLineWithoutPrice :: MixedAmount -> String
- cshowMixedAmountWithoutPrice :: MixedAmount -> String
- cshowMixedAmountOneLineWithoutPrice :: MixedAmount -> String
- showMixedAmountWithZeroCommodity :: MixedAmount -> String
- showMixedAmountWithPrecision :: Int -> MixedAmount -> String
- setMixedAmountPrecision :: Int -> MixedAmount -> MixedAmount
- canonicaliseMixedAmount :: Map CommoditySymbol AmountStyle -> MixedAmount -> MixedAmount
- ltraceamount :: String -> MixedAmount -> MixedAmount
- tests_Amount :: Test ()

# Amount

amount :: Amount Source #

The empty simple amount.

nullamt :: Amount Source #

The empty simple amount.

missingamt :: Amount Source #

A temporary value for parsed transactions which had no amount specified.

num :: Quantity -> Amount Source #

usd :: DecimalRaw Integer -> Amount Source #

eur :: DecimalRaw Integer -> Amount Source #

gbp :: DecimalRaw Integer -> Amount Source #

hrs :: Quantity -> Amount Source #

at :: Amount -> Amount -> Amount Source #

(@@) :: Amount -> Amount -> Amount Source #

amountWithCommodity :: CommoditySymbol -> Amount -> Amount Source #

Convert an amount to the specified commodity, ignoring and discarding any assigned prices and assuming an exchange rate of 1.

## arithmetic

costOfAmount :: Amount -> Amount Source #

Convert an amount to the commodity of its assigned price, if any. Notes:

- price amounts must be MixedAmounts with exactly one component Amount (or there will be a runtime error) XXX
- price amounts should be positive, though this is not currently enforced

divideAmount :: Quantity -> Amount -> Amount Source #

Divide an amount's quantity by a constant.

multiplyAmount :: Quantity -> Amount -> Amount Source #

Multiply an amount's quantity by a constant.

divideAmountAndPrice :: Quantity -> Amount -> Amount Source #

Divide an amount's quantity (and its total price, if it has one) by a constant. The total price will be kept positive regardless of the multiplier's sign.

multiplyAmountAndPrice :: Quantity -> Amount -> Amount Source #

Multiply an amount's quantity (and its total price, if it has one) by a constant. The total price will be kept positive regardless of the multiplier's sign.

amountValue :: Journal -> Day -> Amount -> Amount Source #

Find the market value of this amount on the given date, in it's default valuation commodity, based on recorded market prices. If no default valuation commodity can be found, the amount is left unchanged.

amountTotalPriceToUnitPrice :: Amount -> Amount Source #

Replace an amount's TotalPrice, if it has one, with an equivalent UnitPrice. Has no effect on amounts without one. Also increases the unit price's display precision to show one extra decimal place, to help keep transaction amounts balancing. Does Decimal division, might be some rounding/irrational number issues.

## rendering

amountstyle :: AmountStyle Source #

Default amount style

styleAmount :: Map CommoditySymbol AmountStyle -> Amount -> Amount Source #

Given a map of standard amount display styles, apply the appropriate one to this amount. If there's no standard style for this amount's commodity, return the amount unchanged.

showAmount :: Amount -> String Source #

Get the string representation of an amount, based on its commodity's display settings. String representations equivalent to zero are converted to just "0". The special "missing" amount is displayed as the empty string.

cshowAmount :: Amount -> String Source #

Colour version. For a negative amount, adds ANSI codes to change the colour, currently to hard-coded red.

showAmountWithZeroCommodity :: Amount -> String Source #

Like showAmount, but show a zero amount's commodity if it has one.

showAmountDebug :: Amount -> String Source #

Get a string representation of an amount for debugging, appropriate to the current debug level. 9 shows maximum detail.

showAmountWithoutPrice :: Amount -> String Source #

Get the string representation of an amount, without any @ price.

maxprecision :: Int Source #

For rendering: a special precision value which means show all available digits.

maxprecisionwithpoint :: Int Source #

For rendering: a special precision value which forces display of a decimal point.

setAmountPrecision :: Int -> Amount -> Amount Source #

Set an amount's display precision.

withPrecision :: Amount -> Int -> Amount Source #

Set an amount's display precision, flipped.

setAmountInternalPrecision :: Int -> Amount -> Amount Source #

Set an amount's internal precision, ie rounds the Decimal representing the amount's quantity to some number of decimal places. Rounding is done with Data.Decimal's default roundTo function: "If the value ends in 5 then it is rounded to the nearest even value (Banker's Rounding)". Does not change the amount's display precision. Intended only for internal use, eg when comparing amounts in tests.

withInternalPrecision :: Amount -> Int -> Amount Source #

Set an amount's internal precision, flipped. Intended only for internal use, eg when comparing amounts in tests.

setAmountDecimalPoint :: Maybe Char -> Amount -> Amount Source #

Set (or clear) an amount's display decimal point.

withDecimalPoint :: Amount -> Maybe Char -> Amount Source #

Set (or clear) an amount's display decimal point, flipped.

canonicaliseAmount :: Map CommoditySymbol AmountStyle -> Amount -> Amount Source #

Canonicalise an amount's display style using the provided commodity style map.

# MixedAmount

nullmixedamt :: MixedAmount Source #

The empty mixed amount.

missingmixedamt :: MixedAmount Source #

A temporary value for parsed transactions which had no amount specified.

mixed :: [Amount] -> MixedAmount Source #

Convert amounts in various commodities into a normalised MixedAmount.

amounts :: MixedAmount -> [Amount] Source #

Get a mixed amount's component amounts.

filterMixedAmount :: (Amount -> Bool) -> MixedAmount -> MixedAmount Source #

Filter a mixed amount's component amounts by a predicate.

filterMixedAmountByCommodity :: CommoditySymbol -> MixedAmount -> MixedAmount Source #

Return an unnormalised MixedAmount containing exactly one Amount with the specified commodity and the quantity of that commodity found in the original. NB if Amount's quantity is zero it will be discarded next time the MixedAmount gets normalised.

normaliseMixedAmountSquashPricesForDisplay :: MixedAmount -> MixedAmount Source #

Like normaliseMixedAmount, but combine each commodity's amounts into just one by throwing away all prices except the first. This is only used as a rendering helper, and could show a misleading price.

normaliseMixedAmount :: MixedAmount -> MixedAmount Source #

Simplify a mixed amount's component amounts:

- amounts in the same commodity are combined unless they have different prices or total prices
- multiple zero amounts, all with the same non-null commodity, are replaced by just the last of them, preserving the commodity and amount style (all but the last zero amount are discarded)
- multiple zero amounts with multiple commodities, or no commodities, are replaced by one commodity-less zero amount
- an empty amount list is replaced by one commodity-less zero amount
- the special "missing" mixed amount remains unchanged

## arithmetic

costOfMixedAmount :: MixedAmount -> MixedAmount Source #

Convert a mixed amount's component amounts to the commodity of their assigned price, if any.

divideMixedAmount :: Quantity -> MixedAmount -> MixedAmount Source #

Divide a mixed amount's quantities by a constant.

multiplyMixedAmount :: Quantity -> MixedAmount -> MixedAmount Source #

Multiply a mixed amount's quantities by a constant.

divideMixedAmountAndPrice :: Quantity -> MixedAmount -> MixedAmount Source #

Divide a mixed amount's quantities (and total prices, if any) by a constant. The total prices will be kept positive regardless of the multiplier's sign.

multiplyMixedAmountAndPrice :: Quantity -> MixedAmount -> MixedAmount Source #

Multiply a mixed amount's quantities (and total prices, if any) by a constant. The total prices will be kept positive regardless of the multiplier's sign.

averageMixedAmounts :: [MixedAmount] -> MixedAmount Source #

Calculate the average of some mixed amounts.

isNegativeAmount :: Amount -> Bool Source #

Is this amount negative ? The price is ignored.

isNegativeMixedAmount :: MixedAmount -> Maybe Bool Source #

Is this mixed amount negative, if it can be normalised to a single commodity ?

isZeroAmount :: Amount -> Bool Source #

Does this amount appear to be zero when displayed with its given precision ?

isReallyZeroAmount :: Amount -> Bool Source #

Is this amount "really" zero, regardless of the display precision ?

isZeroMixedAmount :: MixedAmount -> Bool Source #

Does this mixed amount appear to be zero when displayed with its given precision ?

isReallyZeroMixedAmount :: MixedAmount -> Bool Source #

Is this mixed amount "really" zero ? See isReallyZeroAmount.

isReallyZeroMixedAmountCost :: MixedAmount -> Bool Source #

Is this mixed amount "really" zero, after converting to cost commodities where possible ?

mixedAmountValue :: Journal -> Day -> MixedAmount -> MixedAmount Source #

mixedAmountTotalPriceToUnitPrice :: MixedAmount -> MixedAmount Source #

Replace each component amount's TotalPrice, if it has one, with an equivalent UnitPrice. Has no effect on amounts without one. Does Decimal division, might be some rounding/irrational number issues.

## rendering

styleMixedAmount :: Map CommoditySymbol AmountStyle -> MixedAmount -> MixedAmount Source #

Given a map of standard amount display styles, apply the appropriate ones to each individual amount.

showMixedAmount :: MixedAmount -> String Source #

Get the string representation of a mixed amount, after normalising it to one amount per commodity. Assumes amounts have no or similar prices, otherwise this can show misleading prices.

showMixedAmountOneLine :: MixedAmount -> String Source #

Get the one-line string representation of a mixed amount.

showMixedAmountDebug :: MixedAmount -> String Source #

Get an unambiguous string representation of a mixed amount for debugging.

showMixedAmountWithoutPrice :: MixedAmount -> String Source #

Get the string representation of a mixed amount, without showing any transaction prices.

showMixedAmountOneLineWithoutPrice :: MixedAmount -> String Source #

Get the one-line string representation of a mixed amount, but without any @ prices.

cshowMixedAmountWithoutPrice :: MixedAmount -> String Source #

Colour version of showMixedAmountWithoutPrice. Any individual Amount which is negative is wrapped in ANSI codes to make it display in red.

cshowMixedAmountOneLineWithoutPrice :: MixedAmount -> String Source #

Colour version.

showMixedAmountWithZeroCommodity :: MixedAmount -> String Source #

Like showMixedAmount, but zero amounts are shown with their commodity if they have one.

showMixedAmountWithPrecision :: Int -> MixedAmount -> String Source #

Get the string representation of a mixed amount, showing each of its component amounts with the specified precision, ignoring their commoditys' display precision settings.

setMixedAmountPrecision :: Int -> MixedAmount -> MixedAmount Source #

Set the display precision in the amount's commodities.

canonicaliseMixedAmount :: Map CommoditySymbol AmountStyle -> MixedAmount -> MixedAmount Source #

Canonicalise a mixed amount's display styles using the provided commodity style map.

# misc.

ltraceamount :: String -> MixedAmount -> MixedAmount Source #

Compact labelled trace of a mixed amount, for debugging.

tests_Amount :: Test () Source #

# Orphan instances

Num MixedAmount Source # |
Instance details Methods (+) :: MixedAmount -> MixedAmount -> MixedAmount Source # (-) :: MixedAmount -> MixedAmount -> MixedAmount Source # (*) :: MixedAmount -> MixedAmount -> MixedAmount Source # negate :: MixedAmount -> MixedAmount Source # abs :: MixedAmount -> MixedAmount Source # signum :: MixedAmount -> MixedAmount Source # fromInteger :: Integer -> MixedAmount Source #
Num Amount Source # |
Instance details Methods (+) :: Amount -> Amount -> Amount Source # (-) :: Amount -> Amount -> Amount Source # (*) :: Amount -> Amount -> Amount Source # negate :: Amount -> Amount Source # abs :: Amount -> Amount Source # signum :: Amount -> Amount Source # fromInteger :: Integer -> Amount Source #
Show MarketPrice Source # |
Instance details Methods showsPrec :: Int -> MarketPrice -> ShowS Source # show :: MarketPrice -> String Source # showList :: [MarketPrice] -> ShowS Source #