Module comments
authorRoman Leshchinskiy <rl@cse.unsw.edu.au>
Tue, 27 Apr 2010 04:41:28 +0000 (04:41 +0000)
committerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Tue, 27 Apr 2010 04:41:28 +0000 (04:41 +0000)
Data/Vector/Primitive.hs
Data/Vector/Unboxed.hs

index 343875b..7c0a97e 100644 (file)
@@ -9,7 +9,10 @@
 -- Stability   : experimental
 -- Portability : non-portable
 -- 
--- Unboxed vectors of primitive types.
+-- Unboxed vectors of primitive types. The use of this module is not
+-- recommended except in very special cases. Adaptive unboxed vectors defined
+-- in "Data.Vector.Unboxed" are significantly more flexible at no performance
+-- cost.
 --
 
 module Data.Vector.Primitive (
index 05b9e44..b45647b 100644 (file)
@@ -9,7 +9,10 @@
 -- Stability   : experimental
 -- Portability : non-portable
 --
--- Adaptive unboxed vectors
+-- Adaptive unboxed vectors. The implementation is based on type families
+-- and picks an efficient, specialised representation for every element type.
+-- In particular, unboxed vectors of pairs are represented as pairs of unboxed
+-- vectors.
 --
 
 module Data.Vector.Unboxed (