Number.Physical.Unit

Portability	portable
Stability	provisional
Maintainer	numericprelude@henning-thielemann.de

Description

Abstract Physical Units

Synopsis

type T i = Map i Int

scalar :: T i

isScalar :: T i -> Bool

fromVector :: (Enum i, Ord i) => [Int] -> T i

toVector :: (Enum i, Ord i) => T i -> [Int]

ratScale :: T Int -> T i -> T i

ratScaleMaybe :: T Int -> T i -> Maybe (T i)

ratScaleMaybe2 :: T Int -> T i -> Map i (Maybe Int)

Documentation

type T i = Map i Int

A Unit.T is a sparse vector with integer entries Each map n->m means that the unit of the n-th dimension is given m times.

Example: Let the quantity of length (meter, m) be the zeroth dimension and let the quantity of time (second, s) be the first dimension, then the composed unit m_s² corresponds to the Map [(0,1),(1,-2)]

In future I want to have more abstraction here, e.g. a type class from the Edison project that abstracts from the underlying implementation. Then one can easily switch between Arrays, Binary trees (like Map) and what know I.

scalar :: T i

The neutral Unit.T

isScalar :: T i -> Bool

Test for the neutral Unit.T

fromVector :: (Enum i, Ord i) => [Int] -> T i

Convert a List to sparse Map representation Example: [-1,0,-2] -> [(0,-1),(2,-2)]

toVector :: (Enum i, Ord i) => T i -> [Int]

Convert Map to a List

ratScale :: T Int -> T i -> T i

ratScaleMaybe :: T Int -> T i -> Maybe (T i)

ratScaleMaybe2 :: T Int -> T i -> Map i (Maybe Int)

Produced by Haddock version 0.7