-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Vectors with O(1) reverse
--   
--   A wrapper for an arbitrary <tt>Vector</tt> with O(1) <tt>reverse</tt>.
--   Instead of creating a copy, it just flips a flag, which inverts
--   indexing. Imagine it as a vector with a switch between
--   little-endianness and big-endianness.
@package vector-rotcev
@version 0.1.0.2


-- | A wrapper for an arbitrary <a>Vector</a> with O(1) <a>reverse</a>.
--   Instead of creating a copy, it just flips a flag, which inverts
--   indexing. Imagine it as a vector with a switch between
--   little-endianness and big-endianness.
module Data.Vector.Rotcev

-- | Wrapper for immutable vectors, equipped with a <a>Vector</a> instance.
--   
--   <pre>
--   &gt;&gt;&gt; Forward  (Data.Vector.fromList [0..100]) Data.Vector.Generic.! 10
--   10
--   
--   &gt;&gt;&gt; Backward (Data.Vector.fromList [0..100]) Data.Vector.Generic.! 10
--   90
--   </pre>
data Rotcev v a

-- | Behaves as an original vector in respect to <a>Vector</a> operations.
Forward :: !v a -> Rotcev v a

-- | Behaves as a reversed vector in respect to <a>Vector</a> operations.
Backward :: !v a -> Rotcev v a

-- | Reverse an immutable vector in O(1) time and space.
--   
--   <pre>
--   &gt;&gt;&gt; vec = Data.Vector.Generic.fromList [0..100] :: Rotcev Data.Vector.Vector Int
--   
--   &gt;&gt;&gt; reverse vec Data.Vector.Generic.! 10
--   90
--   </pre>
reverse :: Rotcev v a -> Rotcev v a

-- | Unwrap <a>Rotcev</a>, extracting an underlying vector. This takes O(1)
--   for <a>Forward</a>, but full O(n) time for <a>Backward</a> case, so it
--   would rather be avoided in intermediate computations. Instead leverage
--   opportunities, provided by generic <a>Vector</a> and <a>MVector</a>
--   instances.
unRotcev :: Vector v a => Rotcev v a -> v a

-- | Wrapper for mutable vectors, equipped with a <a>MVector</a> instance.
data MRotcev v s a

-- | Behaves as an original vector in respect to <a>MVector</a> operations.
MForward :: !Mutable v s a -> MRotcev v s a

-- | Behaves as a reversed vector in respect to <a>MVector</a> operations.
MBackward :: !Mutable v s a -> MRotcev v s a

-- | Reverse a mutable vector in O(1) time and space.
mreverse :: MRotcev v s a -> MRotcev v s a
instance GHC.Show.Show (v a) => GHC.Show.Show (Data.Vector.Rotcev.Rotcev v a)
instance GHC.Classes.Ord (v a) => GHC.Classes.Ord (Data.Vector.Rotcev.Rotcev v a)
instance GHC.Classes.Eq (v a) => GHC.Classes.Eq (Data.Vector.Rotcev.Rotcev v a)
instance Data.Vector.Generic.Mutable.Base.MVector (Data.Vector.Generic.Base.Mutable v) a => Data.Vector.Generic.Mutable.Base.MVector (Data.Vector.Rotcev.MRotcev v) a
instance Data.Vector.Generic.Base.Vector v a => Data.Vector.Generic.Base.Vector (Data.Vector.Rotcev.Rotcev v) a