< Back

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 experimental
Definition Classes
squants
package information
Definition Classes
squants
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
package mass
Definition Classes
squants
Since
0.1
AreaDensity
AreaDensityConversions
AreaDensityUnit
Carats
ChemicalAmount
ChemicalAmountConversions
ChemicalAmountUnit
Density
DensityConversions
DensityUnit
ElectronVoltMass
ExaElectronVoltMass
GigaElectronVoltMass
Grams
GramsPerSquareCentimeter
KiloElectronVoltMass
Kilograms
KilogramsMetersSquared
KilogramsPerCubicMeter
KilogramsPerHectare
KilogramsPerSquareMeter
Kilopounds
Mass
MassConversions
MassUnit
MegaElectronVoltMass
Megapounds
Micrograms
MilliElectronVoltMass
Milligrams
Moles
MomentOfInertia
MomentOfInertiaConversions
MomentOfInertiaUnit
Nanograms
Ounces
Pennyweights
PetaElectronVoltMass
PoundMoles
Pounds
PoundsPerAcre
PoundsSquareFeet
SolarMasses
Stone
TeraElectronVoltMass
Tolas
Tonnes
TroyGrains
TroyOunces
TroyPounds
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

p

mass

package mass

Source: package.scala
Since: 0.1

Linear Supertypes

Ordering

Alphabetic
By Inheritance

Inherited

mass
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

final class AreaDensity extends Quantity[AreaDensity]
Since
0.2.3
trait AreaDensityUnit extends UnitOfMeasure[AreaDensity]
final class ChemicalAmount extends Quantity[ChemicalAmount]
Since
0.1
trait ChemicalAmountUnit extends UnitOfMeasure[ChemicalAmount] with UnitConverter
final class Density extends Quantity[Density]
Since
0.1
trait DensityUnit extends UnitOfMeasure[Density] with UnitConverter
final class Mass extends Quantity[Mass] with TimeIntegral[motion.MassFlow]
Represents a quantity of Mass
Represents a quantity of Mass
Since
0.1
trait MassUnit extends UnitOfMeasure[Mass] with UnitConverter
Base trait for units of squants.mass.Mass
final class MomentOfInertia extends Quantity[MomentOfInertia]
Since
1.3
trait MomentOfInertiaUnit extends UnitOfMeasure[MomentOfInertia] with UnitConverter

Value Members

object AreaDensity extends Dimension[AreaDensity] with Serializable
Factory singleton for squants.mass.AreaDensity values
object AreaDensityConversions
object Carats extends MassUnit
object ChemicalAmount extends Dimension[ChemicalAmount] with BaseDimension with Serializable
object ChemicalAmountConversions
object Density extends Dimension[Density] with Serializable
object DensityConversions
object ElectronVoltMass extends MassUnit
object ExaElectronVoltMass extends MassUnit
object GigaElectronVoltMass extends MassUnit
object Grams extends MassUnit with PrimaryUnit with SiUnit
object GramsPerSquareCentimeter extends AreaDensityUnit with UnitConverter with SiUnit
object KiloElectronVoltMass extends MassUnit
object Kilograms extends MassUnit with SiBaseUnit
object KilogramsMetersSquared extends MomentOfInertiaUnit with PrimaryUnit with SiBaseUnit
object KilogramsPerCubicMeter extends DensityUnit with PrimaryUnit with SiUnit
object KilogramsPerHectare extends AreaDensityUnit with UnitConverter
object KilogramsPerSquareMeter extends AreaDensityUnit with PrimaryUnit with SiUnit
object Kilopounds extends MassUnit
object Mass extends Dimension[Mass] with BaseDimension with Serializable
Factory singleton for squants.mass.Mass values
object MassConversions
Implicit conversions for squants.mass.Mass
Implicit conversions for squants.mass.Mass
Provides support fot the DSL
object MegaElectronVoltMass extends MassUnit
object Megapounds extends MassUnit
object Micrograms extends MassUnit with SiUnit
object MilliElectronVoltMass extends MassUnit
object Milligrams extends MassUnit with SiUnit
object Moles extends ChemicalAmountUnit with PrimaryUnit with SiBaseUnit
object MomentOfInertia extends Dimension[MomentOfInertia] with Serializable
object MomentOfInertiaConversions
object Nanograms extends MassUnit with SiUnit
object Ounces extends MassUnit
object Pennyweights extends MassUnit
object PetaElectronVoltMass extends MassUnit
object PoundMoles extends ChemicalAmountUnit
object Pounds extends MassUnit
object PoundsPerAcre extends AreaDensityUnit with UnitConverter
object PoundsSquareFeet extends MomentOfInertiaUnit
object SolarMasses extends MassUnit
object Stone extends MassUnit
object TeraElectronVoltMass extends MassUnit
object Tolas extends MassUnit
object Tonnes extends MassUnit
object TroyGrains extends MassUnit
object TroyOunces extends MassUnit
object TroyPounds extends MassUnit

Inherited from AnyRef

Inherited from Any

Ungrouped