<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Data/Array.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a>
<a name="line-2"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : Data.Array </span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) The University of Glasgow 2001</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD-style (see the file libraries/base/LICENSE)</span>
<a name="line-7"></a><span class='hs-comment'>-- </span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : libraries@haskell.org</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : provisional</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Basic non-strict arrays.</span>
<a name="line-13"></a><span class='hs-comment'>--</span>
<a name="line-14"></a><span class='hs-comment'>-- /Note:/ The "Data.Array.IArray" module provides a more general interface</span>
<a name="line-15"></a><span class='hs-comment'>-- to immutable arrays: it defines operations with the same names as</span>
<a name="line-16"></a><span class='hs-comment'>-- those defined below, but with more general types, and also defines</span>
<a name="line-17"></a><span class='hs-comment'>-- 'Array' instances of the relevant classes. To use that more general</span>
<a name="line-18"></a><span class='hs-comment'>-- interface, import "Data.Array.IArray" but not "Data.Array".</span>
<a name="line-19"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-20"></a>
<a name="line-21"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Array</span>
<a name="line-22"></a>
<a name="line-23"></a> <span class='hs-layout'>(</span>
<a name="line-24"></a> <span class='hs-comment'>-- * Immutable non-strict arrays</span>
<a name="line-25"></a> <span class='hs-comment'>-- $intro</span>
<a name="line-26"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Ix</span> <span class='hs-comment'>-- export all of Ix </span>
<a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Array</span> <span class='hs-comment'>-- Array type is abstract</span>
<a name="line-28"></a>
<a name="line-29"></a> <span class='hs-comment'>-- * Array construction</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>array</span> <span class='hs-comment'>-- :: (Ix a) => (a,a) -> [(a,b)] -> Array a b</span>
<a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>listArray</span> <span class='hs-comment'>-- :: (Ix a) => (a,a) -> [b] -> Array a b</span>
<a name="line-32"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>accumArray</span> <span class='hs-comment'>-- :: (Ix a) => (b -> c -> b) -> b -> (a,a) -> [(a,c)] -> Array a b</span>
<a name="line-33"></a> <span class='hs-comment'>-- * Accessing arrays</span>
<a name="line-34"></a> <span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>!</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- :: (Ix a) => Array a b -> a -> b</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>bounds</span> <span class='hs-comment'>-- :: (Ix a) => Array a b -> (a,a)</span>
<a name="line-36"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>indices</span> <span class='hs-comment'>-- :: (Ix a) => Array a b -> [a]</span>
<a name="line-37"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>elems</span> <span class='hs-comment'>-- :: (Ix a) => Array a b -> [b]</span>
<a name="line-38"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>assocs</span> <span class='hs-comment'>-- :: (Ix a) => Array a b -> [(a,b)]</span>
<a name="line-39"></a> <span class='hs-comment'>-- * Incremental array updates</span>
<a name="line-40"></a> <span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>//</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- :: (Ix a) => Array a b -> [(a,b)] -> Array a b</span>
<a name="line-41"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>accum</span> <span class='hs-comment'>-- :: (Ix a) => (b -> c -> b) -> Array a b -> [(a,c)] -> Array a b</span>
<a name="line-42"></a> <span class='hs-comment'>-- * Derived arrays</span>
<a name="line-43"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>ixmap</span> <span class='hs-comment'>-- :: (Ix a, Ix b) => (a,a) -> (a -> b) -> Array b c -> Array a b</span>
<a name="line-44"></a>
<a name="line-45"></a> <span class='hs-comment'>-- Array instances:</span>
<a name="line-46"></a> <span class='hs-comment'>--</span>
<a name="line-47"></a> <span class='hs-comment'>-- Ix a => Functor (Array a)</span>
<a name="line-48"></a> <span class='hs-comment'>-- (Ix a, Eq b) => Eq (Array a b)</span>
<a name="line-49"></a> <span class='hs-comment'>-- (Ix a, Ord b) => Ord (Array a b)</span>
<a name="line-50"></a> <span class='hs-comment'>-- (Ix a, Show a, Show b) => Show (Array a b)</span>
<a name="line-51"></a> <span class='hs-comment'>-- (Ix a, Read a, Read b) => Read (Array a b)</span>
<a name="line-52"></a> <span class='hs-comment'>-- </span>
<a name="line-53"></a>
<a name="line-54"></a> <span class='hs-comment'>-- Implementation checked wrt. Haskell 98 lib report, 1/99.</span>
<a name="line-55"></a>
<a name="line-56"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-57"></a>
<a name="line-58"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Ix</span>
<a name="line-59"></a>
<a name="line-60"></a><span class='hs-cpp'>#ifdef __GLASGOW_HASKELL__</span>
<a name="line-61"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Arr</span> <span class='hs-comment'>-- Most of the hard work is done here</span>
<a name="line-62"></a><span class='hs-cpp'>#endif</span>
<a name="line-63"></a>
<a name="line-64"></a><span class='hs-cpp'>#ifdef __HUGS__</span>
<a name="line-65"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Hugs</span><span class='hs-varop'>.</span><span class='hs-conid'>Array</span>
<a name="line-66"></a><span class='hs-cpp'>#endif</span>
<a name="line-67"></a>
<a name="line-68"></a><span class='hs-cpp'>#ifdef __NHC__</span>
<a name="line-69"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Array</span> <span class='hs-comment'>-- Haskell'98 arrays</span>
<a name="line-70"></a><span class='hs-cpp'>#endif</span>
<a name="line-71"></a>
<a name="line-72"></a><span class='hs-comment'>-- For instances:</span>
<a name="line-73"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-conid'>()</span>
<a name="line-74"></a>
<a name="line-75"></a><span class='hs-comment'>{- $intro
<a name="line-76"></a>Haskell provides indexable /arrays/, which may be thought of as functions
<a name="line-77"></a>whose domains are isomorphic to contiguous subsets of the integers.
<a name="line-78"></a>Functions restricted in this way can be implemented efficiently;
<a name="line-79"></a>in particular, a programmer may reasonably expect rapid access to
<a name="line-80"></a>the components. To ensure the possibility of such an implementation,
<a name="line-81"></a>arrays are treated as data, not as general functions.
<a name="line-82"></a>
<a name="line-83"></a>Since most array functions involve the class 'Ix', this module is exported
<a name="line-84"></a>from "Data.Array" so that modules need not import both "Data.Array" and
<a name="line-85"></a>"Data.Ix".
<a name="line-86"></a>-}</span>
<a name="line-87"></a>
</pre></body>
</html>
