Packages

Definition Classes: root

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 electro

Definition Classes: squants
Since: 0.1

package energy

Definition Classes: squants
Since: 0.1

package experimental

Definition Classes: squants

package information

Definition Classes: squants

package market

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

package mass

Definition Classes: squants
Since: 0.1

package motion

Definition Classes: squants
Since: 0.1

package photo

Definition Classes: squants
Since: 0.1

package radio

Definition Classes: squants
Since: 0.1

package space

Definition Classes: squants
Since: 0.1

package thermal

Definition Classes: squants
Since: 0.1

package time

Definition Classes: squants
Since: 0.1

AbstractQuantityNumeric

DimensionlessConversions

QuantityParseException

SecondTimeDerivative2

SecondTimeIntegral2

SiBaseUnit

SiUnit

SquantifiedBigDecimal

DimensionlessConversions

object DimensionlessConversions

Source: Dimensionless.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

DimensionlessConversions
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

implicit class DimensionlessConversions[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
implicit def dimensionlessToDouble(d: Dimensionless): Double
Provides an implicit conversion from Dimensionless to Double, allowing a Dimensionless value to be used anywhere a Double (or similar primitive) is required
Provides an implicit conversion from Dimensionless to Double, allowing a Dimensionless value to be used anywhere a Double (or similar primitive) is required
d
Dimensionless
lazy val dozen: Dimensionless
lazy val each: Dimensionless
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
lazy val gross: Dimensionless
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
lazy val hundred: Dimensionless
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
lazy val million: Dimensionless
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
lazy val percent: Dimensionless
lazy val score: Dimensionless
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
lazy val thousand: Dimensionless
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
implicit object DimensionlessNumeric extends AbstractQuantityNumeric[Dimensionless]

Packages

Squants

Overview

DimensionlessConversions

object DimensionlessConversions

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Squants

Overview

DimensionlessConversions

object DimensionlessConversions

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

DimensionlessConversions