coulomb-docs
0.8.0
API
Generated with
coulomb-docs/coulomb

coulomb

package coulomb

Members list

Packages

package coulomb.benchmarks
package coulomb.conversion
package coulomb.define
package coulomb.infra
package coulomb.ops
package coulomb.parser
package coulomb.policy
package coulomb.pureconfig
package coulomb.rational
package coulomb.syntax
package coulomb.testkit
package coulomb.units

Type members

Classlikes

trait CoefficientRuntime

Attributes

Source
runtime.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DeltaQuantity

Defines DeltaQuantity constructors and extension methods

Defines DeltaQuantity constructors and extension methods

Attributes

Source
deltaquantity.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object Quantity

Defines Quantity constructors and extension methods

Defines Quantity constructors and extension methods

Attributes

Source
quantity.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Quantity.type
case class RuntimeQuantity[V](value: V, unit: RuntimeUnit)

Attributes

Companion
object
Source
runtime.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RuntimeQuantity

Attributes

Companion
class
Source
runtime.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class RuntimeUnit

Attributes

Companion
object
Source
runtime.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Div
class Mul
class Pow
class UnitConst
class UnitType
object RuntimeUnit

Attributes

Companion
class
Source
runtime.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

final type *[L, R]

Represents the product of two unit expressions

Represents the product of two unit expressions

Type parameters

L

the left-hand unit subexpression

R

the right-hand unit subexpression

type AcreFoot = (Acre * Foot)

Attributes

Source
quantity.scala
final type /[L, R]

Represents unit division

Represents unit division

Type parameters

L

the left-hand unit subexpression (numerator)

R

the right-hand unit subexpression (denominator)

type MPS = (Meter / Second)

Attributes

Source
quantity.scala
opaque type DeltaQuantity[V, U, B]

Represents a value with an associated unit type and "delta" offset, for example coulomb.units.temperature.Temperature or coulomb.units.time.EpochTime

Represents a value with an associated unit type and "delta" offset, for example coulomb.units.temperature.Temperature or coulomb.units.time.EpochTime

Type parameters

B

base unit type (the base unit of U)

U

the unit type

V

the raw value type

Attributes

Source
deltaquantity.scala
opaque type Quantity[V, U]

Represents a value with an associated unit type

Represents a value with an associated unit type

Type parameters

U

the unit type

V

the raw value type

Attributes

Source
quantity.scala
final type ^[B, E]

Represents raising unit expression B to rational power E

Represents raising unit expression B to rational power E

Type parameters

B

a base unit expression

E

a rational exponent

type V = (Meter ^ 3)
type H = (Second ^ -1)
type R = (Meter ^ (1 / 2))

Attributes

Source
quantity.scala

Deprecated types

final type Unitless = 1

Attributes

Deprecated
true
Source
quantity.scala

Value members

Concrete methods

inline def coefficient[V, UF, UT](using vc: ValueConversion[Rational, V]): V

Obtain the coefficient of conversion from one unit expression to another

Obtain the coefficient of conversion from one unit expression to another

Type parameters

UF

the input unit expression

UT

the output unit expression

V

the value type to return

Attributes

Returns

the coefficient of conversion from UF to UT If UF and UT are not convertible, causes a compilation failure.

Source
quantity.scala
inline def showUnit[U]: String

obtain a string representation of a unit type, using unit abbreviation forms

obtain a string representation of a unit type, using unit abbreviation forms

Type parameters

U

the unit type

Attributes

Returns

the unit in string form

showUnit[Meter / Second] // => "m/s"
Source
quantity.scala
inline def showUnitFull[U]: String

obtain a string representation of a unit type, using full unit names

obtain a string representation of a unit type, using full unit names

Type parameters

U

the unit type

Attributes

Returns

the unit in string form

showUnitFull[Meter / Second] // => "meter/second"
Source
quantity.scala
Generated with