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

Days

Frequency

FrequencyConversions

FrequencyUnit

Gigahertz

Hertz

Hours

HoursSquared

Kilohertz

Megahertz

Microseconds

Milliseconds

Minutes

MinutesSquared

Nanoseconds

RevolutionsPerMinute

SecondTimeDerivative

SecondTimeIntegral

Seconds

SecondsSquared

Terahertz

Time

TimeConversions

TimeDerivative

TimeIntegral

TimeSquared

TimeSquaredUnit

TimeUnit

squants

time

package time

Source: package.scala
Since: 0.1

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

time
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

final class Frequency extends Quantity[Frequency] with TimeDerivative[Dimensionless]
Represents a quantity of frequency, which is the number cycles (count) over time
Represents a quantity of frequency, which is the number cycles (count) over time

Since
0.1
trait FrequencyUnit extends UnitOfMeasure[Frequency] with UnitConverter
trait SecondTimeDerivative [A <: SecondTimeIntegral[_]] extends AnyRef
trait SecondTimeIntegral [A <: SecondTimeDerivative[_]] extends AnyRef
final class Time extends Quantity[Time]
Represents a quantity of Time
Represents a quantity of Time

Since
0.1
trait TimeDerivative [A <: Quantity[A] with TimeIntegral[_]] extends AnyRef
Represents a rate of change over time of the integral quantity
Represents a rate of change over time of the integral quantity
A
The type of quantity changing

Since
0.1
trait TimeIntegral [A <: Quantity[A] with TimeDerivative[_]] extends AnyRef
Represents a Quantity type used as the integral of a time derivative
Represents a Quantity type used as the integral of a time derivative
A
The Quantity type for the TimeDerivative for which this is the base

Since
0.1
case class TimeSquared (time1: Time, time2: Time) extends Product with Serializable
Represents an intermediate value used in 2nd derivative time calculations
Represents an intermediate value used in 2nd derivative time calculations
Create objects by calling the Time.squared method.
q1 / TimeSquared(t1, t2) == q1 / t1 / t2 == q1 / (t1 * t2)
q2 * TimeSquared(t1, t2) == q2 * t1 * t2
q1 / t1.squared == q1 / t1 / t1
q2 * t1.squared == q2 * t1 * t1
where q1 is a second degree time integral and q2 is a second degree time derivative
time1
Time
time2
Time

Since
0.5.1
trait TimeSquaredUnit extends AnyRef
trait TimeUnit extends UnitOfMeasure[Time] with UnitConverter

Value Members

object Days extends TimeUnit
object Frequency extends Dimension[Frequency] with Serializable
object FrequencyConversions
object Gigahertz extends FrequencyUnit
object Hertz extends FrequencyUnit with PrimaryUnit with SiUnit
object Hours extends TimeUnit
object HoursSquared extends TimeSquaredUnit
object Kilohertz extends FrequencyUnit
object Megahertz extends FrequencyUnit
object Microseconds extends TimeUnit
object Milliseconds extends TimeUnit with PrimaryUnit
object Minutes extends TimeUnit
object MinutesSquared extends TimeSquaredUnit
object Nanoseconds extends TimeUnit
object RevolutionsPerMinute extends FrequencyUnit
object Seconds extends TimeUnit with SiBaseUnit
object SecondsSquared extends TimeSquaredUnit
object Terahertz extends FrequencyUnit
object Time extends Dimension[Time] with BaseDimension with Serializable
object TimeConversions
object TimeSquared extends Serializable

Packages

Squants

Overview

time

package time

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Squants

Overview

time 

package time

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

time