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


-- | IsList instances of Array for OverloadedLists extension
--   
--   This package provides "orphan" <a>IsList</a> instances for
--   <a>Array</a> data types with <a>Integral</a> indices up to 5
--   dimensions to allow initializing <a>Array</a>s from [nested] lists
--   using <a>OverloadedLists</a> GHC extension.
--   
--   It also includes more generic <a>arrayNestedList</a> and
--   <a>toNestedList</a> functions to convert between nested lists and
--   <a>Array</a>s with any indices.
@package array-list
@version 0.2.0.0


-- | This package provides "orphan" <a>IsList</a> instances for
--   <a>Array</a>s with <a>Integral</a> indices up to 5 dimensions to allow
--   initializing <a>Array</a>s from [nested] lists using
--   <tt>OverloadedLists</tt> GHC extension.
--   
--   It also includes more generic <a>arrayNestedList</a> and
--   <a>toNestedList</a> functions to convert between nested lists and
--   <a>Array</a>s with any indices.
--   
--   <b>Examples</b>:
--   
--   <pre>
--   &gt;&gt;&gt; ["one","two","three"] :: Array Int String
--   array (0,2) [(0,"one"),(1,"two"),(2,"three")]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; [[0,1,2], [10,11,12]] :: Array (Int, Int) Int
--   array ((0,0),(1,2)) [((0,0),0),((0,1),1),((0,2),2),((1,0),10),((1,1),11),((1,2),12)]
--   </pre>
--   
--   If any of the nested lists contains smaller number of elements than
--   the first nested list in the same dimension, the array creation will
--   fail.
--   
--   <pre>
--   &gt;&gt;&gt; [[1,2],[3]] :: Array (Int, Int) Int
--   ... Exception: (Array.!): undefined array element
--   </pre>
--   
--   Nested lists with larger number of elements will be truncated.
module Data.Array.IsList

-- | The <a>IsList</a> class and its methods are intended to be used in
--   conjunction with the OverloadedLists extension.
class IsList l

-- | The <a>fromList</a> function constructs the structure <tt>l</tt> from
--   the given list of <tt>Item l</tt>
fromList :: IsList l => [Item l] -> l

-- | The <a>toList</a> function extracts a list of <tt>Item l</tt> from the
--   structure <tt>l</tt>. It should satisfy fromList . toList = id.
toList :: IsList l => l -> [Item l]

-- | <a>ArrayNestedList</a> class defines methods to convert between nested
--   lists and multi-dimensional (up to 5) <a>Array</a>s with any indices,
--   not only <a>Integral</a>, using provided range of indices.
class Ix i => ArrayNestedList i e

-- | Converts nested list to multi-dimensional <a>Array</a> Similarly to
--   <tt>arrayList</tt> function, it does not require to pass index for
--   each element, only the range of indices.
arrayNestedList :: ArrayNestedList i e => (i, i) -> NestedList i e -> Array i e

-- | Converts multi-dimensional <a>Array</a> to nested list.
toNestedList :: ArrayNestedList i e => Array i e -> NestedList i e
instance (GHC.Real.Integral i, GHC.Real.Integral j, GHC.Arr.Ix i, GHC.Arr.Ix j) => GHC.Exts.IsList (GHC.Arr.Array (i, j) e)
instance (GHC.Real.Integral i, GHC.Real.Integral j, GHC.Real.Integral k, GHC.Arr.Ix i, GHC.Arr.Ix j, GHC.Arr.Ix k) => GHC.Exts.IsList (GHC.Arr.Array (i, j, k) e)
instance (GHC.Real.Integral i, GHC.Real.Integral j, GHC.Real.Integral k, GHC.Real.Integral m, GHC.Arr.Ix i, GHC.Arr.Ix j, GHC.Arr.Ix k, GHC.Arr.Ix m) => GHC.Exts.IsList (GHC.Arr.Array (i, j, k, m) e)
instance (GHC.Real.Integral i, GHC.Real.Integral j, GHC.Real.Integral k, GHC.Real.Integral m, GHC.Real.Integral n, GHC.Arr.Ix i, GHC.Arr.Ix j, GHC.Arr.Ix k, GHC.Arr.Ix m, GHC.Arr.Ix n) => GHC.Exts.IsList (GHC.Arr.Array (i, j, k, m, n) e)
instance (GHC.Arr.Ix i, GHC.Arr.Ix j) => Data.Array.IsList.ArrayNestedList (i, j) e
instance (GHC.Arr.Ix i, GHC.Arr.Ix j, GHC.Arr.Ix k) => Data.Array.IsList.ArrayNestedList (i, j, k) e
instance (GHC.Arr.Ix i, GHC.Arr.Ix j, GHC.Arr.Ix k, GHC.Arr.Ix m) => Data.Array.IsList.ArrayNestedList (i, j, k, m) e
instance (GHC.Arr.Ix i, GHC.Arr.Ix j, GHC.Arr.Ix k, GHC.Arr.Ix m, GHC.Arr.Ix n) => Data.Array.IsList.ArrayNestedList (i, j, k, m, n) e
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Types.Int e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Int.Int8 e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Int.Int16 e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Int.Int32 e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Int.Int64 e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Integer.Type.Integer e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Natural.Natural e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Types.Word e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Word.Word8 e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Word.Word16 e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Word.Word32 e)
instance GHC.Exts.IsList (GHC.Arr.Array GHC.Word.Word64 e)