Numeric.Units.Dimensional.Variants

Provides a type level representation of Variants of dimensional values, which may be quantities or units.

Documentation

data Variant

The kind of variants of dimensional values.

Constructors

DQuantity ExactPi'

The value is a quantity, stored as an ExactPi multiple of its value in its dimension's SI coherent unit.

DUnit Metricality

The value is a unit, possibly a Metric unit.

Instances

Generic Variant

Associated Types

type Rep Variant :: * -> *

Methods

from :: Variant -> Rep Variant x

to :: Rep Variant x -> Variant

type Rep Variant

type Rep Variant = D1 * (MetaData "Variant" "Numeric.Units.Dimensional.Variants" "dimensional-1.1-FrwO52z7cgM7jRCbk3nsMF" False) ((:+:) * (C1 * (MetaCons "DQuantity" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * ExactPi'))) (C1 * (MetaCons "DUnit" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Metricality))))

data Metricality

Encodes whether a unit is a metric unit, that is, whether it can be combined with a metric prefix to form a related unit.

Constructors

Metric

Capable of receiving a metric prefix.

NonMetric

Incapable of receiving a metric prefix.

Instances

Eq Metricality

Methods

(==) :: Metricality -> Metricality -> Bool

(/=) :: Metricality -> Metricality -> Bool

Data Metricality

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Metricality -> c Metricality

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Metricality

toConstr :: Metricality -> Constr

dataTypeOf :: Metricality -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Metricality)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Metricality)

gmapT :: (forall b. Data b => b -> b) -> Metricality -> Metricality

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Metricality -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Metricality -> r

gmapQ :: (forall d. Data d => d -> u) -> Metricality -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Metricality -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Metricality -> m Metricality

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Metricality -> m Metricality

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Metricality -> m Metricality

Ord Metricality

Methods

compare :: Metricality -> Metricality -> Ordering

(<) :: Metricality -> Metricality -> Bool

(<=) :: Metricality -> Metricality -> Bool

(>) :: Metricality -> Metricality -> Bool

(>=) :: Metricality -> Metricality -> Bool

max :: Metricality -> Metricality -> Metricality

min :: Metricality -> Metricality -> Metricality

Generic Metricality

Associated Types

type Rep Metricality :: * -> *

Methods

from :: Metricality -> Rep Metricality x

to :: Rep Metricality x -> Metricality

NFData Metricality

Methods

rnf :: Metricality -> ()

type Rep Metricality

type Rep Metricality = D1 * (MetaData "Metricality" "Numeric.Units.Dimensional.Variants" "dimensional-1.1-FrwO52z7cgM7jRCbk3nsMF" False) ((:+:) * (C1 * (MetaCons "Metric" PrefixI False) (U1 *)) (C1 * (MetaCons "NonMetric" PrefixI False) (U1 *)))

type family (v1 :: Variant) * (v2 :: Variant) :: Variant where ... infixl 7

Forms the product of two Variants.

The product of units is a non-metric unit.

The product of quantities is a quantity.

Equations

(DUnit m1) * (DUnit m2) = DUnit NonMetric

(DQuantity s1) * (DQuantity s2) = DQuantity (s1 * s2)

type family (v1 :: Variant) / (v2 :: Variant) :: Variant where ...

Equations

(DUnit m1) / (DUnit m2) = DUnit NonMetric

(DQuantity s1) / (DQuantity s2) = DQuantity (s1 / s2)

type family Weaken (v :: Variant) :: Variant where ...

Weakens a Variant by forgetting possibly uninteresting type-level information.

Equations

Weaken (DQuantity s) = DQuantity s

Weaken (DUnit m) = DUnit NonMetric

type CompatibleVariants v1 v2 = True ~ AreCompatible v1 v2

Two Variants are compatible when dimensional values of the first may be converted into the second merely by changing the representation of their values.