Dimensions.hs

{- Data/Metrology/Units.hs

   The units Package
   Copyright (c) 2013 Richard Eisenberg
   eir@cis.upenn.edu

   This file defines the class Dimension, which is needed for
   defining dimensions.
-}

{-# LANGUAGE TypeFamilies, DataKinds, DefaultSignatures, MultiParamTypeClasses,
             ConstraintKinds, UndecidableInstances, FlexibleContexts,
             FlexibleInstances, ScopedTypeVariables, TypeOperators #-}

module Data.Metrology.Dimensions where

import Data.Metrology.Z
import Data.Metrology.Factor
import Data.Metrology.LCSU
import Data.Type.Bool
import Data.Type.Equality
import Data.Proxy
import Data.Singletons
import GHC.Exts


-- | This class is used to mark abstract dimensions, such as @Length@, or
-- @Mass@.
class Dimension dim where
  -- | Retrieve a list of @Factor@s representing the given dimension. Overriding
  -- the default of this type family should not be necessary in user code.
  type DimFactorsOf dim :: [Factor *]
  type DimFactorsOf dim = '[F dim One]