Numeric.Units.Dimensional.UnitNames

This module provides types and functions for manipulating unit names.

Please note that the details of the name representation may be less stable than the other APIs provided by this package, as new features using them are still being developed.

Data Types

data UnitName m

The name of a unit.

Instances

Eq (UnitName m)

Show (UnitName m)

HasInterchangeName (UnitName m)

data NameAtom m

Represents the name of an atomic unit or prefix.

Instances

Eq (NameAtom m)

Typeable NameAtomType m => Data (NameAtom m)

Ord (NameAtom m)

Generic (NameAtom m)

HasInterchangeName (NameAtom m)

type Rep (NameAtom m)

type PrefixName = NameAtom PrefixAtom

The name of a metric prefix.

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

Construction of Unit Names

atom

Arguments

:: String

Interchange name

-> String

Abbreviated name in international English

-> String

Full name in international English

-> UnitName NonMetric

Constructs an atomic name for a custom unit.

applyPrefix :: PrefixName -> UnitName Metric -> UnitName NonMetric

Forms a UnitName from a Metric name by applying a metric prefix.

(*) :: UnitName m1 -> UnitName m2 -> UnitName NonMetric infixl 7

Form a UnitName by taking the product of two others.

(/) :: UnitName m1 -> UnitName m2 -> UnitName NonMetric infixl 7

Form a UnitName by dividing one by another.

(^) :: UnitName m -> Int -> UnitName NonMetric infixr 8

Form a UnitName by raising a name to an integer power.

product :: Foldable f => f (UnitName NonMetric) -> UnitName NonMetric

Forms the product of a list of UnitNames.

If you wish to form a heterogenous product of Metric and NonMetric units you should apply weaken to the Metric ones.

reduce :: UnitName m -> UnitName m

grouped :: UnitName m -> UnitName NonMetric

Constructs a UnitName by applying a grouping operation to another UnitName, which may be useful to express precedence.

Standard Names

baseUnitName :: Dimension' -> UnitName NonMetric

The name of the base unit associated with a specified dimension.

Names for the Base Units

nOne :: UnitName NonMetric

nMeter :: UnitName Metric

nGram :: UnitName Metric

nKilogram :: UnitName NonMetric

nSecond :: UnitName Metric

nAmpere :: UnitName Metric

nKelvin :: UnitName Metric

nMole :: UnitName Metric

nCandela :: UnitName Metric

Names for the SI Metric Prefixes

deka :: PrefixName

hecto :: PrefixName

kilo :: PrefixName

mega :: PrefixName

giga :: PrefixName

tera :: PrefixName

peta :: PrefixName

exa :: PrefixName

zetta :: PrefixName

yotta :: PrefixName

deci :: PrefixName

centi :: PrefixName

milli :: PrefixName

micro :: PrefixName

nano :: PrefixName

pico :: PrefixName

femto :: PrefixName

atto :: PrefixName

zepto :: PrefixName

yocto :: PrefixName

Convenience Type Synonyms for Unit Name Transformations

type UnitNameTransformer = forall m. UnitName m -> UnitName NonMetric

The type of a unit name transformation that may be associated with an operation that takes a single unit as input.

type UnitNameTransformer2 = forall m1 m2. UnitName m1 -> UnitName m2 -> UnitName NonMetric

The type of a unit name transformation that may be associated with an operation that takes two units as input.

Forgetting Unwanted Phantom Types

weaken :: UnitName m -> UnitName NonMetric

Convert a UnitName which may or may not be Metric to one which is certainly NonMetric.

strengthen :: UnitName m -> Maybe (UnitName Metric)

Attempt to convert a UnitName which may or may not be Metric to one which is certainly Metric.

relax :: forall m1 m2. (Typeable m1, Typeable m2) => UnitName m1 -> Maybe (UnitName m2)

Convert a UnitName of one Metricality into a name of the other metricality by strengthening or weakening if neccessary. Because it may not be possible to strengthen, the result is returned in a Maybe wrapper.