<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--Rendered using the Haskell Html Library v0.2--> <HTML ><HEAD ><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" ><TITLE >Data.Array.IO</TITLE ><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css" ><SCRIPT SRC="haddock-util.js" TYPE="text/javascript" ></SCRIPT ><SCRIPT TYPE="text/javascript" >window.onload = function () {setSynopsis("mini_Data-Array-IO.html")};</SCRIPT ></HEAD ><BODY ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="topbar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" " ></TD ><TD CLASS="title" >array-0.3.0.1: Mutable and immutable arrays</TD ><TD CLASS="topbut" ><A HREF="index.html" >Contents</A ></TD ><TD CLASS="topbut" ><A HREF="doc-index.html" >Index</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="modulebar" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD ><FONT SIZE="6" >Data.Array.IO</FONT ></TD ><TD ALIGN="right" ><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="infohead" >Portability</TD ><TD CLASS="infoval" >non-portable (uses Data.Array.MArray)</TD ></TR ><TR ><TD CLASS="infohead" >Stability</TD ><TD CLASS="infoval" >experimental</TD ></TR ><TR ><TD CLASS="infohead" >Maintainer</TD ><TD CLASS="infoval" >libraries@haskell.org</TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="section4" ><B >Contents</B ></TD ></TR ><TR ><TD ><DL ><DT ><A HREF="#1" ><TT >IO</TT > arrays with boxed elements </A ></DT ><DT ><A HREF="#2" ><TT >IO</TT > arrays with unboxed elements </A ></DT ><DT ><A HREF="#3" >Overloaded mutable array interface </A ></DT ><DT ><A HREF="#4" >Doing I/O with <TT >IOUArray</TT >s </A ></DT ></DL ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Description</TD ></TR ><TR ><TD CLASS="doc" >Mutable boxed and unboxed arrays in the IO monad. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Synopsis</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >data</SPAN > <A HREF="#t%3AIOArray" >IOArray</A > i e</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >data</SPAN > <A HREF="#t%3AIOUArray" >IOUArray</A > i e</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AcastIOUArray" >castIOUArray</A > :: <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > ix a -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > (<A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > ix b)</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" >module <A HREF="Data-Array-MArray.html" >Data.Array.MArray</A ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AhGetArray" >hGetArray</A > :: <A HREF="../base-4.2.0.2/GHC-IO-Handle.html#t%3AHandle" >Handle</A > -> <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A > -> <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AhPutArray" >hPutArray</A > :: <A HREF="../base-4.2.0.2/GHC-IO-Handle.html#t%3AHandle" >Handle</A > -> <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A > -> <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="1" ><A NAME="1" ><TT >IO</TT > arrays with boxed elements </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >data</SPAN > <A NAME="t:IOArray" ><A NAME="t%3AIOArray" ></A ></A ><B >IOArray</B > i e </TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="ndoc" ><P >An <TT ><A HREF="Data-Array-IO.html#t%3AIOArray" >IOArray</A ></TT > is a mutable, boxed, non-strict array in the <TT ><A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TT > monad. The type arguments are as follows: </P ><UL ><LI > <TT >i</TT >: the index type of the array (should be an instance of <TT ><A HREF="../base-4.2.0.2/Data-Ix.html#t%3AIx" >Ix</A ></TT >) </LI ><LI > <TT >e</TT >: the element type of the array. </LI ></UL ></TD ></TR ><TR ><TD CLASS="section4" ><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:IOArray')" ALT="show/hide" > Instances</TD ></TR ><TR ><TD CLASS="body" ><DIV ID="i:IOArray" STYLE="display:block;" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="../base-4.2.0.2/Data-Typeable.html#t%3ATypeable2" >Typeable2</A > <A HREF="Data-Array-IO.html#t%3AIOArray" >IOArray</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOArray" >IOArray</A > e <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="../base-4.2.0.2/Data-Eq.html#t%3AEq" >Eq</A > (<A HREF="Data-Array-IO.html#t%3AIOArray" >IOArray</A > i e)</TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="2" ><A NAME="2" ><TT >IO</TT > arrays with unboxed elements </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >data</SPAN > <A NAME="t:IOUArray" ><A NAME="t%3AIOUArray" ></A ></A ><B >IOUArray</B > i e </TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="ndoc" ><P >Mutable, unboxed, strict arrays in the <TT ><A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TT > monad. The type arguments are as follows: </P ><UL ><LI > <TT >i</TT >: the index type of the array (should be an instance of <TT ><A HREF="../base-4.2.0.2/Data-Ix.html#t%3AIx" >Ix</A ></TT >) </LI ><LI > <TT >e</TT >: the element type of the array. Only certain element types are supported: see <A HREF="Data-Array-MArray.html" >Data.Array.MArray</A > for a list of instances. </LI ></UL ></TD ></TR ><TR ><TD CLASS="section4" ><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:IOUArray')" ALT="show/hide" > Instances</TD ></TR ><TR ><TD CLASS="body" ><DIV ID="i:IOUArray" STYLE="display:block;" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="../base-4.2.0.2/Data-Typeable.html#t%3ATypeable2" >Typeable2</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Bool.html#t%3ABool" >Bool</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AChar" >Char</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Prelude.html#t%3ADouble" >Double</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Prelude.html#t%3AFloat" >Float</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt8" >Int8</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt16" >Int16</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt32" >Int32</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt64" >Int64</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord" >Word</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord16" >Word16</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord32" >Word32</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord64" >Word64</A > <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > (<A HREF="../base-4.2.0.2/Foreign-StablePtr.html#t%3AStablePtr" >StablePtr</A > a) <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > (<A HREF="../base-4.2.0.2/Foreign-Ptr.html#t%3APtr" >Ptr</A > a) <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-Array-MArray.html#t%3AMArray" >MArray</A > <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > (<A HREF="../base-4.2.0.2/Foreign-Ptr.html#t%3AFunPtr" >FunPtr</A > a) <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="../base-4.2.0.2/Data-Eq.html#t%3AEq" >Eq</A > (<A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > i e)</TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:castIOUArray" ><A NAME="v%3AcastIOUArray" ></A ></A ><B >castIOUArray</B > :: <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > ix a -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > (<A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > ix b)</TD ></TR ><TR ><TD CLASS="doc" >Casts an <TT ><A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A ></TT > with one element type into one with a different element type. All the elements of the resulting array are undefined (unless you know what you're doing...). </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="3" ><A NAME="3" >Overloaded mutable array interface </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" >module <A HREF="Data-Array-MArray.html" >Data.Array.MArray</A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" ><A NAME="4" ><A NAME="4" >Doing I/O with <TT >IOUArray</TT >s </A ></A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:hGetArray" ><A NAME="v%3AhGetArray" ></A ></A ><B >hGetArray</B ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="arg" >:: <A HREF="../base-4.2.0.2/GHC-IO-Handle.html#t%3AHandle" >Handle</A ></TD ><TD CLASS="rdoc" >Handle to read from </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A ></TD ><TD CLASS="rdoc" >Array in which to place the values </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A ></TD ><TD CLASS="rdoc" >Number of <TT ><A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A ></TT >s to read </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A ></TD ><TD CLASS="rdoc" >Returns: the number of <TT ><A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A ></TT >s actually read, which might be smaller than the number requested if the end of file was reached. </TD ></TR ><TR ><TD CLASS="ndoc" COLSPAN="2" >Reads a number of <TT ><A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A ></TT >s from the specified <TT ><A HREF="../base-4.2.0.2/GHC-IO-Handle.html#t%3AHandle" >Handle</A ></TT > directly into an array. </TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:hPutArray" ><A NAME="v%3AhPutArray" ></A ></A ><B >hPutArray</B ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="arg" >:: <A HREF="../base-4.2.0.2/GHC-IO-Handle.html#t%3AHandle" >Handle</A ></TD ><TD CLASS="rdoc" >Handle to write to </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="Data-Array-IO.html#t%3AIOUArray" >IOUArray</A > <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A > <A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A ></TD ><TD CLASS="rdoc" >Array to write from </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/Data-Int.html#t%3AInt" >Int</A ></TD ><TD CLASS="rdoc" >Number of <TT ><A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A ></TT >s to write </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="ndoc" COLSPAN="2" >Writes an array of <TT ><A HREF="../base-4.2.0.2/Data-Word.html#t%3AWord8" >Word8</A ></TT > to the specified <TT ><A HREF="../base-4.2.0.2/GHC-IO-Handle.html#t%3AHandle" >Handle</A ></TT >. </TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="botbar" >Produced by <A HREF="http://www.haskell.org/haddock/" >Haddock</A > version 2.6.1</TD ></TR ></TABLE ></BODY ></HTML >