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

Bytes

BytesPerSecond

DataRate

DataRateConversions

DataRateUnit

Exabytes

ExabytesPerSecond

Exbibytes

ExbibytesPerSecond

Gibibytes

GibibytesPerSecond

Gigabytes

GigabytesPerSecond

Information

InformationConversions

InformationUnit

Kibibytes

KibibytesPerSecond

Kilobytes

KilobytesPerSecond

Mebibytes

MebibytesPerSecond

Megabytes

MegabytesPerSecond

Octets

Pebibytes

PebibytesPerSecond

Petabytes

PetabytesPerSecond

Tebibytes

TebibytesPerSecond

Terabytes

TerabytesPerSecond

Yobibytes

YobibytesPerSecond

Yottabytes

YottabytesPerSecond

Zebibytes

ZebibytesPerSecond

Zettabytes

ZettabytesPerSecond

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

squants

information

package information

Ordering

Alphabetic

Visibility

Public
All

Type Members

final class DataRate extends Quantity[DataRate] with TimeDerivative[Information]
Represnets a rate of transfer of information
trait DataRateUnit extends UnitOfMeasure[DataRate] with UnitConverter
final class Information extends Quantity[Information] with TimeIntegral[DataRate]
Represents information.
Represents information.

Since
0.6.0
trait InformationUnit extends UnitOfMeasure[Information] with UnitConverter

Value Members

object Bytes extends InformationUnit with PrimaryUnit with SiBaseUnit
object BytesPerSecond extends DataRateUnit with PrimaryUnit with SiUnit
object DataRate extends Dimension[DataRate] with Serializable
object DataRateConversions
object Exabytes extends InformationUnit
object ExabytesPerSecond extends DataRateUnit
object Exbibytes extends InformationUnit
object ExbibytesPerSecond extends DataRateUnit
object Gibibytes extends InformationUnit
object GibibytesPerSecond extends DataRateUnit
object Gigabytes extends InformationUnit
object GigabytesPerSecond extends DataRateUnit
object Information extends Dimension[Information] with BaseDimension with Serializable
Factory singleton for information
object InformationConversions
object Kibibytes extends InformationUnit
object KibibytesPerSecond extends DataRateUnit
object Kilobytes extends InformationUnit
object KilobytesPerSecond extends DataRateUnit
object Mebibytes extends InformationUnit
object MebibytesPerSecond extends DataRateUnit
object Megabytes extends InformationUnit
object MegabytesPerSecond extends DataRateUnit
object Octets extends InformationUnit
object Pebibytes extends InformationUnit
object PebibytesPerSecond extends DataRateUnit
object Petabytes extends InformationUnit
object PetabytesPerSecond extends DataRateUnit
object Tebibytes extends InformationUnit
object TebibytesPerSecond extends DataRateUnit
object Terabytes extends InformationUnit
object TerabytesPerSecond extends DataRateUnit
object Yobibytes extends InformationUnit
object YobibytesPerSecond extends DataRateUnit
object Yottabytes extends InformationUnit
object YottabytesPerSecond extends DataRateUnit
object Zebibytes extends InformationUnit
object ZebibytesPerSecond extends DataRateUnit
object Zettabytes extends InformationUnit
object ZettabytesPerSecond extends DataRateUnit

Packages

Squants

Overview

information 

package information

Type Members

Value Members

Ungrouped

information