Hledger.Data.Amount

A simple Amount is some quantity of money, shares, or anything else. It has a (possibly null) Commodity 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.

Amount

amount :: Amount

The empty simple amount.

nullamt :: Amount

The empty simple amount.

missingamt :: Amount

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

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 :: Commodity -> Amount -> Amount

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

arithmetic

costOfAmount :: Amount -> Amount

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 :: Amount -> Quantity -> Amount

Divide an amount's quantity by a constant.

rendering

amountstyle :: AmountStyle

showAmount :: Amount -> String

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.

showAmountWithZeroCommodity :: Amount -> String

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

showAmountDebug :: Amount -> String

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

showAmountWithoutPrice :: Amount -> String

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

maxprecision :: Int

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

maxprecisionwithpoint :: Int

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

setAmountPrecision :: Int -> Amount -> Amount

Set an amount's display precision.

withPrecision :: Amount -> Int -> Amount

Set an amount's display precision, flipped.

canonicaliseAmount :: Map Commodity AmountStyle -> Amount -> Amount

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

MixedAmount

nullmixedamt :: MixedAmount

The empty mixed amount.

missingmixedamt :: MixedAmount

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

mixed :: [Amount] -> MixedAmount

Convert amounts in various commodities into a normalised MixedAmount.

amounts :: MixedAmount -> [Amount]

Sum same-commodity amounts. If there were different prices, set the price to a special marker indicating "various". Only used as a rendering helper. sumSimilarAmountsNotingPriceDifference :: [Amount] -> Amount sumSimilarAmountsNotingPriceDifference [] = nullamt sumSimilarAmountsNotingPriceDifference as = undefined

Get a mixed amount's component amounts.

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

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

filterMixedAmountByCommodity :: Commodity -> MixedAmount -> MixedAmount

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

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

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 are replaced by just one. If they had the same commodity, it is preserved.
• an empty amount list is replaced with a single commodityless zero
• the special "missing" mixed amount remains unchanged

arithmetic

costOfMixedAmount :: MixedAmount -> MixedAmount

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

divideMixedAmount :: MixedAmount -> Quantity -> MixedAmount

Divide a mixed amount's quantities by a constant.

averageMixedAmounts :: [MixedAmount] -> MixedAmount

Calculate the average of some mixed amounts.

isNegativeMixedAmount :: MixedAmount -> Maybe Bool

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

isZeroMixedAmount :: MixedAmount -> Bool

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

isReallyZeroMixedAmount :: MixedAmount -> Bool

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

isReallyZeroMixedAmountCost :: MixedAmount -> Bool

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

rendering

showMixedAmount :: MixedAmount -> String

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.

showMixedAmountDebug :: MixedAmount -> String

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

showMixedAmountWithoutPrice :: MixedAmount -> String

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

showMixedAmountOneLineWithoutPrice :: MixedAmount -> String

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

showMixedAmountWithZeroCommodity :: MixedAmount -> String

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

showMixedAmountWithPrecision :: Int -> MixedAmount -> String

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

Set the display precision in the amount's commodities.

canonicaliseMixedAmount :: Map Commodity AmountStyle -> MixedAmount -> MixedAmount

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

misc.

ltraceamount :: String -> MixedAmount -> MixedAmount

Compact labelled trace of a mixed amount, for debugging.

tests_Hledger_Data_Amount :: Test