Documentation
authorRoman Leshchinskiy <rl@cse.unsw.edu.au>
Sat, 31 Dec 2011 13:43:23 +0000 (13:43 +0000)
committerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Sat, 31 Dec 2011 13:43:23 +0000 (13:43 +0000)
Data/Vector/Generic/Mutable.hs

index 62da9c8..91e7036 100644 (file)
@@ -72,6 +72,20 @@ import Prelude hiding ( length, null, replicate, reverse, map, read,
 
 -- | Class of mutable vectors parametrised with a primitive state token.
 --
+-- Minimum complete implementation:
+--
+--   * 'basicLength'
+--
+--   * 'basicUnsafeSlice'
+--
+--   * 'basicOverlaps'
+--
+--   * 'basicUnsafeNew'
+--
+--   * 'basicUnsafeRead'
+--
+--   * 'basicUnsafeWrite'
+--
 class MVector v a where
   -- | Length of the mutable vector. This method should not be
   -- called directly, use 'length' instead.