Numeric.Units.Dimensional.Dimensions

Provides both term-level and type-level representations for physical dimensions in a single import for convenience.

Presuming that users intend to work primarily with type level dimensions, this module hides arithmetic operators over term level dimensions and aliases for the base term-level dimensions to avoid namespace pollution. These features are available directly from Numeric.Units.Dimensional.Dimensions.TermLevel if desired.

Documentation

class HasDynamicDimension a => HasDimension a where

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.

Instances

HasDimension Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

dimension :: Dimension' -> Dimension'

HasDimension AnyUnit

Defined in Numeric.Units.Dimensional.Dynamic

Methods

dimension :: AnyUnit -> Dimension'

HasDimension (AnyQuantity a)

Defined in Numeric.Units.Dimensional.Dynamic

Methods

dimension :: AnyQuantity a -> Dimension'

(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 Numeric.Units.Dimensional.Dimensions.TypeLevel

Methods

dimension :: Proxy (Dim l m t i th n j) -> Dimension'

KnownDimension d => HasDimension (Dimensional v d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

dimension :: Dimensional v d a -> Dimension'

class HasDynamicDimension a where

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

Minimal complete definition

Nothing

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.

dynamicDimension :: HasDimension a => 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.

Instances

HasDynamicDimension DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

dynamicDimension :: DynamicDimension -> DynamicDimension

HasDynamicDimension Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

dynamicDimension :: Dimension' -> DynamicDimension

HasDynamicDimension AnyUnit

Defined in Numeric.Units.Dimensional.Dynamic

Methods

dynamicDimension :: AnyUnit -> DynamicDimension

HasDynamicDimension (DynQuantity a)

Defined in Numeric.Units.Dimensional.Dynamic

Methods

dynamicDimension :: DynQuantity a -> DynamicDimension

HasDynamicDimension (AnyQuantity a)

Defined in Numeric.Units.Dimensional.Dynamic

Methods

dynamicDimension :: AnyQuantity a -> DynamicDimension

(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 Numeric.Units.Dimensional.Dimensions.TypeLevel

Methods

dynamicDimension :: Proxy (Dim l m t i th n j) -> DynamicDimension

KnownDimension d => HasDynamicDimension (Dimensional v d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

dynamicDimension :: Dimensional v d a -> DynamicDimension

data DynamicDimension

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.

Instances

Eq DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

(==) :: DynamicDimension -> DynamicDimension -> Bool

(/=) :: DynamicDimension -> DynamicDimension -> Bool

Data DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DynamicDimension -> c DynamicDimension

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DynamicDimension

toConstr :: DynamicDimension -> Constr

dataTypeOf :: DynamicDimension -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DynamicDimension)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DynamicDimension)

gmapT :: (forall b. Data b => b -> b) -> DynamicDimension -> DynamicDimension

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DynamicDimension -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DynamicDimension -> r

gmapQ :: (forall d. Data d => d -> u) -> DynamicDimension -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DynamicDimension -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DynamicDimension -> m DynamicDimension

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DynamicDimension -> m DynamicDimension

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DynamicDimension -> m DynamicDimension

Ord DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

compare :: DynamicDimension -> DynamicDimension -> Ordering

(<) :: DynamicDimension -> DynamicDimension -> Bool

(<=) :: DynamicDimension -> DynamicDimension -> Bool

(>) :: DynamicDimension -> DynamicDimension -> Bool

(>=) :: DynamicDimension -> DynamicDimension -> Bool

max :: DynamicDimension -> DynamicDimension -> DynamicDimension

min :: DynamicDimension -> DynamicDimension -> DynamicDimension

Show DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

showsPrec :: Int -> DynamicDimension -> ShowS

show :: DynamicDimension -> String

showList :: [DynamicDimension] -> ShowS

Generic DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Associated Types

type Rep DynamicDimension :: Type -> Type

Methods

from :: DynamicDimension -> Rep DynamicDimension x

to :: Rep DynamicDimension x -> DynamicDimension

NFData DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

rnf :: DynamicDimension -> ()

HasDynamicDimension DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

dynamicDimension :: DynamicDimension -> DynamicDimension

type Rep DynamicDimension

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

type Rep DynamicDimension = D1 (MetaData "DynamicDimension" "Numeric.Units.Dimensional.Dimensions.TermLevel" "dimensional-1.3-7Gh1mp5ZBGaGfkDr7lUYf2" False) (C1 (MetaCons "NoDimension" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SomeDimension" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Dimension')) :+: C1 (MetaCons "AnyDimension" PrefixI False) (U1 :: Type -> Type)))

data Dimension'

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

Instances

Eq Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

(==) :: Dimension' -> Dimension' -> Bool

(/=) :: Dimension' -> Dimension' -> Bool

Data Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Dimension' -> c Dimension'

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Dimension'

toConstr :: Dimension' -> Constr

dataTypeOf :: Dimension' -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Dimension')

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Dimension')

gmapT :: (forall b. Data b => b -> b) -> Dimension' -> Dimension'

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Dimension' -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Dimension' -> r

gmapQ :: (forall d. Data d => d -> u) -> Dimension' -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Dimension' -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Dimension' -> m Dimension'

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Dimension' -> m Dimension'

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Dimension' -> m Dimension'

Ord Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

compare :: Dimension' -> Dimension' -> Ordering

(<) :: Dimension' -> Dimension' -> Bool

(<=) :: Dimension' -> Dimension' -> Bool

(>) :: Dimension' -> Dimension' -> Bool

(>=) :: Dimension' -> Dimension' -> Bool

max :: Dimension' -> Dimension' -> Dimension'

min :: Dimension' -> Dimension' -> Dimension'

Show Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

showsPrec :: Int -> Dimension' -> ShowS

show :: Dimension' -> String

showList :: [Dimension'] -> ShowS

Generic Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Associated Types

type Rep Dimension' :: Type -> Type

Methods

from :: Dimension' -> Rep Dimension' x

to :: Rep Dimension' x -> Dimension'

Semigroup Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

(<>) :: Dimension' -> Dimension' -> Dimension'

sconcat :: NonEmpty Dimension' -> Dimension'

stimes :: Integral b => b -> Dimension' -> Dimension'

Monoid Dimension'

The monoid of dimensions under multiplication.

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

mempty :: Dimension'

mappend :: Dimension' -> Dimension' -> Dimension'

mconcat :: [Dimension'] -> Dimension'

NFData Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

rnf :: Dimension' -> ()

HasDimension Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

dimension :: Dimension' -> Dimension'

HasDynamicDimension Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

Methods

dynamicDimension :: Dimension' -> DynamicDimension

type Rep Dimension'

Defined in Numeric.Units.Dimensional.Dimensions.TermLevel

type Rep Dimension' = D1 (MetaData "Dimension'" "Numeric.Units.Dimensional.Dimensions.TermLevel" "dimensional-1.3-7Gh1mp5ZBGaGfkDr7lUYf2" False) (C1 (MetaCons "Dim'" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))) :*: ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

matchDimensions :: DynamicDimension -> DynamicDimension -> DynamicDimension

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

This is the lattice meet operation for DynamicDimension.

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

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

hasSomeDimension :: HasDynamicDimension a => a -> Bool

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

dOne :: Dimension'

The dimension of dimensionless values.

asList :: Dimension' -> [Int]

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.

module Numeric.Units.Dimensional.Dimensions.TypeLevel