units

Type Members

type /[U <: MUnit, V <: MUnit] = units./.U.Mul[units./.V.Invert]

Unit division.
type ><[U <: MUnit, V <: MUnit] = units.><.U.Mul[V]

Unit multiplication.
type @@[N, U <: MUnit] = WithU[N, U]
trait AffineSpace extends AnyRef

Supertype of all affine spaces.
Supertype of all affine spaces.
Affine space is similar to a vector space, but it does not contain a distinguished origin point. In order to manipulate points from the affine space, we have to pick the origin (aka the zero point) ourselves.
Examples of affine spaces are temperature scales, time, (physical) space, and so on.
final case class DoubleA[A <: AffineSpace](value: Double) extends AnyVal with Product with Serializable

Double-precision floating-point value representing a point in a 1-dimensional affine space.
type DoubleAffineSpaceConverter[T1 <: AffineSpace, T2 <: AffineSpace] = units.internal.ratios.DoubleAffineSpaceConverter[T1, T2]
type DoubleRatio[U <: MUnit, V <: MUnit] = units.internal.ratios.DoubleRatio[U, V]
final case class DoubleU[U <: MUnit](value: Double) extends AnyVal with Product with Serializable

Double-precision floating-point value representing a value with a unit of measure.
implicit final class DoubleUBuilder extends AnyVal

Extention methods for Double.
final case class IntA[A <: AffineSpace](value: Long) extends AnyVal with Product with Serializable

64-bit signed integer representing a point in a 1-dimensional affine space.
type IntAffineSpaceConverter[T1 <: AffineSpace, T2 <: AffineSpace] = units.internal.ratios.IntAffineSpaceConverter[T1, T2]
type IntRatio[U <: MUnit, V <: MUnit] = units.internal.ratios.IntRatio[U, V]
final case class IntU[U <: MUnit](value: Long) extends AnyVal with Product with Serializable

64-bit signed integer representing a value with a unit of measure.
implicit final class IntUBuilder extends AnyVal

Extention methods for Long.
trait MUnit extends AnyRef

Supertype of all units of measure.
final class System1[U1 <: TSingleUnit, V1 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 1 unit.
final class System2[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 2 units.
final class System3[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 3 units.
final class System4[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 4 units.
final class System5[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 5 units.
final class System6[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit, U6 <: TSingleUnit, V6 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 6 units.
final class System7[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit, U6 <: TSingleUnit, V6 <: MUnit, U7 <: TSingleUnit, V7 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 7 units.
final class System8[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit, U6 <: TSingleUnit, V6 <: MUnit, U7 <: TSingleUnit, V7 <: MUnit, U8 <: TSingleUnit, V8 <: MUnit] extends AnyVal

Represents a system of units of measurements consisting of 8 units.
implicit final class UnitNameBuilder extends AnyVal

Annotations
@inline()
case class Vector2A[A <: AffineSpace](x: DoubleA[A], y: DoubleA[A]) extends Product with Serializable

A two-dimensional vector within an affine space
case class Vector2U[U <: MUnit](x: DoubleU[U], y: DoubleU[U]) extends Product with Serializable

A two-dimensional vector with a unit
class Vector2UBuilder extends AnyRef
case class Vector3A[A <: AffineSpace](x: DoubleA[A], y: DoubleA[A], z: DoubleA[A]) extends Product with Serializable

A three-dimensional vector within an affine space
case class Vector3U[U <: MUnit](x: DoubleU[U], y: DoubleU[U], z: DoubleU[U]) extends Product with Serializable

A three-dimensional vector with a unit
class Vector3UBuilder extends AnyRef
case class WithA[N, A <: AffineSpace](value: N) extends Product with Serializable

A value within an affine space.
A value within an affine space.
Warning: this is an experimental feature and may be subject to removal or severe redesign.
case class WithU[N, U <: MUnit](value: N) extends Product with Serializable

A value with a unit of measure.
A value with a unit of measure.
Warning: this is an experimental feature and may be subject to removal or severe redesign.
implicit final class WithUBuilder[N] extends AnyVal

Extension methods for everything
type _1 = TDimensionless

Unit dimensionless values have, which is 1.
type cube[U <: MUnit] = units.cube.U.ToPower[P3]

Takes unit to the third power.
type inverse[U <: MUnit] = units.inverse.U.Invert

Gets inverse of a unit.
Gets inverse of a unit. inverse[second] is equivalent to hertz.
type inverseCube[U <: MUnit] = units.inverseCube.U.ToPower[N3]

Gets inverse of the third power a unit.
type inversePower4[U <: MUnit] = units.inversePower4.U.ToPower[N4]

Gets inverse of the fourth power a unit.
type inversePower5[U <: MUnit] = units.inversePower5.U.ToPower[N5]

Gets inverse of the fifth power a unit.
type inverseSquare[U <: MUnit] = units.inverseSquare.U.ToPower[N2]

Gets inverse of the second power a unit.
type power4[U <: MUnit] = units.power4.U.ToPower[P4]

Takes unit to the fourth power.
type power5[U <: MUnit] = units.power5.U.ToPower[P5]

Takes unit to the fifth power.
type square[U <: MUnit] = units.square.U.ToPower[P2]

Takes unit to the second power.
type ×[U <: MUnit, V <: MUnit] = units.×.U.Mul[V]

Unit multiplication.

Value Members

object Currency

Some of currencies of the world.
object DoubleA extends Serializable
object DoubleU extends Serializable
object Information

Units of information.
object IntA extends Serializable
object IntU extends Serializable
object Mechanical

Abstract definition of mechanical units, for use with explicit polymorphism.
object SI

SI units.
object System1
object System2
object System3
object System4
object System5
object System6
object System7
object System8
object USCustomary

US customary and British units and their conversions to SI.
object Vector2A extends Serializable
object Vector2U extends Serializable
object Vector3A extends Serializable
object Vector3U extends Serializable
object WithA extends Serializable
object WithU extends Serializable
package arrays
package constants
package defining

Package containing helper types and methods for defining new units and ratios between units.
Package containing helper types and methods for defining new units and ratios between units.
It also contains a set of type-level characters, used for defining type-level unit identifiers.
Usage:
import io.github.karols.units.defining._
implicit def implicit_dimensionless2DoubleUBuilder(value: DoubleU[_1]): DoubleUBuilder

Annotations
@inline()
implicit def implicit_dimensionless2IntUBuilder(value: IntU[_1]): IntUBuilder

Annotations
@inline()
implicit def implicit_dimensionless2Vector2UBuilder(value: Vector2U[_1]): Vector2UBuilder

Annotations
@inline()
implicit def implicit_dimensionless2Vector3UBuilder(value: Vector3U[_1]): Vector3UBuilder

Annotations
@inline()
implicit def implicit_float2DoubleUBuilder(value: Float): DoubleUBuilder

Annotations
@inline()
implicit def implicit_fromDimensionlessDouble(i: DoubleU[_1]): Double

Annotations
@inline()
implicit def implicit_fromDimensionlessInt(i: IntU[_1]): Long

Annotations
@inline()
implicit def implicit_fromDimensionlessTuple(i: Vector3U[_1]): (Double, Double, Double)

Annotations
@inline()
implicit def implicit_int2IntUBuilder(value: Int): IntUBuilder

Annotations
@inline()
implicit def implicit_toDimensionlessDouble(i: Double): DoubleU[_1]

Annotations
@inline()
implicit def implicit_toDimensionlessFloat(i: Float): DoubleU[_1]

Annotations
@inline()
implicit def implicit_toDimensionlessInt(i: Int): IntU[_1]

Annotations
@inline()
implicit def implicit_toDimensionlessLong(i: Long): IntU[_1]

Annotations
@inline()
implicit def implicit_toDimensionlessTupleDDD(i: (Double, Double, Double)): Vector3U[_1]

Annotations
@inline()
implicit def implicit_toDimensionlessTupleIII(i: (Int, Int, Int)): Vector3U[_1]

Annotations
@inline()
implicit def implicit_tupleDD2Vector2UBuilder(value: (Double, Double)): Vector2UBuilder

Annotations
@inline()
implicit def implicit_tupleDDD2Vector3UBuilder(value: (Double, Double, Double)): Vector3UBuilder

Annotations
@inline()
implicit def implicit_tupleII2Vector2UBuilder(value: (Int, Int)): Vector2UBuilder

Annotations
@inline()
implicit def implicit_tupleIII2Vector3UBuilder(value: (Int, Int, Int)): Vector3UBuilder

Annotations
@inline()
implicit def implicit_widening[U <: MUnit](i: IntU[U]): DoubleU[U]

Annotations
@inline()
implicit def implicit_wideningA[A <: AffineSpace](i: IntA[A]): DoubleA[A]

Annotations
@inline()
package internal
package utils

package units

Type Members

type /[U <: MUnit, V <: MUnit] = units./.U.Mul[units./.V.Invert]

type ><[U <: MUnit, V <: MUnit] = units.><.U.Mul[V]

type @@[N, U <: MUnit] = WithU[N, U]

trait AffineSpace extends AnyRef

final case class DoubleA[A <: AffineSpace](value: Double) extends AnyVal with Product with Serializable

type DoubleAffineSpaceConverter[T1 <: AffineSpace, T2 <: AffineSpace] = units.internal.ratios.DoubleAffineSpaceConverter[T1, T2]

type DoubleRatio[U <: MUnit, V <: MUnit] = units.internal.ratios.DoubleRatio[U, V]

final case class DoubleU[U <: MUnit](value: Double) extends AnyVal with Product with Serializable

implicit final class DoubleUBuilder extends AnyVal

final case class IntA[A <: AffineSpace](value: Long) extends AnyVal with Product with Serializable

type IntAffineSpaceConverter[T1 <: AffineSpace, T2 <: AffineSpace] = units.internal.ratios.IntAffineSpaceConverter[T1, T2]

type IntRatio[U <: MUnit, V <: MUnit] = units.internal.ratios.IntRatio[U, V]

final case class IntU[U <: MUnit](value: Long) extends AnyVal with Product with Serializable

implicit final class IntUBuilder extends AnyVal

trait MUnit extends AnyRef

final class System1[U1 <: TSingleUnit, V1 <: MUnit] extends AnyVal

final class System2[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit] extends AnyVal

final class System3[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit] extends AnyVal

final class System4[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit] extends AnyVal

final class System5[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit] extends AnyVal

final class System6[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit, U6 <: TSingleUnit, V6 <: MUnit] extends AnyVal

final class System7[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit, U6 <: TSingleUnit, V6 <: MUnit, U7 <: TSingleUnit, V7 <: MUnit] extends AnyVal

final class System8[U1 <: TSingleUnit, V1 <: MUnit, U2 <: TSingleUnit, V2 <: MUnit, U3 <: TSingleUnit, V3 <: MUnit, U4 <: TSingleUnit, V4 <: MUnit, U5 <: TSingleUnit, V5 <: MUnit, U6 <: TSingleUnit, V6 <: MUnit, U7 <: TSingleUnit, V7 <: MUnit, U8 <: TSingleUnit, V8 <: MUnit] extends AnyVal

implicit final class UnitNameBuilder extends AnyVal

case class Vector2A[A <: AffineSpace](x: DoubleA[A], y: DoubleA[A]) extends Product with Serializable

case class Vector2U[U <: MUnit](x: DoubleU[U], y: DoubleU[U]) extends Product with Serializable

class Vector2UBuilder extends AnyRef

case class Vector3A[A <: AffineSpace](x: DoubleA[A], y: DoubleA[A], z: DoubleA[A]) extends Product with Serializable

case class Vector3U[U <: MUnit](x: DoubleU[U], y: DoubleU[U], z: DoubleU[U]) extends Product with Serializable

class Vector3UBuilder extends AnyRef

case class WithA[N, A <: AffineSpace](value: N) extends Product with Serializable

case class WithU[N, U <: MUnit](value: N) extends Product with Serializable

implicit final class WithUBuilder[N] extends AnyVal

type _1 = TDimensionless

type cube[U <: MUnit] = units.cube.U.ToPower[P3]

type inverse[U <: MUnit] = units.inverse.U.Invert

type inverseCube[U <: MUnit] = units.inverseCube.U.ToPower[N3]

type inversePower4[U <: MUnit] = units.inversePower4.U.ToPower[N4]

type inversePower5[U <: MUnit] = units.inversePower5.U.ToPower[N5]

type inverseSquare[U <: MUnit] = units.inverseSquare.U.ToPower[N2]

type power4[U <: MUnit] = units.power4.U.ToPower[P4]

type power5[U <: MUnit] = units.power5.U.ToPower[P5]

type square[U <: MUnit] = units.square.U.ToPower[P2]

type ×[U <: MUnit, V <: MUnit] = units.×.U.Mul[V]

Value Members

object Currency

object DoubleA extends Serializable

object DoubleU extends Serializable

object Information

object IntA extends Serializable

object IntU extends Serializable

object Mechanical

object SI

object System1

object System2

object System3

object System4

object System5

object System6

object System7

object System8

object USCustomary

object Vector2A extends Serializable

object Vector2U extends Serializable

object Vector3A extends Serializable

object Vector3U extends Serializable

object WithA extends Serializable

object WithU extends Serializable

package arrays

package constants

package defining

implicit def implicit_dimensionless2DoubleUBuilder(value: DoubleU[_1]): DoubleUBuilder

implicit def implicit_dimensionless2IntUBuilder(value: IntU[_1]): IntUBuilder

implicit def implicit_dimensionless2Vector2UBuilder(value: Vector2U[_1]): Vector2UBuilder

implicit def implicit_dimensionless2Vector3UBuilder(value: Vector3U[_1]): Vector3UBuilder

implicit def implicit_float2DoubleUBuilder(value: Float): DoubleUBuilder

implicit def implicit_fromDimensionlessDouble(i: DoubleU[_1]): Double