Packages

•  package root

  Definition Classes

  root

•  package squants

  The Scala API for Quantities, Units of Measure and Dimensional Analysis

  Squants

  The Scala API for Quantities, Units of Measure and Dimensional Analysis

  Overview

  Squants is a framework of data types and a domain specific language (DSL) for representing Quantities, their Units of Measure, and their Dimensional relationships. The API supports typesafe dimensional analysis, improved domain models and more. All types are immutable and thread-safe.

  Typedefs and implicits for common usages

  Definition Classes

  root

  Version

  0.1

  Since

  0.1

•  package market

  Squants Market API

  Squants Market API

  Market Types are similar but not quite the same as other quantities in the library.

  The primary type, squants.market.Money, is derived from Quantity, and its Units of Measure are Currencies. However, because the conversion multipliers between units can not be predefined, many of the behaviors have been overridden and augmented to realize correct behavior.

  squants.market.Prices represent a Ratio between Money and some other Quantity. Prices can be created from ratios of Money and a Quantity

  val money: Money = USD(10)
  val length: Length = Meters(1)
  val price: Price[Length] = money / length

  Multiplying a Price * Quantity will yield Money amount that represents the cost of the quantity

  val cost: Money = price * Meters(3.8)

  and multiplying Price * Money will yield the corresponding Quantity amount

  val budget: Money = USD(250)
  val quote: Length = price * budget

  squants.market.CurrencyExchangeRates represent conversion rates between currencies. Use them to explicitly convert Money values in one currency to values in another.

  squants.market.MoneyContext provide the implicit context necessary to perform cross-currency operations on Money values with conversions automatically applied.

  Some binary math operations will work on Moneys of like Currency with no MoneyContext in scope. Attempts to perform these operations on Moneys of dissimilar currencies will throw an exception at runtime.

  Other operations, including direct conversions to other currencies, require a MoneyContext and will not compile without it. However, there is no compile time check to determine if the correct exchange rates will be available at runtime. Operation requiring conversion without the required rates available will throw a NoSuchExchangeRateException at runtime.

  The defaultMoneyContext uses the USD as the default and provides a list of ~20 common currencies, and NO exchange rates. If your application requires something different you should initialize your own implicit MoneyContext

  Definition Classes

  squants

  Since

  0.1

• ARS
• AUD
• BRL
• BTC
• CAD
• CHF
• CLP
• CNY
• CZK
• Currency
• CurrencyExchangeRate
• DKK
• ETH
• EUR
• GBP
• HKD
• INR
• JPY
• KRW
• LTC
• MXN
• MYR
• Money
• MoneyContext
• MoneyConversions
• NAD
• NOK
• NZD
• NoSuchCurrencyException
• NoSuchExchangeRateException
• Price
• RUB
• SEK
• USD
• XAG
• XAU
• ZAR

squants.market

MoneyConversions