<?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>GHC/IOArray.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_GHC -XNoImplicitPrelude -funbox-strict-fields #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# OPTIONS_HADDOCK hide #-}</span>
<a name="line-3"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : GHC.IOArray</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (c) The University of Glasgow 2008</span>
<a name="line-7"></a><span class='hs-comment'>-- License : see libraries/base/LICENSE</span>
<a name="line-8"></a><span class='hs-comment'>-- </span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer : cvs-ghc@haskell.org</span>
<a name="line-10"></a><span class='hs-comment'>-- Stability : internal</span>
<a name="line-11"></a><span class='hs-comment'>-- Portability : non-portable (GHC Extensions)</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- The IOArray type</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>IOArray</span> <span class='hs-layout'>(</span>
<a name="line-18"></a> <span class='hs-conid'>IOArray</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-varid'>newIOArray</span><span class='hs-layout'>,</span> <span class='hs-varid'>unsafeReadIOArray</span><span class='hs-layout'>,</span> <span class='hs-varid'>unsafeWriteIOArray</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-varid'>readIOArray</span><span class='hs-layout'>,</span> <span class='hs-varid'>writeIOArray</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>boundsIOArray</span>
<a name="line-22"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Arr</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='hs-comment'>-- ---------------------------------------------------------------------------</span>
<a name="line-29"></a><span class='hs-comment'>-- | An 'IOArray' is a mutable, boxed, non-strict array in the 'IO' monad. </span>
<a name="line-30"></a><span class='hs-comment'>-- The type arguments are as follows:</span>
<a name="line-31"></a><span class='hs-comment'>--</span>
<a name="line-32"></a><span class='hs-comment'>-- * @i@: the index type of the array (should be an instance of 'Ix')</span>
<a name="line-33"></a><span class='hs-comment'>--</span>
<a name="line-34"></a><span class='hs-comment'>-- * @e@: the element type of the array.</span>
<a name="line-35"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><span class='hs-comment'>-- </span>
<a name="line-37"></a>
<a name="line-38"></a><a name="IOArray"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>IOArray</span> <span class='hs-layout'>(</span><span class='hs-conid'>STArray</span> <span class='hs-conid'>RealWorld</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span>
<a name="line-39"></a>
<a name="line-40"></a><span class='hs-comment'>-- explicit instance because Haddock can't figure out a derived one</span>
<a name="line-41"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Eq</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-42"></a> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>y</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="newIOArray"></a><span class='hs-comment'>-- |Build a new 'IOArray'</span>
<a name="line-45"></a><span class='hs-definition'>newIOArray</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ix</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>i</span><span class='hs-layout'>,</span><span class='hs-varid'>i</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span>
<a name="line-46"></a><span class='hs-comment'>{-# INLINE newIOArray #-}</span>
<a name="line-47"></a><span class='hs-definition'>newIOArray</span> <span class='hs-varid'>lu</span> <span class='hs-varid'>initial</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stToIO</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span> <span class='hs-layout'>{</span><span class='hs-varid'>marr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newSTArray</span> <span class='hs-varid'>lu</span> <span class='hs-varid'>initial</span><span class='hs-layout'>;</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>marr</span><span class='hs-layout'>)</span><span class='hs-layout'>}</span>
<a name="line-48"></a>
<a name="line-49"></a><a name="unsafeReadIOArray"></a><span class='hs-comment'>-- | Read a value from an 'IOArray'</span>
<a name="line-50"></a><span class='hs-definition'>unsafeReadIOArray</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ix</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>e</span>
<a name="line-51"></a><span class='hs-comment'>{-# INLINE unsafeReadIOArray #-}</span>
<a name="line-52"></a><span class='hs-definition'>unsafeReadIOArray</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>marr</span><span class='hs-layout'>)</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stToIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>unsafeReadSTArray</span> <span class='hs-varid'>marr</span> <span class='hs-varid'>i</span><span class='hs-layout'>)</span>
<a name="line-53"></a>
<a name="line-54"></a><a name="unsafeWriteIOArray"></a><span class='hs-comment'>-- | Write a new value into an 'IOArray'</span>
<a name="line-55"></a><span class='hs-definition'>unsafeWriteIOArray</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ix</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-56"></a><span class='hs-comment'>{-# INLINE unsafeWriteIOArray #-}</span>
<a name="line-57"></a><span class='hs-definition'>unsafeWriteIOArray</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>marr</span><span class='hs-layout'>)</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stToIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>unsafeWriteSTArray</span> <span class='hs-varid'>marr</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span>
<a name="line-58"></a>
<a name="line-59"></a><a name="readIOArray"></a><span class='hs-comment'>-- | Read a value from an 'IOArray'</span>
<a name="line-60"></a><span class='hs-definition'>readIOArray</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ix</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>e</span>
<a name="line-61"></a><span class='hs-definition'>readIOArray</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>marr</span><span class='hs-layout'>)</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stToIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>readSTArray</span> <span class='hs-varid'>marr</span> <span class='hs-varid'>i</span><span class='hs-layout'>)</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="writeIOArray"></a><span class='hs-comment'>-- | Write a new value into an 'IOArray'</span>
<a name="line-64"></a><span class='hs-definition'>writeIOArray</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ix</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-65"></a><span class='hs-definition'>writeIOArray</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>marr</span><span class='hs-layout'>)</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stToIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>writeSTArray</span> <span class='hs-varid'>marr</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="boundsIOArray"></a><span class='hs-comment'>{-# INLINE boundsIOArray #-}</span>
<a name="line-68"></a><span class='hs-definition'>boundsIOArray</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IOArray</span> <span class='hs-varid'>i</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>i</span><span class='hs-layout'>,</span><span class='hs-varid'>i</span><span class='hs-layout'>)</span>
<a name="line-69"></a><span class='hs-definition'>boundsIOArray</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOArray</span> <span class='hs-varid'>marr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>boundsSTArray</span> <span class='hs-varid'>marr</span>
</pre></body>
</html>
