< 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 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
package motion

Definition Classes
squants
Since
0.1
Acceleration
AccelerationConversions
AccelerationUnit
AngularVelocity
AngularVelocityConversions
AngularVelocityUnit
Bars
BarsPerSecond
CubicFeetPerHour
CubicMetersPerSecond
DegreesPerSecond
EarthGravities
FeetPerSecond
FeetPerSecondCubed
FeetPerSecondSquared
Force
ForceConversions
ForceUnit
GallonsPerDay
GallonsPerHour
GallonsPerMinute
GallonsPerSecond
GradsPerSecond
InternationalMilesPerHour
Jerk
JerkConversions
JerkUnit
KilogramForce
KilogramsPerSecond
KilometersPerHour
KilometersPerSecond
KilopoundsPerHour
Knots
MassFlow
MassFlowConversions
MassFlowUnit
MegapoundsPerHour
MetersPerSecond
MetersPerSecondCubed
MetersPerSecondSquared
Momentum
MomentumConversions
MomentumUnit
NewtonSeconds
Newtons
NewtonsPerSecond
Pascals
PascalsPerSecond
PoundForce
PoundsPerHour
PoundsPerSecond
PoundsPerSquareInch
PoundsPerSquareInchPerSecond
Pressure
PressureChange
PressureChangeConversions
PressureChangeUnit
PressureConversions
PressureUnit
RadiansPerSecond
StandardAtmospheres
StandardAtmospheresPerSecond
TurnsPerSecond
UsMilesPerHour
UsMilesPerHourSquared
Velocity
VelocityConversions
VelocityUnit
VolumeFlow
VolumeFlowConversions
VolumeFlowRateUnit
Yank
YankConversions
YankUnit
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

squants

motion

package motion

Source: package.scala
Since: 0.1

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

motion
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

final class Acceleration extends Quantity[Acceleration] with TimeDerivative[Velocity] with SecondTimeDerivative[Length] with TimeIntegral[Jerk]
Represents a quantity of acceleration
Represents a quantity of acceleration

Since
0.1
trait AccelerationUnit extends UnitOfMeasure[Acceleration] with UnitConverter
Base trait for units of squants.motion.Acceleration
Base trait for units of squants.motion.Acceleration

Since
0.1
final class AngularVelocity extends Quantity[AngularVelocity] with TimeDerivative[Angle]

Since
0.1
trait AngularVelocityUnit extends UnitOfMeasure[AngularVelocity] with UnitConverter
type Distance = space.Length
type DistanceUnit = LengthUnit
final class Force extends Quantity[Force] with TimeDerivative[Momentum] with TimeIntegral[Yank]

Since
0.1
trait ForceUnit extends UnitOfMeasure[Force] with UnitConverter
final class Jerk extends Quantity[Jerk] with TimeDerivative[Acceleration] with SecondTimeDerivative[Velocity]
Represents the third time derivative of position after Velocity and Acceleration
Represents the third time derivative of position after Velocity and Acceleration

Since
0.1
trait JerkUnit extends UnitOfMeasure[Jerk] with UnitConverter
final class MassFlow extends Quantity[MassFlow] with TimeDerivative[Mass]

Since
0.1
trait MassFlowUnit extends UnitOfMeasure[MassFlow] with UnitConverter
final class Momentum extends Quantity[Momentum] with TimeIntegral[Force] with SecondTimeIntegral[Yank]

Since
0.1
trait MomentumUnit extends UnitOfMeasure[Momentum]
final class Pressure extends Quantity[Pressure] with TimeIntegral[PressureChange]

Since
0.1
final class PressureChange extends Quantity[PressureChange] with TimeDerivative[Pressure]

Since
0.5.2
trait PressureChangeUnit extends UnitOfMeasure[PressureChange] with UnitConverter
trait PressureUnit extends UnitOfMeasure[Pressure] with UnitConverter
final class Velocity extends Quantity[Velocity] with TimeIntegral[Acceleration] with SecondTimeIntegral[Jerk] with TimeDerivative[Length]
Represents a quantify of Velocity
Represents a quantify of Velocity

Since
0.1
trait VelocityUnit extends UnitOfMeasure[Velocity] with UnitConverter
final class VolumeFlow extends Quantity[VolumeFlow] with TimeDerivative[Volume]

Since
0.1
trait VolumeFlowRateUnit extends UnitOfMeasure[VolumeFlow] with UnitConverter
final class Yank extends Quantity[Yank] with TimeDerivative[Force] with SecondTimeDerivative[Momentum]

Since
0.1
trait YankUnit extends UnitOfMeasure[Yank] with UnitConverter

Value Members

lazy val EquatorGravity: Acceleration
lazy val PoleGravity: Acceleration
lazy val SpeedOfLight: Velocity
lazy val StandardEarthGravity: Acceleration
object Acceleration extends Dimension[Acceleration] with Serializable
object AccelerationConversions
object AngularVelocity extends Dimension[AngularVelocity] with Serializable
object AngularVelocityConversions
object Bars extends PressureUnit
object BarsPerSecond extends PressureChangeUnit
object CubicFeetPerHour extends VolumeFlowRateUnit
object CubicMetersPerSecond extends VolumeFlowRateUnit with PrimaryUnit with SiUnit
object DegreesPerSecond extends AngularVelocityUnit
object EarthGravities extends AccelerationUnit
Represents acceleration in Earth gravities also knows as G-Force, or g's
object FeetPerSecond extends VelocityUnit
object FeetPerSecondCubed extends JerkUnit
object FeetPerSecondSquared extends AccelerationUnit
object Force extends Dimension[Force] with Serializable
object ForceConversions
object GallonsPerDay extends VolumeFlowRateUnit
object GallonsPerHour extends VolumeFlowRateUnit
object GallonsPerMinute extends VolumeFlowRateUnit
object GallonsPerSecond extends VolumeFlowRateUnit
object GradsPerSecond extends AngularVelocityUnit
object InternationalMilesPerHour extends VelocityUnit
object Jerk extends Dimension[Jerk] with Serializable
object JerkConversions
object KilogramForce extends ForceUnit
object KilogramsPerSecond extends MassFlowUnit with PrimaryUnit with SiUnit
object KilometersPerHour extends VelocityUnit
object KilometersPerSecond extends VelocityUnit
object KilopoundsPerHour extends MassFlowUnit
object Knots extends VelocityUnit
object MassFlow extends Dimension[MassFlow] with Serializable
object MassFlowConversions
object MegapoundsPerHour extends MassFlowUnit
object MetersPerSecond extends VelocityUnit with PrimaryUnit with SiUnit
object MetersPerSecondCubed extends JerkUnit with PrimaryUnit with SiUnit
object MetersPerSecondSquared extends AccelerationUnit with PrimaryUnit with SiUnit
object Momentum extends Dimension[Momentum] with Serializable
object MomentumConversions
object NewtonSeconds extends MomentumUnit with PrimaryUnit with SiUnit
object Newtons extends ForceUnit with PrimaryUnit with SiUnit
object NewtonsPerSecond extends YankUnit with PrimaryUnit with SiUnit
object Pascals extends PressureUnit with PrimaryUnit with SiUnit
object PascalsPerSecond extends PressureChangeUnit with PrimaryUnit with SiUnit
object PoundForce extends ForceUnit
object PoundsPerHour extends MassFlowUnit
object PoundsPerSecond extends MassFlowUnit
object PoundsPerSquareInch extends PressureUnit
object PoundsPerSquareInchPerSecond extends PressureChangeUnit
object Pressure extends Dimension[Pressure] with Serializable
object PressureChange extends Dimension[PressureChange] with Serializable
object PressureChangeConversions
object PressureConversions
object RadiansPerSecond extends AngularVelocityUnit with PrimaryUnit with SiUnit
object StandardAtmospheres extends PressureUnit
object StandardAtmospheresPerSecond extends PressureChangeUnit
object TurnsPerSecond extends AngularVelocityUnit
object UsMilesPerHour extends VelocityUnit
object UsMilesPerHourSquared extends AccelerationUnit
object Velocity extends Dimension[Velocity] with Serializable
object VelocityConversions
object VolumeFlow extends Dimension[VolumeFlow] with Serializable
object VolumeFlowConversions
object Yank extends Dimension[Yank] with Serializable
object YankConversions

Inherited from AnyRef

Inherited from Any

Ungrouped