Copyright	Copyright (C) 2006-2018 Bjorn Buckwalter
License	BSD3
Maintainer	bjorn@buckwalter.se
Stability	Stable
Portability	GHC only
Safe Haskell	Safe
Language	Haskell2010
Extensions	BangPatterns DeriveDataTypeable DeriveGeneric DefaultSignatures

Numeric.Units.Dimensional.Dimensions.TermLevel

Contents

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

Description

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

Synopsis

Type

data 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

Instances

Eq Dimension' Source #
Methods (==) :: Dimension' -> Dimension' -> Bool # (/=) :: Dimension' -> Dimension' -> Bool #
Data Dimension' Source #
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' Source #
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' Source #
Methods showsPrec :: Int -> Dimension' -> ShowS # show :: Dimension' -> String # showList :: [Dimension'] -> ShowS #
Generic Dimension' Source #
Associated Types type Rep Dimension' :: * -> * # Methods from :: Dimension' -> Rep Dimension' x # to :: Rep Dimension' x -> Dimension' #
Semigroup Dimension' Source #
Methods (<>) :: Dimension' -> Dimension' -> Dimension' # sconcat :: NonEmpty Dimension' -> Dimension' # stimes :: Integral b => b -> Dimension' -> Dimension' #
Monoid Dimension' Source #	The monoid of dimensions under multiplication.
Methods mempty :: Dimension' # mappend :: Dimension' -> Dimension' -> Dimension' # mconcat :: [Dimension'] -> Dimension' #
NFData Dimension' Source #
Methods rnf :: Dimension' -> () #
HasDimension Dimension' Source #
Methods dimension :: Dimension' -> Dimension' Source #
HasDynamicDimension Dimension' Source #
Methods dynamicDimension :: Dimension' -> DynamicDimension Source #
type Rep Dimension' Source #
type Rep Dimension' = D1 * (MetaData "Dimension'" "Numeric.Units.Dimensional.Dimensions.TermLevel" "dimensional-1.1-FrwO52z7cgM7jRCbk3nsMF" False) (C1 * (MetaCons "Dim'" PrefixI False) ((::) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))) ((::) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Access to Dimension of Dimensional Values

class HasDynamicDimension a => HasDimension a where Source #

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

Minimal complete definition

dimension

Methods

dimension :: a -> Dimension' Source #

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

Instances

HasDimension Dimension' Source #
Methods dimension :: Dimension' -> Dimension' Source #
HasDimension AnyUnit Source #
Methods dimension :: AnyUnit -> Dimension' Source #
HasDimension (AnyQuantity a) Source #
Methods dimension :: AnyQuantity a -> Dimension' Source #
(KnownTypeInt l, KnownTypeInt m, KnownTypeInt t, KnownTypeInt i, KnownTypeInt th, KnownTypeInt n, KnownTypeInt j) => HasDimension (Proxy Dimension (Dim l m t i th n j)) Source #
Methods dimension :: Proxy Dimension (Dim l m t i th n j) -> Dimension' Source #
KnownDimension d => HasDimension (Dimensional v d a) Source #
Methods dimension :: Dimensional v d a -> Dimension' Source #

class 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 Source #

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 Source #

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 Source #
Methods dynamicDimension :: DynamicDimension -> DynamicDimension Source #
HasDynamicDimension Dimension' Source #
Methods dynamicDimension :: Dimension' -> DynamicDimension Source #
HasDynamicDimension AnyUnit Source #
Methods dynamicDimension :: AnyUnit -> DynamicDimension Source #
HasDynamicDimension (DynQuantity a) Source #
Methods dynamicDimension :: DynQuantity a -> DynamicDimension Source #
HasDynamicDimension (AnyQuantity a) Source #
Methods dynamicDimension :: AnyQuantity a -> DynamicDimension Source #
(KnownTypeInt l, KnownTypeInt m, KnownTypeInt t, KnownTypeInt i, KnownTypeInt th, KnownTypeInt n, KnownTypeInt j) => HasDynamicDimension (Proxy Dimension (Dim l m t i th n j)) Source #
Methods dynamicDimension :: Proxy Dimension (Dim l m t i th n j) -> DynamicDimension Source #
KnownDimension d => HasDynamicDimension (Dimensional v d a) Source #
Methods dynamicDimension :: Dimensional v d a -> DynamicDimension Source #

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

Instances

Eq DynamicDimension Source #
Methods (==) :: DynamicDimension -> DynamicDimension -> Bool # (/=) :: DynamicDimension -> DynamicDimension -> Bool #
Data DynamicDimension Source #
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 Source #
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 Source #
Methods showsPrec :: Int -> DynamicDimension -> ShowS # show :: DynamicDimension -> String # showList :: [DynamicDimension] -> ShowS #
Generic DynamicDimension Source #
Associated Types type Rep DynamicDimension :: * -> * # Methods from :: DynamicDimension -> Rep DynamicDimension x # to :: Rep DynamicDimension x -> DynamicDimension #
NFData DynamicDimension Source #
Methods rnf :: DynamicDimension -> () #
HasDynamicDimension DynamicDimension Source #
Methods dynamicDimension :: DynamicDimension -> DynamicDimension Source #
type Rep DynamicDimension Source #
type Rep DynamicDimension = D1 * (MetaData "DynamicDimension" "Numeric.Units.Dimensional.Dimensions.TermLevel" "dimensional-1.1-FrwO52z7cgM7jRCbk3nsMF" False) ((:+:) * (C1 * (MetaCons "NoDimension" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "SomeDimension" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Dimension'))) (C1 * (MetaCons "AnyDimension" PrefixI False) (U1 *))))