Numeric.Units.Dimensional.Coercion

Re-exports the raw Quantity constructor from the Numeric.Units.Dimensional.Internal module, along with coerce, for convenience in converting between raw representations and dimensional values.

Note that use of these constructs requires the user to verify the dimensional safety of the conversion, because the coercion doesn't explicitly mention the unit of the representation. Note also that the Quantity constructor constructs a SQuantity which may have a scale factor other than One.

Note that the haddock documentation doesn't mention the Quantity constructor because it is a part of the Dimensional associated data family, but it is exported by this module.

Documentation

coerce :: forall {k :: RuntimeRep} (a :: TYPE k) (b :: TYPE k). Coercible a b => a -> b

The function coerce allows you to safely convert between values of types that have the same representation with no run-time overhead. In the simplest case you can use it instead of a newtype constructor, to go from the newtype's concrete type to the abstract type. But it also works in more complicated settings, e.g. converting a list of newtypes to a list of concrete types.

This function is representation-polymorphic, but the RuntimeRep type argument is marked as Inferred, meaning that it is not available for visible type application. This means the typechecker will accept coerce Int Age 42.

data family Dimensional v :: Dimension -> Type -> Type

A dimensional value, either a Quantity or a Unit, parameterized by its Dimension and representation.

Instances

Generic1 (Dimensional ('DQuantity s) d :: Type -> Type)

Defined in Numeric.Units.Dimensional.Internal

Associated Types

type Rep1 (Dimensional ('DQuantity s) d) :: k -> Type

Methods

from1 :: forall (a :: k). Dimensional ('DQuantity s) d a -> Rep1 (Dimensional ('DQuantity s) d) a

to1 :: forall (a :: k). Rep1 (Dimensional ('DQuantity s) d) a -> Dimensional ('DQuantity s) d a

Generic1 (Dimensional ('DUnit m) d :: Type -> Type)

Defined in Numeric.Units.Dimensional.Internal

Associated Types

type Rep1 (Dimensional ('DUnit m) d) :: k -> Type

Methods

from1 :: forall (a :: k). Dimensional ('DUnit m) d a -> Rep1 (Dimensional ('DUnit m) d) a

to1 :: forall (a :: k). Rep1 (Dimensional ('DUnit m) d) a -> Dimensional ('DUnit m) d a

Vector Vector a => Vector Vector (SQuantity s d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

basicUnsafeFreeze :: Mutable Vector s0 (SQuantity s d a) -> ST s0 (Vector (SQuantity s d a))

basicUnsafeThaw :: Vector (SQuantity s d a) -> ST s0 (Mutable Vector s0 (SQuantity s d a))

basicLength :: Vector (SQuantity s d a) -> Int

basicUnsafeSlice :: Int -> Int -> Vector (SQuantity s d a) -> Vector (SQuantity s d a)

basicUnsafeIndexM :: Vector (SQuantity s d a) -> Int -> Box (SQuantity s d a)

basicUnsafeCopy :: Mutable Vector s0 (SQuantity s d a) -> Vector (SQuantity s d a) -> ST s0 ()

elemseq :: Vector (SQuantity s d a) -> SQuantity s d a -> b -> b

MVector MVector a => MVector MVector (SQuantity s d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

basicLength :: MVector s0 (SQuantity s d a) -> Int

basicUnsafeSlice :: Int -> Int -> MVector s0 (SQuantity s d a) -> MVector s0 (SQuantity s d a)

basicOverlaps :: MVector s0 (SQuantity s d a) -> MVector s0 (SQuantity s d a) -> Bool

basicUnsafeNew :: Int -> ST s0 (MVector s0 (SQuantity s d a))

basicInitialize :: MVector s0 (SQuantity s d a) -> ST s0 ()

basicUnsafeReplicate :: Int -> SQuantity s d a -> ST s0 (MVector s0 (SQuantity s d a))

basicUnsafeRead :: MVector s0 (SQuantity s d a) -> Int -> ST s0 (SQuantity s d a)

basicUnsafeWrite :: MVector s0 (SQuantity s d a) -> Int -> SQuantity s d a -> ST s0 ()

basicClear :: MVector s0 (SQuantity s d a) -> ST s0 ()

basicSet :: MVector s0 (SQuantity s d a) -> SQuantity s d a -> ST s0 ()

basicUnsafeCopy :: MVector s0 (SQuantity s d a) -> MVector s0 (SQuantity s d a) -> ST s0 ()

basicUnsafeMove :: MVector s0 (SQuantity s d a) -> MVector s0 (SQuantity s d a) -> ST s0 ()

basicUnsafeGrow :: MVector s0 (SQuantity s d a) -> Int -> ST s0 (MVector s0 (SQuantity s d a))

KnownDimension d => Demotable (Quantity d)

Defined in Numeric.Units.Dimensional.Dynamic

Methods

demotableOut :: Quantity d a -> AnyQuantity a

Eq1 (SQuantity s d)

Defined in Numeric.Units.Dimensional.Internal

Methods

liftEq :: (a -> b -> Bool) -> SQuantity s d a -> SQuantity s d b -> Bool

Ord1 (SQuantity s d)

Defined in Numeric.Units.Dimensional.Internal

Methods

liftCompare :: (a -> b -> Ordering) -> SQuantity s d a -> SQuantity s d b -> Ordering

KnownVariant v => Functor (Dimensional v d)

A Functor instance for Dimensional.

Note that this instance is dubious, because it allows you to break the dimensional abstraction. See dmap for more information.

Note that, while this instance overlaps with that given for Dimensionless, it is confluent with that instance.

Note that this is an orphan instance.

Defined in Numeric.Units.Dimensional.Functor

Methods

fmap :: (a -> b) -> Dimensional v d a -> Dimensional v d b

(<$) :: a -> Dimensional v d b -> Dimensional v d a

Functor (SQuantity s DOne)

Defined in Numeric.Units.Dimensional.Internal

Methods

fmap :: (a -> b) -> SQuantity s DOne a -> SQuantity s DOne b

(<$) :: a -> SQuantity s DOne b -> SQuantity s DOne a

NFData a => NFData (Quantity d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

rnf :: Quantity d a -> ()

(Typeable s, Typeable d, Data a) => Data (Dimensional ('DQuantity s) d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

gfoldl :: (forall d0 b. Data d0 => c (d0 -> b) -> d0 -> c b) -> (forall g. g -> c g) -> Dimensional ('DQuantity s) d a -> c (Dimensional ('DQuantity s) d a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Dimensional ('DQuantity s) d a)

toConstr :: Dimensional ('DQuantity s) d a -> Constr

dataTypeOf :: Dimensional ('DQuantity s) d a -> DataType

dataCast1 :: Typeable t => (forall d0. Data d0 => c (t d0)) -> Maybe (c (Dimensional ('DQuantity s) d a))

dataCast2 :: Typeable t => (forall d0 e. (Data d0, Data e) => c (t d0 e)) -> Maybe (c (Dimensional ('DQuantity s) d a))

gmapT :: (forall b. Data b => b -> b) -> Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a

gmapQl :: (r -> r' -> r) -> r -> (forall d0. Data d0 => d0 -> r') -> Dimensional ('DQuantity s) d a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d0. Data d0 => d0 -> r') -> Dimensional ('DQuantity s) d a -> r

gmapQ :: (forall d0. Data d0 => d0 -> u) -> Dimensional ('DQuantity s) d a -> [u]

gmapQi :: Int -> (forall d0. Data d0 => d0 -> u) -> Dimensional ('DQuantity s) d a -> u

gmapM :: Monad m => (forall d0. Data d0 => d0 -> m d0) -> Dimensional ('DQuantity s) d a -> m (Dimensional ('DQuantity s) d a)

gmapMp :: MonadPlus m => (forall d0. Data d0 => d0 -> m d0) -> Dimensional ('DQuantity s) d a -> m (Dimensional ('DQuantity s) d a)

gmapMo :: MonadPlus m => (forall d0. Data d0 => d0 -> m d0) -> Dimensional ('DQuantity s) d a -> m (Dimensional ('DQuantity s) d a)

Storable a => Storable (SQuantity s d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

sizeOf :: SQuantity s d a -> Int

alignment :: SQuantity s d a -> Int

peekElemOff :: Ptr (SQuantity s d a) -> Int -> IO (SQuantity s d a)

pokeElemOff :: Ptr (SQuantity s d a) -> Int -> SQuantity s d a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (SQuantity s d a)

pokeByteOff :: Ptr b -> Int -> SQuantity s d a -> IO ()

peek :: Ptr (SQuantity s d a) -> IO (SQuantity s d a)

poke :: Ptr (SQuantity s d a) -> SQuantity s d a -> IO ()

Num a => Monoid (SQuantity s d a)

Quantitys of a given Dimension form a Monoid under addition.

Defined in Numeric.Units.Dimensional.Internal

Methods

mempty :: SQuantity s d a

mappend :: SQuantity s d a -> SQuantity s d a -> SQuantity s d a

mconcat :: [SQuantity s d a] -> SQuantity s d a

Num a => Semigroup (SQuantity s d a)

Quantitys of a given Dimension form a Semigroup under addition.

Defined in Numeric.Units.Dimensional.Internal

Methods

(<>) :: SQuantity s d a -> SQuantity s d a -> SQuantity s d a

sconcat :: NonEmpty (SQuantity s d a) -> SQuantity s d a

stimes :: Integral b => b -> SQuantity s d a -> SQuantity s d a

Bounded a => Bounded (SQuantity s d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

minBound :: SQuantity s d a

maxBound :: SQuantity s d a

Generic (Dimensional ('DQuantity s) d a)

Defined in Numeric.Units.Dimensional.Internal

Associated Types

type Rep (Dimensional ('DQuantity s) d a) :: Type -> Type

Methods

from :: Dimensional ('DQuantity s) d a -> Rep (Dimensional ('DQuantity s) d a) x

to :: Rep (Dimensional ('DQuantity s) d a) x -> Dimensional ('DQuantity s) d a

Generic (Dimensional ('DUnit m) d a)

Defined in Numeric.Units.Dimensional.Internal

Associated Types

type Rep (Dimensional ('DUnit m) d a) :: Type -> Type

Methods

from :: Dimensional ('DUnit m) d a -> Rep (Dimensional ('DUnit m) d a) x

to :: Rep (Dimensional ('DUnit m) d a) x -> Dimensional ('DUnit m) d a

(KnownDimension d, KnownExactPi s, Show a, Real a) => Show (SQuantity s d a)

Uses non-breaking spaces between the value and the unit, and within the unit name.

Defined in Numeric.Units.Dimensional.Internal

Methods

showsPrec :: Int -> SQuantity s d a -> ShowS

show :: SQuantity s d a -> String

showList :: [SQuantity s d a] -> ShowS

Show a => Show (Unit m d a)

Unit names are shown with non-breaking spaces.

Defined in Numeric.Units.Dimensional.Internal

Methods

showsPrec :: Int -> Unit m d a -> ShowS

show :: Unit m d a -> String

showList :: [Unit m d a] -> ShowS

KnownDimension d => HasDimension (Dimensional v d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

dimension :: Dimensional v d a -> Dimension'

KnownDimension d => HasDynamicDimension (Dimensional v d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

dynamicDimension :: Dimensional v d a -> DynamicDimension

HasInterchangeName (Unit m d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

interchangeName :: Unit m d a -> InterchangeName

Eq a => Eq (Dimensional ('DQuantity s) d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

(==) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

(/=) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

Ord a => Ord (Dimensional ('DQuantity s) d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

compare :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Ordering

(<) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

(<=) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

(>) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

(>=) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

max :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a

min :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a

AEq a => AEq (Dimensional ('DQuantity s) d a)

Defined in Numeric.Units.Dimensional.Internal

Methods

(===) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

(~==) :: Dimensional ('DQuantity s) d a -> Dimensional ('DQuantity s) d a -> Bool

Unbox a => Unbox (SQuantity s d a)

Defined in Numeric.Units.Dimensional.Internal

type Rep1 (Dimensional ('DQuantity s) d :: Type -> Type)

Defined in Numeric.Units.Dimensional.Internal

type Rep1 (Dimensional ('DQuantity s) d :: Type -> Type) = D1 ('MetaData "Dimensional" "Numeric.Units.Dimensional.Internal" "dimensional-1.6.1-ELRyWwWitPHC8LaQvCwLfc" 'True) (C1 ('MetaCons "Quantity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) Par1))

type Rep1 (Dimensional ('DUnit m) d :: Type -> Type)

Defined in Numeric.Units.Dimensional.Internal

type Rep1 (Dimensional ('DUnit m) d :: Type -> Type) = D1 ('MetaData "Dimensional" "Numeric.Units.Dimensional.Internal" "dimensional-1.6.1-ELRyWwWitPHC8LaQvCwLfc" 'False) (C1 ('MetaCons "Unit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (UnitName m)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExactPi) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) Par1)))

newtype MVector v (SQuantity s d a)

Defined in Numeric.Units.Dimensional.Internal

newtype MVector v (SQuantity s d a) = MV_Quantity {

• unMVQ :: MVector v a

}

newtype Dimensional ('DQuantity s) d a

Defined in Numeric.Units.Dimensional.Internal

newtype Dimensional ('DQuantity s) d a = Quantity a

data Dimensional ('DUnit m) d a

Defined in Numeric.Units.Dimensional.Internal

data Dimensional ('DUnit m) d a = Unit !(UnitName m) !ExactPi !a

type Rep (Dimensional ('DQuantity s) d a)

Defined in Numeric.Units.Dimensional.Internal

type Rep (Dimensional ('DQuantity s) d a) = D1 ('MetaData "Dimensional" "Numeric.Units.Dimensional.Internal" "dimensional-1.6.1-ELRyWwWitPHC8LaQvCwLfc" 'True) (C1 ('MetaCons "Quantity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

type Rep (Dimensional ('DUnit m) d a)

Defined in Numeric.Units.Dimensional.Internal

type Rep (Dimensional ('DUnit m) d a) = D1 ('MetaData "Dimensional" "Numeric.Units.Dimensional.Internal" "dimensional-1.6.1-ELRyWwWitPHC8LaQvCwLfc" 'False) (C1 ('MetaCons "Unit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (UnitName m)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExactPi) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a))))

newtype Vector (SQuantity s d a)

Defined in Numeric.Units.Dimensional.Internal

newtype Vector (SQuantity s d a) = V_Quantity {

• unVQ :: Vector a

}

unQuantity :: SQuantity s d a -> a

Unwraps a possibly-scaled SQuantity, yielding its underlying representation.

This is a type-restricted version of coerce.