Data.Metrology.Quantity

Exports a class Quantity to allow easy conversion between proper quantities and types from other libraries.

Documentation

class Quantity t where

Quantity allows for easy conversions in and out of quantities. For example, say you are working with an outside library for time that defines UTCTime, where that stores the time measured in seconds. You could say

instance Quantity UTCTime where
  type QuantityUnit = Second
  fromQuantity = ...
  toQuantity = ...

Then, conversions are easy and unit-safe.

Minimal complete definition

fromQuantity, toQuantity

Associated Types

type QuantityUnit t :: *

The unit associated with t.

type QuantityLCSU t :: LCSU *

The LCSU associated with t. Defaults to DefaultLCSU.

type QuantityRep t :: *

The numerical representation associated with t. Defaults to Double.

Methods

fromQuantity :: QuantityQu t -> t

toQuantity :: t -> QuantityQu t

Instances

ValidDL d l => Quantity (Qu d l n)

Associated Types

type QuantityUnit (Qu d l n) :: *

type QuantityLCSU (Qu d l n) :: LCSU *

type QuantityRep (Qu d l n) :: *

Methods

fromQuantity :: QuantityQu (Qu d l n) -> Qu d l n

toQuantity :: Qu d l n -> QuantityQu (Qu d l n)

type QuantityQu t = MkQu_ULN (QuantityUnit t) (QuantityLCSU t) (QuantityRep t)

The Qu type associated with a member of the Quantity class