Moduledimensional-1.6.2Haskell2010

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.

Contents

Data Types
Construction of Unit Names
Standard Names
Inspecting Prefixes
Convenience Type Synonyms for Unit Name Transformations
Forgetting Unwanted Phantom Types

Synopsis

data UnitName
data NameAtom
data Prefix
type PrefixName
data Metricality
value atom
value applyPrefix
value *
value /
value ^
value product
value reduce
value grouped
value baseUnitName
value siPrefixes
value nOne
value prefixName
value scaleFactor
type UnitNameTransformer
type UnitNameTransformer2
value weaken
value strengthen
value relax
value name_en
value abbreviation_en
value asAtomic

Packagedimensional-1.6.2
Exports26
LanguageHaskell2010
LicenceBSD-3-Clause
SourceUnitNames.hs

Data Types

datadata UnitName (m :: Metricality) where

Source#

The name of a unit.

Instances4Eq, Show, NFData, HasInterchangeName

Eq (UnitName m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
Show (UnitName m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
UnitNames are shown with non-breaking spaces.
NFData (UnitName m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
HasInterchangeName (UnitName m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal

datadata NameAtom (m :: NameAtomType)

Source#

Represents the name of an atomic unit or prefix.

Instances7Eq, Data, Ord, Generic, NFData, HasInterchangeName, …

Eq (NameAtom m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
Typeable m => Data (NameAtom m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
Ord (NameAtom m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
Generic (NameAtom m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
NFData (NameAtom m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
HasInterchangeName (NameAtom m)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
type Rep (NameAtom m) = D1 ('MetaData "NameAtom" "Numeric.Units.Dimensional.UnitNames.Internal" "dimensional-1.6.2-6bFHms4cKH82WlYjTKWbCv" 'False) (C1 ('MetaCons "NameAtom" 'PrefixI 'True) (S1 ('MetaSel ('Just "_interchangeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InterchangeName) :*: (S1 ('MetaSel ('Just "abbreviation_en") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "name_en") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal

datadata Prefix

Source#

A metric prefix.

Instances7Eq, Data, Ord, Generic, NFData, HasInterchangeName, …

Eq PrefixDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
Data PrefixDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
Ord PrefixDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
Generic PrefixDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
NFData PrefixDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
HasInterchangeName PrefixDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal
type Rep Prefix = D1 ('MetaData "Prefix" "Numeric.Units.Dimensional.UnitNames.Internal" "dimensional-1.6.2-6bFHms4cKH82WlYjTKWbCv" 'False) (C1 ('MetaCons "Prefix" 'PrefixI 'True) (S1 ('MetaSel ('Just "prefixName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PrefixName) :*: S1 ('MetaSel ('Just "scaleFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational)))Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.UnitNames.Internal

typetype PrefixName = NameAtom 'PrefixAtom

Source#

The name of a metric prefix.

datadata Metricality

Source#

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.6.2 · Numeric.Units.Dimensional.Variants
Data MetricalityDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Variants
Ord MetricalityDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Variants
Generic MetricalityDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Variants
NFData MetricalityDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Variants
type Rep Metricality = D1 ('MetaData "Metricality" "Numeric.Units.Dimensional.Variants" "dimensional-1.6.2-6bFHms4cKH82WlYjTKWbCv" 'False) (C1 ('MetaCons "Metric" 'PrefixI 'False) U1 :+: C1 ('MetaCons "NonMetric" 'PrefixI 'False) U1)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Variants

Construction of Unit Names

valueatom

:: String
Interchange name
-> String
Abbreviated name in international English
-> String
Full name in international English
-> UnitName 'NonMetric

Source#

Constructs an atomic name for a custom unit.

valueapplyPrefix :: Prefix -> UnitName 'Metric -> UnitName 'NonMetric

Source#

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

value(*) :: UnitName m1 -> UnitName m2 -> UnitName 'NonMetric

Source#

Form a UnitName by taking the product of two others.

value(/) :: UnitName m1 -> UnitName m2 -> UnitName 'NonMetric

Source#

Form a UnitName by dividing one by another.

value(^) :: UnitName m -> Int -> UnitName 'NonMetric

Source#

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

valueproduct :: Foldable f => f (UnitName 'NonMetric) -> UnitName 'NonMetric

Source#

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.

valuereduce :: UnitName m -> UnitName m

Source#

Reduce a UnitName by algebraic simplifications.

valuegrouped :: UnitName m -> UnitName 'NonMetric

Source#

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

Standard Names

valuebaseUnitName :: Dimension' -> UnitName 'NonMetric

Source#

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

valuesiPrefixes :: [Prefix]

Source#

A list of all Prefixes defined by the SI.

valuenOne :: UnitName 'NonMetric

Source#

The name of the unit of dimensionless values.

Inspecting Prefixes

valueprefixName :: Prefix -> PrefixName

Source#

The name of a metric prefix.

valuescaleFactor :: Prefix -> Rational

Source#

The scale factor denoted by a metric prefix.

Convenience Type Synonyms for Unit Name Transformations

typetype UnitNameTransformer = forall (m :: Metricality). UnitName m -> UnitName 'NonMetric

Source#

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

type

type UnitNameTransformer2 = forall (m1 :: Metricality) (m2 :: Metricality). UnitName m1 -> UnitName m2 -> UnitName 'NonMetric

Source#

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

Forgetting Unwanted Phantom Types

valueweaken :: UnitName m -> UnitName 'NonMetric

Source#

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

valuestrengthen :: UnitName m -> Maybe (UnitName 'Metric)

Source#

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

valuerelax :: (Typeable m1, Typeable m2) => UnitName m1 -> Maybe (UnitName m2)

Source#

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

valuename_en :: NameAtom m -> String

Source#

The full name of the unit in international English.

valueabbreviation_en :: NameAtom m -> String

Source#

The abbreviated name of the unit in international English.

valueasAtomic :: UnitName m -> Maybe (NameAtom ('UnitAtom m))

Source#

Converts a UnitName to a NameAtom, if possible.