Moduledimensional-1.6.2Haskell2010

Numeric.Units.Dimensional.Dimensions.TermLevel

This module defines physical dimensions expressed in terms of the SI base dimensions, including arithmetic.

Cpp
BangPatterns
DeriveDataTypeable
DeriveGeneric
DefaultSignatures

Contents

Type
Access to Dimension of Dimensional Values
Dimension Arithmetic
Synonyms for Base Dimensions
Deconstruction
Examining Dynamic Dimensions

Synopsis

data Dimension'
class HasDimension
class HasDynamicDimension
data DynamicDimension
value *
value /
value ^
value recip
value nroot
value sqrt
value cbrt
value dOne
value dLength
value dMass
value dTime
value dElectricCurrent
value dThermodynamicTemperature
value dAmountOfSubstance
value dLuminousIntensity
value asList
value matchDimensions
value isCompatibleWith
value hasSomeDimension

Packagedimensional-1.6.2
Exports23
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTermLevel.hs

Type

datadata Dimension'

Source#

A physical dimension, encoded as 7 integers, representing a factorization of the dimension into the 7 SI base dimensions. By convention they are stored in the same order as in the Dimension data kind.

Constructors

Dim' !Int !Int !Int !Int !Int !Int !Int

Instances11Eq, Data, Ord, Show, Generic, Semigroup, …

Eq Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Data Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Ord Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Show Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Generic Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Semigroup Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Monoid Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
The monoid of dimensions under multiplication.
NFData Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
HasDimension Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
HasDynamicDimension Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
type Rep Dimension' = D1 ('MetaData "Dimension'" "Numeric.Units.Dimensional.Dimensions.TermLevel" "dimensional-1.6.2-6bFHms4cKH82WlYjTKWbCv" 'False) (C1 ('MetaCons "Dim'" 'PrefixI 'False) ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int))) :*: ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)))))Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel

Access to Dimension of Dimensional Values

classclass HasDynamicDimension a => HasDimension a where

Source#

Dimensional values inhabit this class, which allows access to a term-level representation of their dimension.

Methods

dimension :: a -> Dimension'
Obtains a term-level representation of a value's dimension.

Instances5HasDimension

HasDimension Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
HasDimension AnyUnitDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dynamic
HasDimension (AnyQuantity a)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dynamic
(KnownTypeInt l, KnownTypeInt m, KnownTypeInt t, KnownTypeInt i, KnownTypeInt th, KnownTypeInt n, KnownTypeInt j) => HasDimension (Proxy ('Dim l m t i th n j))Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TypeLevel
KnownDimension d => HasDimension (Dimensional v d a)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Internal

classclass HasDynamicDimension a where

Source#

Dimensional values, or those that are only possibly dimensional, inhabit this class, which allows access to a term-level representation of their dimension.

Methods

dynamicDimension :: a -> DynamicDimension
Gets the DynamicDimension of a dynamic dimensional value, which may be NoDimension if it does not represent a dimensional value of any Dimension.
A default implementation is available for types that are also in the HasDimension typeclass.

Instances7HasDynamicDimension, …

HasDynamicDimension Dimension'Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
HasDynamicDimension DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
HasDynamicDimension AnyUnitDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dynamic
HasDynamicDimension (AnyQuantity a)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dynamic
HasDynamicDimension (DynQuantity a)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dynamic
(KnownTypeInt l, KnownTypeInt m, KnownTypeInt t, KnownTypeInt i, KnownTypeInt th, KnownTypeInt n, KnownTypeInt j) => HasDynamicDimension (Proxy ('Dim l m t i th n j))Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TypeLevel
KnownDimension d => HasDynamicDimension (Dimensional v d a)Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Internal

datadata DynamicDimension

Source#

The dimension of a dynamic value, which may not have any dimension at all.

Constructors

NoDimension
The value has no valid dimension.
SomeDimension Dimension'
The value has the given dimension.
AnyDimension
The value may be interpreted as having any dimension.

Instances8Eq, Data, Ord, Show, Generic, NFData, …

Eq DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Data DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Ord DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Show DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
Generic DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
NFData DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
HasDynamicDimension DynamicDimensionDefined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel
type Rep DynamicDimension = D1 ('MetaData "DynamicDimension" "Numeric.Units.Dimensional.Dimensions.TermLevel" "dimensional-1.6.2-6bFHms4cKH82WlYjTKWbCv" 'False) (C1 ('MetaCons "NoDimension" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "SomeDimension" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Dimension')) :+: C1 ('MetaCons "AnyDimension" 'PrefixI 'False) U1))Defined in dimensional-1.6.2 · Numeric.Units.Dimensional.Dimensions.TermLevel

Dimension Arithmetic

value(*) :: Dimension' -> Dimension' -> Dimension'

Source#

Forms the product of two dimensions.

value(/) :: Dimension' -> Dimension' -> Dimension'

Source#

Forms the quotient of two dimensions.

value(^) :: Dimension' -> Int -> Dimension'

Source#

Raises a dimension to an integer power.

valuerecip :: Dimension' -> Dimension'

Source#

Forms the reciprocal of a dimension.

valuenroot :: Int -> Dimension' -> Maybe Dimension'

Source#

Takes the nth root of a dimension, if it exists.

n must not be zero.

Property

prop> nroot (negate n) d == nroot n (recip d)

valuesqrt :: Dimension' -> Maybe Dimension'

Source#

Takes the square root of a dimension, if it exists.

Property

prop> sqrt d == nroot 2 d

valuecbrt :: Dimension' -> Maybe Dimension'

Source#

Takes the cube root of a dimension, if it exists.

Property

prop> cbrt d == nroot 3 d

Synonyms for Base Dimensions

valuedOne :: Dimension'

Source#

The dimension of dimensionless values.

valuedLength :: Dimension'

valuedMass :: Dimension'

valuedTime :: Dimension'

valuedElectricCurrent :: Dimension'

valuedThermodynamicTemperature :: Dimension'

valuedAmountOfSubstance :: Dimension'

valuedLuminousIntensity :: Dimension'

Deconstruction

valueasList :: Dimension' -> [Int]

Source#

Converts a dimension to a list of 7 integers, representing the exponent associated with each of the 7 SI base dimensions in the standard order.

Examining Dynamic Dimensions

valuematchDimensions :: DynamicDimension -> DynamicDimension -> DynamicDimension

Source#

Combines two DynamicDimensions, determining the DynamicDimension of a quantity that must match both inputs.

This is the lattice meet operation for DynamicDimension.

valueisCompatibleWith :: HasDynamicDimension a => a -> Dimension' -> Bool

Source#

Determines if a value that has a DynamicDimension is compatible with a specified Dimension'.

valuehasSomeDimension :: HasDynamicDimension a => a -> Bool

Source#

Determines if a value that has a DynamicDimension in fact has any valid dimension at all.