Safe Haskell	Safe
Language	Haskell2010

Data.Quantities.Data

Description

Base module for all data structures.

Synopsis

type Symbol = String
data SimpleUnit = SimpleUnit {
- symbol :: String
- prefix :: String
- power :: Double
}
data CompoundUnit = CompoundUnit {
- defs :: Definitions
- sUnits :: [SimpleUnit]
}
showCompUnit' :: SimpleUnit -> String
showPower :: Double -> String
showPrettyNum :: (Show a, Num a) => a -> String
data Quantity a = Quantity {
- magnitude :: a
- units :: CompoundUnit
}
units' :: Quantity a -> [SimpleUnit]
defs' :: Quantity a -> Definitions
baseQuant :: a -> [SimpleUnit] -> Quantity a
showSort :: [SimpleUnit] -> [SimpleUnit]
data QuantityError a
- = UndefinedUnitError String
- | DimensionalityError CompoundUnit CompoundUnit
- | UnitAlreadyDefinedError String
- | PrefixAlreadyDefinedError String
- | ParserError String
- | DifferentDefinitionsError CompoundUnit CompoundUnit
- | ScalingFactorError (Quantity a)
type QuantityComputation a = Either (QuantityError a)
reduceUnits :: Quantity a -> Quantity a
reduceUnits' :: [SimpleUnit] -> [SimpleUnit]
removeZeros :: [SimpleUnit] -> [SimpleUnit]
invertUnits :: [SimpleUnit] -> [SimpleUnit]
invertSimpleUnit :: SimpleUnit -> SimpleUnit
multiplyQuants :: Num a => Quantity a -> Quantity a -> Quantity a
divideQuants :: Fractional a => Quantity a -> Quantity a -> Quantity a
exptQuants :: (Real a, Floating a) => Quantity a -> a -> Quantity a
data Definition
- = PrefixDefinition {
  - defPrefix :: Symbol
  - factor :: Double
  - defSynonyms :: [Symbol]
  }
- | BaseDefinition {
  - base :: Symbol
  - dimBase :: Symbol
  - defSynonyms :: [Symbol]
  }
- | UnitDefinition {
  - defSymbol :: Symbol
  - quantity :: Quantity Double
  - defSynonyms :: [Symbol]
  }
data Definitions = Definitions {
- bases :: Map String (Double, [SimpleUnit])
- synonyms :: Map String String
- unitsList :: [String]
- prefixes :: [String]
- prefixValues :: Map String Double
- prefixSynonyms :: Map String String
- unitTypes :: Map String String
- defStringHash :: Int
}
emptyDefinitions :: Definitions
unionDefinitions :: Definitions -> Definitions -> Definitions

Documentation

>>> import Control.Applicative
>>> import Data.Quantities

type Symbol = String Source #

String representation of a unit. Examples: "meter", "foot"

data SimpleUnit Source #

Representation of single unit. For example: "mm^2" is represented as

SimpleUnit { symbol = "meter", prefix = "milli", power = 2.0 }

Constructors

SimpleUnit
Fields symbol :: String prefix :: String power :: Double

Instances

Eq SimpleUnit Source #
Instance details Defined in Data.Quantities.Data Methods (==) :: SimpleUnit -> SimpleUnit -> Bool # (/=) :: SimpleUnit -> SimpleUnit -> Bool #
Ord SimpleUnit Source #
Instance details Defined in Data.Quantities.Data Methods compare :: SimpleUnit -> SimpleUnit -> Ordering # (<) :: SimpleUnit -> SimpleUnit -> Bool # (<=) :: SimpleUnit -> SimpleUnit -> Bool # (>) :: SimpleUnit -> SimpleUnit -> Bool # (>=) :: SimpleUnit -> SimpleUnit -> Bool # max :: SimpleUnit -> SimpleUnit -> SimpleUnit # min :: SimpleUnit -> SimpleUnit -> SimpleUnit #
Show SimpleUnit Source #
Instance details Defined in Data.Quantities.Data Methods showsPrec :: Int -> SimpleUnit -> ShowS # show :: SimpleUnit -> String # showList :: [SimpleUnit] -> ShowS #

data CompoundUnit Source #

Data type to hold compound units, which are simple units multiplied together.

Constructors

CompoundUnit
Fields defs :: Definitions Definitions used to create the units. sUnits :: [SimpleUnit] List of SimpleUnits that is interpreted as the units being multiplied together.

Instances

Eq CompoundUnit Source #
Instance details Defined in Data.Quantities.Data Methods (==) :: CompoundUnit -> CompoundUnit -> Bool # (/=) :: CompoundUnit -> CompoundUnit -> Bool #
Ord CompoundUnit Source #
Instance details Defined in Data.Quantities.Data Methods compare :: CompoundUnit -> CompoundUnit -> Ordering # (<) :: CompoundUnit -> CompoundUnit -> Bool # (<=) :: CompoundUnit -> CompoundUnit -> Bool # (>) :: CompoundUnit -> CompoundUnit -> Bool # (>=) :: CompoundUnit -> CompoundUnit -> Bool # max :: CompoundUnit -> CompoundUnit -> CompoundUnit # min :: CompoundUnit -> CompoundUnit -> CompoundUnit #
Show CompoundUnit Source #
Instance details Defined in Data.Quantities.Data Methods showsPrec :: Int -> CompoundUnit -> ShowS # show :: CompoundUnit -> String # showList :: [CompoundUnit] -> ShowS #

showCompUnit' :: SimpleUnit -> String Source #

Show a single unit, but prepend with / if negative

showPower :: Double -> String Source #

Removes decimal if almost integer.

showPrettyNum :: (Show a, Num a) => a -> String Source #

Will be used when we allow pretty printing of fractional units.

data Quantity a Source #

Combination of magnitude and units.

Constructors

Quantity
Fields magnitude :: a Numerical magnitude of quantity. `>>>` *`magnitude <$> fromString "100 N m"`Right 100.0 units :: CompoundUnit Units associated with quantity. `>>>` `units <$> fromString "3.4 m/s^2"`Right meter / second 2

Instances

Eq a => Eq (Quantity a) Source #
Instance details Defined in Data.Quantities.Data Methods (==) :: Quantity a -> Quantity a -> Bool # (/=) :: Quantity a -> Quantity a -> Bool #
Ord a => Ord (Quantity a) Source #
Instance details Defined in Data.Quantities.Data Methods compare :: Quantity a -> Quantity a -> Ordering # (<) :: Quantity a -> Quantity a -> Bool # (<=) :: Quantity a -> Quantity a -> Bool # (>) :: Quantity a -> Quantity a -> Bool # (>=) :: Quantity a -> Quantity a -> Bool # max :: Quantity a -> Quantity a -> Quantity a # min :: Quantity a -> Quantity a -> Quantity a #
Show a => Show (Quantity a) Source #
Instance details Defined in Data.Quantities.Data Methods showsPrec :: Int -> Quantity a -> ShowS # show :: Quantity a -> String # showList :: [Quantity a] -> ShowS #

units' :: Quantity a -> [SimpleUnit] Source #

Convenience function to extract SimpleUnit collection from Quantity's CompoundUnit.

defs' :: Quantity a -> Definitions Source #

Convenience function to extract Definitions from Quantity's CompoundUnit.

baseQuant :: a -> [SimpleUnit] -> Quantity a Source #

Convenience function to make quantity with no definitions.

showSort :: [SimpleUnit] -> [SimpleUnit] Source #

Sort units but put negative units at end.

data QuantityError a Source #

Custom error type

Constructors

UndefinedUnitError String	Used when trying to parse an undefined unit.
DimensionalityError CompoundUnit CompoundUnit	Used when converting units that do not have the same dimensionality (example: convert meter to second).
UnitAlreadyDefinedError String	Used internally when defining units and a unit is already defined.
PrefixAlreadyDefinedError String	Used internally when defining units and a prefix is already defined.
ParserError String	Used when a string cannot be parsed.
DifferentDefinitionsError CompoundUnit CompoundUnit	Used when two quantities come from different Definitions.
ScalingFactorError (Quantity a)	Used when a scaling factor is present in a unit conversion.

Instances

Eq a => Eq (QuantityError a) Source #
Instance details Defined in Data.Quantities.Data Methods (==) :: QuantityError a -> QuantityError a -> Bool # (/=) :: QuantityError a -> QuantityError a -> Bool #
Show a => Show (QuantityError a) Source #
Instance details Defined in Data.Quantities.Data Methods showsPrec :: Int -> QuantityError a -> ShowS # show :: QuantityError a -> String # showList :: [QuantityError a] -> ShowS #

type QuantityComputation a = Either (QuantityError a) Source #

Useful for monadic computations with QuantityErrors. Some examples:

computation :: QuantityComputation Quantity
computation = do
  x <- fromString "mile/hr"
  y <- unitsFromString "m/s"
  convert x y

Returns Right 0.44704 meter / second

computation :: QuantityComputation Quantity
computation = do
  x <- fromString "BADUNIT"
  convertBase x

Returns Left (UndefinedUnitError BADUNIT)

reduceUnits :: Quantity a -> Quantity a Source #

Combines equivalent units and removes units with powers of zero.

reduceUnits' :: [SimpleUnit] -> [SimpleUnit] Source #

Helper function for reduceUnits.

removeZeros :: [SimpleUnit] -> [SimpleUnit] Source #

Removes units with powers of zero that are left over from other computations.

invertUnits :: [SimpleUnit] -> [SimpleUnit] Source #

Negate the powers of a list of SimpleUnits.

invertSimpleUnit :: SimpleUnit -> SimpleUnit Source #

Inverts unit by negating the power field.

multiplyQuants :: Num a => Quantity a -> Quantity a -> Quantity a Source #

Multiplies two quantities.

divideQuants :: Fractional a => Quantity a -> Quantity a -> Quantity a Source #

Divides two quantities.

exptQuants :: (Real a, Floating a) => Quantity a -> a -> Quantity a Source #

Exponentiates a quantity with an integer

data Definition Source #

Data type for the three definition types. Used to hold definitions information when parsing.

Constructors

PrefixDefinition
Fields defPrefix :: Symbol factor :: Double defSynonyms :: [Symbol]
BaseDefinition
Fields base :: Symbol dimBase :: Symbol defSynonyms :: [Symbol]
UnitDefinition
Fields defSymbol :: Symbol quantity :: Quantity Double defSynonyms :: [Symbol]

Instances

Eq Definition Source #
Instance details Defined in Data.Quantities.Data Methods (==) :: Definition -> Definition -> Bool # (/=) :: Definition -> Definition -> Bool #
Ord Definition Source #
Instance details Defined in Data.Quantities.Data Methods compare :: Definition -> Definition -> Ordering # (<) :: Definition -> Definition -> Bool # (<=) :: Definition -> Definition -> Bool # (>) :: Definition -> Definition -> Bool # (>=) :: Definition -> Definition -> Bool # max :: Definition -> Definition -> Definition # min :: Definition -> Definition -> Definition #
Show Definition Source #
Instance details Defined in Data.Quantities.Data Methods showsPrec :: Int -> Definition -> ShowS # show :: Definition -> String # showList :: [Definition] -> ShowS #

data Definitions Source #

Holds information about defined units, prefixes, and bases. Used when parsing new units and performing units conversions.

Constructors

Definitions

Fields

bases :: Map String (Double, [SimpleUnit])
Map from symbol to base units and conversion factor to those units.
synonyms :: Map String String
Map from alias to symbol. Symbols without aliases are present as identity maps.
unitsList :: [String]
List of all units (no aliases). Used in prefix parser, and to detect duplicate definitions.
prefixes :: [String]
List of all prefixes (no aliases). Used in prefix parser, and to detect duplicate prefix definitions.
prefixValues :: Map String Double
Multiplicative factor of prefixes.
prefixSynonyms :: Map String String
Map from prefix alias to prefix.
unitTypes :: Map String String
Map from base symbols to unit types.
defStringHash :: Int
Hash of the definitions string used to create definitions. Defaults to -1 if modified or no string was used.

Instances

Eq Definitions Source #
Instance details Defined in Data.Quantities.Data Methods (==) :: Definitions -> Definitions -> Bool # (/=) :: Definitions -> Definitions -> Bool #
Ord Definitions Source #
Instance details Defined in Data.Quantities.Data Methods compare :: Definitions -> Definitions -> Ordering # (<) :: Definitions -> Definitions -> Bool # (<=) :: Definitions -> Definitions -> Bool # (>) :: Definitions -> Definitions -> Bool # (>=) :: Definitions -> Definitions -> Bool # max :: Definitions -> Definitions -> Definitions # min :: Definitions -> Definitions -> Definitions #
Show Definitions Source #
Instance details Defined in Data.Quantities.Data Methods showsPrec :: Int -> Definitions -> ShowS # show :: Definitions -> String # showList :: [Definitions] -> ShowS #

emptyDefinitions :: Definitions Source #

Default, empty set of definitions.

unionDefinitions :: Definitions -> Definitions -> Definitions Source #

Combine two Definitions structures