dimensional: Statically checked physical dimensions, using Type Families and Data Kinds.

[ bsd3, library, math, physics ] [ Propose Tags ]

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]
Versions [RSS] [faq] 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, 1.0.1.3, 1.1, 1.2, 1.3, 1.4
Dependencies base (>=4.7 && <5), deepseq (>=1.3), exact-pi (>=0.2.1.1 && <0.3), numtype-dk (>=0.5 && <1.1), vector (>=0.10) [details]
License BSD-3-Clause
Copyright Bjorn Buckwalter 2006-2015
Author Bjorn Buckwalter
Maintainer bjorn@buckwalter.se
Category Math, Physics
Home page https://github.com/bjornbm/dimensional-dk/
Source repo head: git clone https://github.com/bjornbm/dimensional-dk/
Uploaded by dmcclean at 2015-10-31T02:09:56Z
Distributions Debian:1.1, LTSHaskell:1.4, NixOS:1.4, Stackage:1.4
Downloads 23404 total (152 in the last 30 days)
Rating 2.5 (votes: 5) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2016-11-30 [all 3 reports]

Modules

  • Numeric
    • Units
      • Numeric.Units.Dimensional
        • Numeric.Units.Dimensional.Dimensions
          • Numeric.Units.Dimensional.Dimensions.TermLevel
          • Numeric.Units.Dimensional.Dimensions.TypeLevel
        • Numeric.Units.Dimensional.Dynamic
        • Numeric.Units.Dimensional.Functor
        • Numeric.Units.Dimensional.NonSI
        • Numeric.Units.Dimensional.Prelude
        • Numeric.Units.Dimensional.Quantities
        • Numeric.Units.Dimensional.SIUnits
        • Numeric.Units.Dimensional.UnitNames
          • Numeric.Units.Dimensional.UnitNames.InterchangeNames
        • Numeric.Units.Dimensional.Variants

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for dimensional-1.0.0.0

[back to package description]

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.

{-# LANGUAGE NoImplicitPrelude #-}

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

radiusOfEarth :: Length Double
radiusOfEarth = 6371 *~ kilo meter

massOfEarth :: Mass Double
massOfEarth = 5.97e24 *~ kilo gram

g :: GravitationalParameter Double
g = 6.67384e-11 *~ (meter^pos3 * (kilo gram)^neg1 * second^neg2)

gravitationalFieldStrength :: Mass a -> Length a -> Acceleration a
gravitationalFieldStrength m r = g * m / r^pos2

approximateAccelerationDueToGravityOnEarth = gravitationalFieldStrength massOfEarth radiusOfEarth

differenceFromStandardValue = approximateAccelerationDueToGravityOnEarth /~ gee

Contributing

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