The empty simple amount.

The empty simple amount.

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

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

Convert a amount to its "cost" or "selling price" in another commodity, using its attached transaction price if it has one. Notes:

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

Is this Amount (and its total price, if it has one) exactly zero, ignoring its display precision ?

Do this Amount and (and its total price, if it has one) appear to be zero when rendered with its display precision ?

Divide an amount's quantity (and its total price, if it has one) by a constant.

Multiply an amount's quantity (and its total price, if it has one) by a constant.

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.

Options for the display of Amount and MixedAmount.

Display Amount and MixedAmount with no colour.

Display Amount and MixedAmount with no prices.

Display Amount and MixedAmount on one line with no prices.

Default amount style

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

Like styleAmount, but keep the number of decimal places unchanged.

Reset this amount's display style to the default.

General function to generate a WideBuilder for an Amount, according the supplied AmountDisplayOpts. The special "missing" amount is displayed as the empty string. This is the main function to use for showing Amounts, constructing a builder; it can then be converted to a Text with wbToText, or to a String with wbUnpack.

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.

showAmount = wbUnpack . showAmountB noColour

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

cshowAmount = wbUnpack . showAmountB def{displayColour=True}

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

showAmountWithZeroCommodity = wbUnpack . showAmountB noColour{displayZeryCommodity=True}

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

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

showAmountWithoutPrice = wbUnpack . showAmountB noPrice

Set an amount's display precision.

Set an amount's display precision, flipped.

Increase an amount's display precision, if needed, to enough decimal places to show it exactly (showing all significant decimal digits, excluding trailing zeros).

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.

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

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

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

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

The empty mixed amount.

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

Convert amounts in various commodities into a normalised MixedAmount.

Get a mixed amount's component amounts.

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

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.

Apply a transform to a mixed amount's component Amounts.

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.

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

Unify a MixedAmount to a single commodity value if possible. Like normaliseMixedAmount, this consolidates amounts of the same commodity and discards zero amounts; but this one insists on simplifying to a single commodity, and will return Nothing if this is not possible.

Convert all component amounts to cost/selling price where possible (see amountCost).

Divide a mixed amount's quantities (and total prices, if any) by a constant.

Multiply a mixed amount's quantities (and total prices, if any) by a constant.

Calculate the average of some mixed amounts.

Is this amount negative ? The price is ignored.

Is this mixed amount negative, if we can tell that unambiguously? Ie when normalised, are all individual commodity amounts negative ?

Is this mixed amount exactly to be zero, ignoring its display precision? i.e. does it have zero quantity with no price, zero quantity with a total price (which is also zero), and zero quantity for each unit price?

Does this mixed amount appear to be zero when rendered with its display precision? i.e. does it have zero quantity with no price, zero quantity with a total price (which is also zero), and zero quantity for each unit price?

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.

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

Reset each individual amount's display style to the default.

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.

showMixedAmount = wbUnpack . showMixedAmountB noColour

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

showMixedAmountOneLine = wbUnpack . showMixedAmountB oneLine

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

Get the string representation of a mixed amount, without showing any transaction prices. With a True argument, adds ANSI codes to show negative amounts in red.

showMixedAmountWithoutPrice c = wbUnpack . showMixedAmountB noPrice{displayColour=c}

Get the one-line string representation of a mixed amount, but without any @ prices. With a True argument, adds ANSI codes to show negative amounts in red.

showMixedAmountOneLineWithoutPrice c = wbUnpack . showMixedAmountB oneLine{displayColour=c}

Like showMixedAmountOneLineWithoutPrice, but show at most the given width, with an elision indicator if there are more. With a True argument, adds ANSI codes to show negative amounts in red.

showMixedAmountElided w c = wbUnpack . showMixedAmountB oneLine{displayColour=c, displayMaxWidth=Just w}

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

showMixedAmountWithZeroCommodity = wbUnpack . showMixedAmountB noColour{displayZeroCommodity=True}

General function to generate a WideBuilder for a MixedAmount, according the supplied AmountDisplayOpts. This is the main function to use for showing MixedAmounts, constructing a builder; it can then be converted to a Text with wbToText, or to a String with wbUnpack.

If a maximum width is given then: - If displayed on one line, it will display as many Amounts as can fit in the given width, and further Amounts will be elided. - If displayed on multiple lines, any Amounts longer than the maximum width will be elided.

Helper for showMixedAmountB to show a MixedAmount on multiple lines. This returns the list of WideBuilders: one for each Amount in the MixedAmount (possibly normalised), and padded/elided to the appropriate width. This does not honour displayOneLine: all amounts will be displayed as if displayOneLine were False.

Convert a WideBuilder to a strict Text.

Convert a WideBuilder to a String.

Set the display precision in the amount's commodities.

In each component amount, increase the display precision sufficiently to render it exactly (showing all significant decimal digits).

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

Compact labelled trace of a mixed amount, for debugging.