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

The value is a quantity.

DUnit Metricality

The value is a unit, possibly a Metric unit.

Instances

Eq Variant

Data Variant

Ord Variant

Generic Variant

type Rep Variant

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

Data Metricality

Ord Metricality

Generic Metricality

type Rep Metricality

type family v1 * v2 :: Variant 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 * DQuantity = DQuantity

type family Weaken v :: Variant

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

Equations

Weaken DQuantity = DQuantity

Weaken (DUnit m) = DUnit NonMetric