The dimensional package

[Tags:bsd3, library]

Dimensional is a library providing data types for performing arithmetic with physical quantities and units. Information about the physical dimensions of the quantities and units is embedded in their types and the validity of operations is verified by the type checker at compile time. The boxing and unboxing of numerical values as quantities is done by multiplication and division with units. The library is designed to, as far as is practical, enforce/encourage best practices of unit usage. Version 1 of the dimensional package differs from earlier version in that the dimension tracking is implemented using Closed Type Families and Data Kinds rather than functional dependencies. This enables a number of features, including improved support for unit names and quantities with statically-unknown dimensions. Requires GHC 7.8 or later.


[Skip to Readme]

Properties

Versions 0.7, 0.7.1, 0.7.2, 0.7.3, 0.8, 0.8.0.1, 0.8.2.1, 0.9, 0.10, 0.10.1, 0.10.1.1, 0.10.1.2, 0.10.2, 0.12, 0.12.1, 0.12.1.1, 0.12.2, 0.12.3, 0.13, 0.13.0.1, 0.13.0.2, 1.0.0.0, 1.0.1.0, 1.0.1.1, 1.0.1.2
Change log CHANGELOG.md
Dependencies base (>=4.7 && <5), deepseq (>=1.3), exact-pi (>=0.2.1.1 && <0.5), numtype-dk (>=0.5 && <1.1), vector (>=0.10) [details]
License BSD3
Copyright Bjorn Buckwalter 2006-2015
Author Bjorn Buckwalter
Maintainer bjorn@buckwalter.se
Stability experimental
Category Math, Physics
Home page https://github.com/bjornbm/dimensional/
Source repository head: git clone https://github.com/bjornbm/dimensional/
Uploaded Thu May 19 21:50:40 UTC 2016 by dmcclean
Distributions Debian:0.13.0.2, LTSHaskell:1.0.1.2, NixOS:1.0.1.2
Downloads 4904 total (68 in the last 30 days)
Votes
3 []
Status Docs available [build log]
Last success reported on 2016-05-19 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for dimensional

Readme for dimensional-1.0.1.2

dimensional

This library provides statically-checked dimensional arithmetic for physical quantities, using the 7 SI base dimensions. Data kinds and closed type families provide a flexible, safe, and discoverable implementation that leads to largely self-documenting client code. Build Status Hackage Version

Usage

Simply importing Numeric.Units.Dimensional.Prelude provides access to dimensional arithmetic opertors, SI units and other common units accepted for use with the SI, and convenient aliases for quantities with commonly used dimensions. The Unit d a type represents a unit with dimension d, whose conversion factor to the coherent SI base unit of the corresponding dimension is represented by a value of type a. a is commonly chosen to be Double, but can be any Floating type. Where possible, support is also provided for Fractional or Num values. Similarly, the Quantity d a type represents a quantity with dimension d, whose numeric value is of type a. Aliases allow the use of, e.g., Length Double to mean Quantity DLength Double. A complete list of available aliases is given in the haddock documentation for the Numeric.Units.Dimensional.Quantities. In the example below, we will solve a simple word problem. A car travels at 60 kilometers per hour for one mile, at 50 kph for one mile, at 40 kph for one mile, and at 30 kph for one mile. How many minutes does the journey take? What is the average speed of the car? How many seconds does the journey take, rounded up to the next whole second?

{-# LANGUAGE NoImplicitPrelude #-}

module ReadmeExample where

import Numeric.Units.Dimensional.Prelude
import Numeric.Units.Dimensional.NonSI (mile)

leg :: Length Double
leg = 1 *~ mile -- *~ combines a raw number and a unit to form a quantity

speeds :: [Velocity Double]
speeds = [60, 50, 40, 30] *~~ (kilo meter / hour)
  -- *~~ does the same thing for a whole Functor at once
  -- Parentheses are required around unit expressions that are comingled with *~, /~, *~~, or /~~ operations

timeOfJourney :: Time Double
timeOfJourney = sum $ fmap (leg /) speeds
  -- We can use dimensional versions of ordinary functions like / and sum to combine quantities

averageSpeed :: Velocity Double
averageSpeed = _4 * leg / timeOfJourney
  -- _4 is an alias for the dimensionless number 4

wholeSeconds :: Integer
wholeSeconds = ceiling $ timeOfJourney /~ second
  -- /~ lets us recover a raw number from a quantity and a unit in which it should be expressed

main :: IO ()
main = do
         putStrLn $ "Length of journey is: " ++ showIn minute timeOfJourney
         putStrLn $ "Average speed is: " ++ showIn (mile / hour) averageSpeed
         putStrLn $ "If we don't want to be explicit about units, the show instance uses the SI basis: " ++ show averageSpeed
         putStrLn $ "The journey requires " ++ show wholeSeconds ++ " seconds, rounded up to the nearest second."

Contributing

For project information (issues, updates, wiki, examples) see: https://github.com/bjornbm/dimensional