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 electro

Definition Classes: squants
Since: 0.1

package energy

Definition Classes: squants
Since: 0.1

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

BaseDimension

BinarySystem

Dimension

Dimensionless

DimensionlessConversions

DimensionlessUnit

DoubleVector

Dozen

Each

Gross

LikeRatio

MetricSystem

Percent

PrimaryUnit

Quantity

QuantityParseException

QuantityRange

QuantityVector

Ratio

SVector

Score

SiBaseUnit

SiUnit

SquantifiedBigDecimal

SquantifiedDouble

SquantifiedLong

UnitConverter

UnitOfMeasure

squants

Dimensionless

Companion class Dimensionless

object Dimensionless extends Dimension[Dimensionless] with Serializable

Factory singleton for squants.Dimensionless

Source: Dimensionless.scala

Linear Supertypes

Serializable, Serializable, Dimension[Dimensionless], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Dimensionless
Serializable
Serializable
Dimension
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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
def apply: (Any) ⇒ Try[Dimensionless]
def apply[A](n: A, unit: DimensionlessUnit)(implicit num: Numeric[A]): Dimensionless
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def name: String
The name
The name

Definition Classes
Dimensionless → Dimension
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parse(value: Any): Try[Dimensionless]
Tries to map a string or tuple value to Quantity of this Dimension
Tries to map a string or tuple value to Quantity of this Dimension
value
the source string (ie, "10 kW") or tuple (ie, (10, "kW"))
returns
Try[A]

Attributes
protected
Definition Classes
Dimension
def primaryUnit: Each.type
The unit with a conversions factor of 1.
The unit with a conversions factor of 1. The conversionFactor for other units should be set relative to this unit.

Definition Classes
Dimensionless → Dimension
def siUnit: Each.type
The International System of Units (SI) Base Unit
The International System of Units (SI) Base Unit

Definition Classes
Dimensionless → Dimension
def symbolToUnit(symbol: String): Option[UnitOfMeasure[Dimensionless]]
Maps a string representation of a unit symbol into the matching UnitOfMeasure object
Maps a string representation of a unit symbol into the matching UnitOfMeasure object
symbol
String

Definition Classes
Dimension
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def units: Set[UnitOfMeasure[Dimensionless]]
Set of available units
Set of available units

Definition Classes
Dimensionless → Dimension
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Packages

Squants

Overview

Dimensionless

Companion class Dimensionless

object Dimensionless extends Dimension[Dimensionless] with Serializable

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Dimension[Dimensionless]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Squants

Overview

Dimensionless 

Companion class Dimensionless

object Dimensionless extends Dimension[Dimensionless] with Serializable

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Dimension[Dimensionless]

Inherited from AnyRef

Inherited from Any

Ungrouped

Dimensionless