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


-- | Vec: length-indexed (sized) list: optics support
--   
--   This package provides <a>optics</a> and instances for data types in
--   <a>vec</a> package.
--   
--   <a>Data.Vec.Optics.Instances</a> provides all the instances. the other
--   modules provide some named optics too.
@package vec-optics
@version 0.3

module Data.Vec.DataFamily.SpineStrict.Optics

-- | Index lens.
--   
--   <pre>
--   &gt;&gt;&gt; view (ix (FS FZ)) ('a' ::: 'b' ::: 'c' ::: VNil)
--   'b'
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; set (ix (FS FZ)) 'x' ('a' ::: 'b' ::: 'c' ::: VNil)
--   'a' ::: 'x' ::: 'c' ::: VNil
--   </pre>
ix :: forall n a. InlineInduction n => Fin n -> Lens' (Vec n a) a

-- | Match on non-empty <a>Vec</a>.
--   
--   <i>Note:</i> <tt>lens</tt> <a>_Cons</a> is a <a>Prism</a>. In fact,
--   <tt><a>Vec</a> n a</tt> cannot have an instance of <a>Cons</a> as
--   types don't match.
_Cons :: Iso (Vec ( 'S n) a) (Vec ( 'S n) b) (a, Vec n a) (b, Vec n b)

-- | Head lens. <i>Note:</i> <tt>lens</tt> <a>_head</a> is a
--   <a>Traversal'</a>.
--   
--   <pre>
--   &gt;&gt;&gt; view _head ('a' ::: 'b' ::: 'c' ::: VNil)
--   'a'
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; set _head 'x' ('a' ::: 'b' ::: 'c' ::: VNil)
--   'x' ::: 'b' ::: 'c' ::: VNil
--   </pre>
_head :: Lens' (Vec ( 'S n) a) a

-- | Tail lens.
_tail :: Lens' (Vec ( 'S n) a) (Vec n a)

-- | An <a>Iso</a> from <a>toPull</a> and <a>fromPull</a>.
_Pull :: InlineInduction n => Iso (Vec n a) (Vec n b) (Vec n a) (Vec n b)

-- | Prism from list.
--   
--   <pre>
--   &gt;&gt;&gt; preview _Vec "foo" :: Maybe (Vec N.Nat3 Char)
--   Just ('f' ::: 'o' ::: 'o' ::: VNil)
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; preview _Vec "foo" :: Maybe (Vec N.Nat2 Char)
--   Nothing
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; review _Vec (True ::: False ::: VNil)
--   [True,False]
--   </pre>
_Vec :: InlineInduction n => Prism' [a] (Vec n a)
instance Data.Type.Nat.InlineInduction n => Optics.Internal.Indexed.FunctorWithIndex (Data.Fin.Fin n) (Data.Vec.DataFamily.SpineStrict.Vec n)
instance Data.Type.Nat.InlineInduction n => Optics.Internal.Indexed.FoldableWithIndex (Data.Fin.Fin n) (Data.Vec.DataFamily.SpineStrict.Vec n)
instance Data.Type.Nat.InlineInduction n => Optics.Internal.Indexed.TraversableWithIndex (Data.Fin.Fin n) (Data.Vec.DataFamily.SpineStrict.Vec n)
instance Data.Type.Nat.InlineInduction n => Optics.Each.Core.Each (Data.Fin.Fin n) (Data.Vec.DataFamily.SpineStrict.Vec n a) (Data.Vec.DataFamily.SpineStrict.Vec n b) a b
instance Data.Type.Nat.InlineInduction n => Optics.At.Core.Ixed (Data.Vec.DataFamily.SpineStrict.Vec n a)
instance Data.Tuple.Optics.Field1 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S n) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S n) a) a a
instance Data.Tuple.Optics.Field2 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S n)) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S n)) a) a a
instance Data.Tuple.Optics.Field3 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))) a) a a
instance Data.Tuple.Optics.Field4 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))) a) a a
instance Data.Tuple.Optics.Field5 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))) a) a a
instance Data.Tuple.Optics.Field6 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))) a) a a
instance Data.Tuple.Optics.Field7 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))) a) a a
instance Data.Tuple.Optics.Field8 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))))) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))))) a) a a
instance Data.Tuple.Optics.Field9 (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))))) a) (Data.Vec.DataFamily.SpineStrict.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))))) a) a a

module Data.Vec.Lazy.Optics

-- | Index lens.
--   
--   <pre>
--   &gt;&gt;&gt; view (ix (FS FZ)) ('a' ::: 'b' ::: 'c' ::: VNil)
--   'b'
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; set (ix (FS FZ)) 'x' ('a' ::: 'b' ::: 'c' ::: VNil)
--   'a' ::: 'x' ::: 'c' ::: VNil
--   </pre>
ix :: Fin n -> Lens' (Vec n a) a

-- | Match on non-empty <a>Vec</a>.
--   
--   <i>Note:</i> <tt>lens</tt> <a>_Cons</a> is a <a>Prism</a>. In fact,
--   <tt><a>Vec</a> n a</tt> cannot have an instance of <a>Cons</a> as
--   types don't match.
_Cons :: Iso (Vec ( 'S n) a) (Vec ( 'S n) b) (a, Vec n a) (b, Vec n b)

-- | Head lens. <i>Note:</i> <tt>lens</tt> <a>_head</a> is a
--   <a>Traversal'</a>.
--   
--   <pre>
--   &gt;&gt;&gt; view _head ('a' ::: 'b' ::: 'c' ::: VNil)
--   'a'
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; set _head 'x' ('a' ::: 'b' ::: 'c' ::: VNil)
--   'x' ::: 'b' ::: 'c' ::: VNil
--   </pre>
_head :: Lens' (Vec ( 'S n) a) a

-- | Tail lens.
_tail :: Lens' (Vec ( 'S n) a) (Vec n a)

-- | An <a>Iso</a> from <a>toPull</a> and <a>fromPull</a>.
_Pull :: SNatI n => Iso (Vec n a) (Vec n b) (Vec n a) (Vec n b)

-- | Prism from list.
--   
--   <pre>
--   &gt;&gt;&gt; preview _Vec "foo" :: Maybe (Vec N.Nat3 Char)
--   Just ('f' ::: 'o' ::: 'o' ::: VNil)
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; preview _Vec "foo" :: Maybe (Vec N.Nat2 Char)
--   Nothing
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; review _Vec (True ::: False ::: VNil)
--   [True,False]
--   </pre>
_Vec :: SNatI n => Prism' [a] (Vec n a)
instance Optics.Internal.Indexed.FunctorWithIndex (Data.Fin.Fin n) (Data.Vec.Lazy.Vec n)
instance Optics.Internal.Indexed.FoldableWithIndex (Data.Fin.Fin n) (Data.Vec.Lazy.Vec n)
instance Optics.Internal.Indexed.TraversableWithIndex (Data.Fin.Fin n) (Data.Vec.Lazy.Vec n)
instance Optics.Each.Core.Each (Data.Fin.Fin n) (Data.Vec.Lazy.Vec n a) (Data.Vec.Lazy.Vec n b) a b
instance Optics.At.Core.Ixed (Data.Vec.Lazy.Vec n a)
instance Data.Tuple.Optics.Field1 (Data.Vec.Lazy.Vec ('Data.Nat.S n) a) (Data.Vec.Lazy.Vec ('Data.Nat.S n) a) a a
instance Data.Tuple.Optics.Field2 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S n)) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S n)) a) a a
instance Data.Tuple.Optics.Field3 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))) a) a a
instance Data.Tuple.Optics.Field4 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))) a) a a
instance Data.Tuple.Optics.Field5 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))) a) a a
instance Data.Tuple.Optics.Field6 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))) a) a a
instance Data.Tuple.Optics.Field7 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))) a) a a
instance Data.Tuple.Optics.Field8 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))))) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n)))))))) a) a a
instance Data.Tuple.Optics.Field9 (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))))) a) (Data.Vec.Lazy.Vec ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S ('Data.Nat.S n))))))))) a) a a

module Data.Vec.Lazy.Inline.Optics

-- | Index lens.
--   
--   <pre>
--   &gt;&gt;&gt; view (ix (FS FZ)) ('a' ::: 'b' ::: 'c' ::: VNil)
--   'b'
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; set (ix (FS FZ)) 'x' ('a' ::: 'b' ::: 'c' ::: VNil)
--   'a' ::: 'x' ::: 'c' ::: VNil
--   </pre>
ix :: forall n a. InlineInduction n => Fin n -> Lens' (Vec n a) a

-- | Match on non-empty <a>Vec</a>.
--   
--   <i>Note:</i> <tt>lens</tt> <a>_Cons</a> is a <a>Prism</a>. In fact,
--   <tt><a>Vec</a> n a</tt> cannot have an instance of <a>Cons</a> as
--   types don't match.
_Cons :: Iso (Vec ( 'S n) a) (Vec ( 'S n) b) (a, Vec n a) (b, Vec n b)

-- | Head lens. <i>Note:</i> <tt>lens</tt> <a>_head</a> is a
--   <a>Traversal'</a>.
--   
--   <pre>
--   &gt;&gt;&gt; view _head ('a' ::: 'b' ::: 'c' ::: VNil)
--   'a'
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; set _head 'x' ('a' ::: 'b' ::: 'c' ::: VNil)
--   'x' ::: 'b' ::: 'c' ::: VNil
--   </pre>
_head :: Lens' (Vec ( 'S n) a) a

-- | Tail lens.
_tail :: Lens' (Vec ( 'S n) a) (Vec n a)

-- | An <a>Iso</a> from <a>toPull</a> and <a>fromPull</a>.
_Pull :: InlineInduction n => Iso (Vec n a) (Vec n b) (Vec n a) (Vec n b)

-- | Prism from list.
--   
--   <pre>
--   &gt;&gt;&gt; preview _Vec "foo" :: Maybe (Vec N.Nat3 Char)
--   Just ('f' ::: 'o' ::: 'o' ::: VNil)
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; preview _Vec "foo" :: Maybe (Vec N.Nat2 Char)
--   Nothing
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; review _Vec (True ::: False ::: VNil)
--   [True,False]
--   </pre>
_Vec :: InlineInduction n => Prism' [a] (Vec n a)

module Data.Vec.Pull.Optics

-- | Index lens.
--   
--   <tt>a</tt> ::: <tt>x</tt> ::: <tt>c</tt> ::: VNil &gt;&gt;&gt; view
--   (L._Pull % ix (FS FZ)) (<tt>a</tt> L.::: <tt>b</tt> L.::: <tt>c</tt>
--   L.::: L.VNil) <tt>b</tt>
--   
--   <pre>
--   &gt;&gt;&gt; set (L._Pull % ix (FS FZ)) 'x' ('a' L.::: 'b' L.::: 'c' L.::: L.VNil)
--   'a' ::: 'x' ::: 'c' ::: VNil
--   </pre>
ix :: Fin n -> Lens' (Vec n a) a

-- | Match on non-empty <a>Vec</a>.
--   
--   <i>Note:</i> <tt>lens</tt> <a>_Cons</a> is a <a>Prism</a>. In fact,
--   <tt><a>Vec</a> n a</tt> cannot have an instance of <a>Cons</a> as
--   types don't match.
_Cons :: Iso (Vec ( 'S n) a) (Vec ( 'S n) b) (a, Vec n a) (b, Vec n b)

-- | Head lens. <i>Note:</i> <tt>lens</tt> <a>_head</a> is a
--   <a>Traversal'</a>.
--   
--   <pre>
--   &gt;&gt;&gt; view (L._Pull % _head) ('a' L.::: 'b' L.::: 'c' L.::: L.VNil)
--   'a'
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; set (L._Pull % _head) 'x' ('a' L.::: 'b' L.::: 'c' L.::: L.VNil)
--   'x' ::: 'b' ::: 'c' ::: VNil
--   </pre>
_head :: Lens' (Vec ( 'S n) a) a

-- | Tail lens.
_tail :: Lens' (Vec ( 'S n) a) (Vec n a)

-- | Prism from list.
_Vec :: SNatI n => Prism' [a] (Vec n a)
instance Optics.Internal.Indexed.FunctorWithIndex (Data.Fin.Fin n) (Data.Vec.Pull.Vec n)
instance Data.Type.Nat.SNatI n => Optics.Internal.Indexed.FoldableWithIndex (Data.Fin.Fin n) (Data.Vec.Pull.Vec n)


-- | This module re-exports instances from all the modules defined in
--   <tt>vec-lens</tt> package.
module Data.Vec.Optics.Instances