Moduledimensional-1.5Haskell2010

Numeric.Units.Dimensional.Variants

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

3 types
MonoLocalBinds
TypeFamilies
ConstraintKinds
DataKinds
DeriveDataTypeable
DeriveGeneric
KindSignatures
TypeOperators
ExplicitNamespaces

Packagedimensional-1.5
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceVariants.hs

datadata 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.

Instances2Generic, Rep

Generic VariantDefined in dimensional-1.5 · Numeric.Units.Dimensional.Variants
type Rep Variant = D1 ('MetaData "Variant" "Numeric.Units.Dimensional.Variants" "dimensional-1.5-A8hQbr1FhplHXjkk6TSAmE" 'False) (C1 ('MetaCons "DQuantity" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExactPi')) :+: C1 ('MetaCons "DUnit" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Metricality)))Defined in dimensional-1.5 · Numeric.Units.Dimensional.Variants

datadata 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.

Instances6Eq, Data, Ord, Generic, NFData, Rep

Eq MetricalityDefined in dimensional-1.5 · Numeric.Units.Dimensional.Variants
Data MetricalityDefined in dimensional-1.5 · Numeric.Units.Dimensional.Variants
Ord MetricalityDefined in dimensional-1.5 · Numeric.Units.Dimensional.Variants
Generic MetricalityDefined in dimensional-1.5 · Numeric.Units.Dimensional.Variants
NFData MetricalityDefined in dimensional-1.5 · Numeric.Units.Dimensional.Variants
type Rep Metricality = D1 ('MetaData "Metricality" "Numeric.Units.Dimensional.Variants" "dimensional-1.5-A8hQbr1FhplHXjkk6TSAmE" 'False) (C1 ('MetaCons "Metric" 'PrefixI 'False) U1 :+: C1 ('MetaCons "NonMetric" 'PrefixI 'False) U1)Defined in dimensional-1.5 · Numeric.Units.Dimensional.Variants

familytype family (*) (v1 :: Variant) (v2 :: Variant) :: Variant where

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)

familytype family (/) (v1 :: Variant) (v2 :: Variant) :: Variant where

Forms the quotient of two Variants.

The quotient of units is a non-metric unit.

The quotient of quantities is a quantity.

Equations

(/) ('DUnit m1) ('DUnit m2) = 'DUnit 'NonMetric
(/) ('DQuantity s1) ('DQuantity s2) = 'DQuantity (s1 / s2)

familytype 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

typetype CompatibleVariants (v1 :: Variant) (v2 :: Variant) = '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.