The numhask package

[ Tags: bsd3, library, mathematics ] [ Propose Tags ]

A numeric prelude, providing a clean structure for numbers and operations that combine them.


[Skip to Readme]

Properties

Versions 0.0.1, 0.0.2, 0.0.3, 0.0.4, 0.0.5, 0.0.6, 0.0.7, 0.0.8, 0.0.9, 0.1.0, 0.1.1, 0.1.2
Dependencies adjunctions (>=4.3 && <5), base (>=4.7 && <4.11), distributive (==0.5.*), matrix (>=0.3.5.0 && <0.4), protolude (>=0.1 && <0.3), QuickCheck (>=2.8 && <3), singletons (>=2.2 && <3), vector (>=0.11 && <0.13) [details]
License BSD3
Copyright Tony Day
Author Tony Day
Maintainer tonyday567@gmail.com
Category mathematics
Home page https://github.com/tonyday567/numhask
Source repository head: git clone https://github.com/tonyday567/numhask
Uploaded Sat Aug 26 05:17:00 UTC 2017 by tonyday567
Distributions LTSHaskell:0.0.9, NixOS:0.1.2, Stackage:0.1.2
Downloads 510 total (36 in the last 30 days)
Rating 2.0 (1 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-08-26 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for numhask-0.1.2

[back to package description]

numhask

Build Status Hackage lts nightly

A numeric prelude, providing a clean structure for numbers and operations that combine them.

Field Hierarchy

This particular shed has been painted:

  • by providing separately named magma-derived classes for addition and multiplication, and then being symetrical in the treatment of the two heirarchies. A short magma structure is provided with the intention of supplying appropriate classes fro operators that are no addition nor multiplication, but this structure is not hooked up to the main classes.
  • to be as compatible as practical with the existing haskell ecosystem. Ints, Integers, Floats, Doubles and Complex are taken from base and given numhask instances, so they are also Num instances. Monoid and Semigroup are not used in numhask to maintain compatability.
  • as a replacement for anything in base that has a Num, Fractional or Real constraint.
  • with type-checked Vector and Matrix instances using Representable to build the shape and structure.
  • includes QuickCheck tests of the numeric laws implicit in the classes. This also includes tracking where laws are approximate or fail for non-exact numbers.
  • the usual operators (+) and (*) operators are reserved for commutative relationships, with plus and times being used for non-commutative ones.

Alternative color-schemes, stylistic flourishes and opines are welcome.

In summary, the library doesn't do anything fancy. But if having to define (*) when you just want a (+) offends your sensibilities, it may bring some sanity.

Representable numbers

Hilbert Hierarchy

Vector and Matrix objects are provided that:

  • are shape type-checked
  • are based on Representable instances
  • have inner and tensor product operators

These are experimental and await testing in the wild.

Usage

{-# LANGUAGE NoImplicitPrelude #-}
import Numhask.Prelude

'Numhask.Prelude' is designed as a drop-in replacement for Prelude and 'NoImplicitPrelude' is obligatory. Behind the scenes, the module wraps protolude.

See Examples for basic examples, and numhask-space for slightly heavier number crunching.