Add MonadPlus instance
[darcs-mirrors/vector.git] / vector.cabal
index 0db4623..507264d 100644 (file)
@@ -1,31 +1,68 @@
 Name:           vector
-Version:        0.5
+Version:        0.8
 License:        BSD3
 License-File:   LICENSE
 Author:         Roman Leshchinskiy <rl@cse.unsw.edu.au>
 Maintainer:     Roman Leshchinskiy <rl@cse.unsw.edu.au>
-Copyright:      (c) Roman Leshchinskiy 2008-2009
-Homepage:       http://darcs.haskell.org/vector
+Copyright:      (c) Roman Leshchinskiy 2008-2011
+Homepage:       http://code.haskell.org/vector
+Bug-Reports:    http://trac.haskell.org/vector
 Category:       Data, Data Structures
 Synopsis:       Efficient Arrays
 Description:
         .
-        An efficient implementation of Int-indexed arrays with a powerful loop
-        fusion framework.
+        An efficient implementation of Int-indexed arrays (both mutable
+        and immutable), with a powerful loop optimisation framework .
         .
         It is structured as follows:
         .
-        [@Data.Vector@] boxed vectors of arbitrary types
+        ["Data.Vector"] Boxed vectors of arbitrary types.
         .
-        [@Data.Vector.Primitive@] unboxed vectors of primitive types as
-                defined by the @primitive@ package
+        ["Data.Vector.Unboxed"] Unboxed vectors with an adaptive
+        representation based on data type families.
         .
-        [@Data.Vector.Storable@] unboxed vectors of 'Storable' types
+        ["Data.Vector.Storable"] Unboxed vectors of 'Storable' types.
         .
-        [@Data.Vector.Generic@] generic interface to the vector types
+        ["Data.Vector.Primitive"] Unboxed vectors of primitive types as
+        defined by the @primitive@ package. "Data.Vector.Unboxed" is more
+        flexible at no performance cost.
+        .
+        ["Data.Vector.Generic"] Generic interface to the vector types.
+        .
+        Each module has a @Safe@ version with is marked as @Trustworthy@
+        (see <http://hackage.haskell.org/trac/ghc/wiki/SafeHaskell>).
+        .
+        There is also a (draft) tutorial on common uses of vector.
+        .
+        * <http://haskell.org/haskellwiki/Numeric_Haskell:_A_Vector_Tutorial>
+        .
+        Please use the project trac to submit bug reports and feature
+        requests.
+        .
+        * <http://trac.haskell.org/vector>
+        .
+        Changes in version 0.8
+        .
+        * New functions: @constructN@, @constructrN@
+        .
+        * Support for GHC 7.2 array copying primitives
+        .
+        * New fixity for @(!)@
+        .
+        * Safe Haskell support (contributed by David Terei)
+        .
+        * 'Functor', 'Monad', 'Applicative', 'Alternative', 'Foldable' and
+          'Traversable' instances for boxed vectors
+          (/WARNING: they tend to be slow and are only provided for completeness/)
+        .
+        * 'Show' instances for immutable vectors follow containers conventions
+        .
+        * 'Read' instances for all immutable vector types
+        .
+        * Performance improvements
         .
 
-Cabal-Version:  >= 1.2
+Cabal-Version:  >= 1.2.3
 Build-Type:     Simple
 
 Extra-Source-Files:
@@ -37,59 +74,99 @@ Extra-Source-Files:
       tests/Utilities.hs
       tests/Tests/Stream.hs
       tests/Tests/Vector.hs
+      benchmarks/vector-benchmarks.cabal
+      benchmarks/LICENSE
+      benchmarks/Setup.hs
+      benchmarks/Main.hs
+      benchmarks/Algo/AwShCC.hs
+      benchmarks/Algo/HybCC.hs
+      benchmarks/Algo/Leaffix.hs
+      benchmarks/Algo/ListRank.hs
+      benchmarks/Algo/Quickhull.hs
+      benchmarks/Algo/Rootfix.hs
+      benchmarks/Algo/Spectral.hs
+      benchmarks/Algo/Tridiag.hs
+      benchmarks/TestData/Graph.hs
+      benchmarks/TestData/ParenTree.hs
+      benchmarks/TestData/Random.hs
+      internal/GenUnboxTuple.hs
+      internal/unbox-tuple-instances
+      Changelog
+
+Flag BoundsChecks
+  Description: Enable bounds checking
+  Default: True
+
+Flag UnsafeChecks
+  Description: Enable bounds checking in unsafe operations at the cost of a
+               significant performance penalty
+  Default: False
+
+Flag InternalChecks
+  Description: Enable internal consistency checks at the cost of a
+               significant performance penalty
+  Default: False
 
-Flag EnableAssertions
-  Description: Enable assertions that check parameters to functions are reasonable.
-               These will impose a moderate performance cost on users of the library,
-               with the benefit that you get reasonable errors rather than segmentation faults!
-  Default:     True
 
 Library
-  Extensions: CPP
+  Extensions: CPP, DeriveDataTypeable
   Exposed-Modules:
+        Data.Vector.Internal.Check
+
         Data.Vector.Fusion.Util
         Data.Vector.Fusion.Stream.Size
         Data.Vector.Fusion.Stream.Monadic
+        Data.Vector.Fusion.Stream.Monadic.Safe
         Data.Vector.Fusion.Stream
-
-        Data.Vector.Internal.Check
+        Data.Vector.Fusion.Stream.Safe
 
         Data.Vector.Generic.Mutable
+        Data.Vector.Generic.Mutable.Safe
+        Data.Vector.Generic.Base
         Data.Vector.Generic.New
+        Data.Vector.Generic.New.Safe
         Data.Vector.Generic
+        Data.Vector.Generic.Safe
 
         Data.Vector.Primitive.Mutable
+        Data.Vector.Primitive.Mutable.Safe
         Data.Vector.Primitive
+        Data.Vector.Primitive.Safe
 
         Data.Vector.Storable.Internal
         Data.Vector.Storable.Mutable
         Data.Vector.Storable
 
+        Data.Vector.Unboxed.Base
+        Data.Vector.Unboxed.Mutable
+        Data.Vector.Unboxed.Mutable.Safe
+        Data.Vector.Unboxed
+        Data.Vector.Unboxed.Safe
+
         Data.Vector.Mutable
+        Data.Vector.Mutable.Safe
         Data.Vector
+        Data.Vector.Safe
+
   Include-Dirs:
-        include
+        include, internal
 
   Install-Includes:
         vector.h
 
-  Build-Depends: base >= 2 && < 5, ghc >= 6.9, primitive
+  Build-Depends: base >= 4 && < 5, primitive >= 0.4 && < 0.5
 
--- -finline-if-enough-args is ESSENTIAL. If we don't have this the partial application
--- of e.g. Stream.Monadic.++ to the monad dictionary at the use site in Stream.++ causes
--- it to be fruitlessly inlined. This in turn leads to a huge RHS for Stream.++, so it
--- doesn't get inlined at the final call site and fusion fails to occur.
   if impl(ghc<6.13)
-    Ghc-Options: -finline-if-enough-args
+    Ghc-Options: -finline-if-enough-args -fno-method-sharing
   
--- It's probably a good idea to compile the library with -O2 as well. However, it's probably
--- not as essential as you think because most of the optimisation occurs when the library
--- functions from here are inlined into the user programs (which SHOULD be compiled with -O2!).
---
--- We have to fiddle with the assertion stuff at this point too because -O2 implies -fno-ignore-asserts,
--- meaning that their relative ordering is CRUCIAL. Setting them together guarantees it.
-  if flag(enableassertions)
-    -- Asserts are ignored by default at -O1 or higher
-    Ghc-Options: -O2 -fno-ignore-asserts
-  else
-    Ghc-Options: -O2
+  Ghc-Options: -O2
+
+  if flag(BoundsChecks)
+    cpp-options: -DVECTOR_BOUNDS_CHECKS
+
+  if flag(UnsafeChecks)
+    cpp-options: -DVECTOR_UNSAFE_CHECKS
+
+  if flag(InternalChecks)
+    cpp-options: -DVECTOR_INTERNAL_CHECKS
+