<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Hledger.Data.Commodity</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Hledger-Data-Commodity.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Hledger-Data-Commodity.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">hledger-lib-0.14: Reusable types and utilities for the hledger accounting tool and financial apps in general.</p></div><div id="content"><div id="module-header"><p class="caption">Hledger.Data.Commodity</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A <code><a href="Hledger-Data-Types.html#t:Commodity">Commodity</a></code> is a symbol representing a currency or some other kind of
thing we are tracking, and some display preferences that tell how to
display <code><a href="Hledger-Data-Types.html#t:Amount">Amount</a></code>s of the commodity - is the symbol on the left or right,
are thousands separated by comma, significant decimal places and so on.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:comm">comm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a></li><li class="src short"><a href="#v:conversionRate">conversionRate</a> :: <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a></li><li class="src short"><a href="#v:canonicaliseCommodities">canonicaliseCommodities</a> :: [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:comm" class="def">comm</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a><a href="src/Hledger-Data-Commodity.html#comm" class="link">Source</a></p><div class="doc"><p>Look up one of the hard-coded default commodities. For use in tests.
</p></div></div><div class="top"><p class="src"><a name="v:conversionRate" class="def">conversionRate</a> :: <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a><a href="src/Hledger-Data-Commodity.html#conversionRate" class="link">Source</a></p><div class="doc"><p>Find the conversion rate between two commodities. Currently returns 1.
</p></div></div><div class="top"><p class="src"><a name="v:canonicaliseCommodities" class="def">canonicaliseCommodities</a> :: [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a><a href="src/Hledger-Data-Commodity.html#canonicaliseCommodities" class="link">Source</a></p><div class="doc"><p>Convert a list of commodities to a map from commodity symbols to
unique, display-preference-canonicalised commodities.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
