<?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://code.haskell.org/~malcolm/hscolour/ -->
<title>Data/Vector/Generic/Safe.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-cpp'>#</span><span class='hs-keyword'>if</span> <span class='hs-sel'>__GLASGOW_HASKELL__</span> <span class='hs-varop'>>=</span> <span class='hs-num'>701</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>defined</span><span class='hs-layout'>(</span><span class='hs-conid'>VECTOR_BOUNDS_CHECKS</span><span class='hs-layout'>)</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE Trustworthy #-}</span>
<a name="line-3"></a><span class='hs-cpp'>#endif</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : Data.Vector.Generic.Safe</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (c) Roman Leshchinskiy 2008-2010</span>
<a name="line-7"></a><span class='hs-comment'>-- License : BSD-style</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer : Roman Leshchinskiy <rl@cse.unsw.edu.au></span>
<a name="line-10"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-11"></a><span class='hs-comment'>-- Portability : non-portable</span>
<a name="line-12"></a><span class='hs-comment'>-- </span>
<a name="line-13"></a><span class='hs-comment'>-- Safe interface to "Data.Vector.Generic"</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a>
<a name="line-16"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Vector</span><span class='hs-varop'>.</span><span class='hs-conid'>Generic</span><span class='hs-varop'>.</span><span class='hs-conid'>Safe</span> <span class='hs-layout'>(</span>
<a name="line-17"></a> <span class='hs-comment'>-- * Immutable vectors</span>
<a name="line-18"></a> <span class='hs-conid'>Vector</span><span class='hs-layout'>,</span> <span class='hs-conid'>Mutable</span><span class='hs-layout'>,</span>
<a name="line-19"></a>
<a name="line-20"></a> <span class='hs-comment'>-- * Accessors</span>
<a name="line-21"></a>
<a name="line-22"></a> <span class='hs-comment'>-- ** Length information</span>
<a name="line-23"></a> <span class='hs-varid'>length</span><span class='hs-layout'>,</span> <span class='hs-varid'>null</span><span class='hs-layout'>,</span>
<a name="line-24"></a>
<a name="line-25"></a> <span class='hs-comment'>-- ** Indexing</span>
<a name="line-26"></a> <span class='hs-layout'>(</span><span class='hs-varop'>!</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>!?</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>head</span><span class='hs-layout'>,</span> <span class='hs-varid'>last</span><span class='hs-layout'>,</span>
<a name="line-27"></a>
<a name="line-28"></a> <span class='hs-comment'>-- ** Monadic indexing</span>
<a name="line-29"></a> <span class='hs-varid'>indexM</span><span class='hs-layout'>,</span> <span class='hs-varid'>headM</span><span class='hs-layout'>,</span> <span class='hs-varid'>lastM</span><span class='hs-layout'>,</span>
<a name="line-30"></a>
<a name="line-31"></a> <span class='hs-comment'>-- ** Extracting subvectors (slicing)</span>
<a name="line-32"></a> <span class='hs-varid'>slice</span><span class='hs-layout'>,</span> <span class='hs-varid'>init</span><span class='hs-layout'>,</span> <span class='hs-varid'>tail</span><span class='hs-layout'>,</span> <span class='hs-varid'>take</span><span class='hs-layout'>,</span> <span class='hs-varid'>drop</span><span class='hs-layout'>,</span> <span class='hs-varid'>splitAt</span><span class='hs-layout'>,</span>
<a name="line-33"></a>
<a name="line-34"></a> <span class='hs-comment'>-- * Construction</span>
<a name="line-35"></a>
<a name="line-36"></a> <span class='hs-comment'>-- ** Initialisation</span>
<a name="line-37"></a> <span class='hs-varid'>empty</span><span class='hs-layout'>,</span> <span class='hs-varid'>singleton</span><span class='hs-layout'>,</span> <span class='hs-varid'>replicate</span><span class='hs-layout'>,</span> <span class='hs-varid'>generate</span><span class='hs-layout'>,</span> <span class='hs-varid'>iterateN</span><span class='hs-layout'>,</span>
<a name="line-38"></a>
<a name="line-39"></a> <span class='hs-comment'>-- ** Monadic initialisation</span>
<a name="line-40"></a> <span class='hs-varid'>replicateM</span><span class='hs-layout'>,</span> <span class='hs-varid'>generateM</span><span class='hs-layout'>,</span> <span class='hs-varid'>create</span><span class='hs-layout'>,</span>
<a name="line-41"></a>
<a name="line-42"></a> <span class='hs-comment'>-- ** Unfolding</span>
<a name="line-43"></a> <span class='hs-varid'>unfoldr</span><span class='hs-layout'>,</span> <span class='hs-varid'>unfoldrN</span><span class='hs-layout'>,</span>
<a name="line-44"></a>
<a name="line-45"></a> <span class='hs-comment'>-- ** Enumeration</span>
<a name="line-46"></a> <span class='hs-varid'>enumFromN</span><span class='hs-layout'>,</span> <span class='hs-varid'>enumFromStepN</span><span class='hs-layout'>,</span> <span class='hs-varid'>enumFromTo</span><span class='hs-layout'>,</span> <span class='hs-varid'>enumFromThenTo</span><span class='hs-layout'>,</span>
<a name="line-47"></a>
<a name="line-48"></a> <span class='hs-comment'>-- ** Concatenation</span>
<a name="line-49"></a> <span class='hs-varid'>cons</span><span class='hs-layout'>,</span> <span class='hs-varid'>snoc</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>++</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>concat</span><span class='hs-layout'>,</span>
<a name="line-50"></a>
<a name="line-51"></a> <span class='hs-comment'>-- ** Restricting memory usage</span>
<a name="line-52"></a> <span class='hs-varid'>force</span><span class='hs-layout'>,</span>
<a name="line-53"></a>
<a name="line-54"></a> <span class='hs-comment'>-- * Modifying vectors</span>
<a name="line-55"></a>
<a name="line-56"></a> <span class='hs-comment'>-- ** Bulk updates</span>
<a name="line-57"></a> <span class='hs-layout'>(</span><span class='hs-varop'>//</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>update</span><span class='hs-layout'>,</span> <span class='hs-varid'>update_</span><span class='hs-layout'>,</span>
<a name="line-58"></a>
<a name="line-59"></a> <span class='hs-comment'>-- ** Accumulations</span>
<a name="line-60"></a> <span class='hs-varid'>accum</span><span class='hs-layout'>,</span> <span class='hs-varid'>accumulate</span><span class='hs-layout'>,</span> <span class='hs-varid'>accumulate_</span><span class='hs-layout'>,</span>
<a name="line-61"></a>
<a name="line-62"></a> <span class='hs-comment'>-- ** Permutations </span>
<a name="line-63"></a> <span class='hs-varid'>reverse</span><span class='hs-layout'>,</span> <span class='hs-varid'>backpermute</span><span class='hs-layout'>,</span>
<a name="line-64"></a>
<a name="line-65"></a> <span class='hs-comment'>-- ** Safe destructive updates</span>
<a name="line-66"></a> <span class='hs-varid'>modify</span><span class='hs-layout'>,</span>
<a name="line-67"></a>
<a name="line-68"></a> <span class='hs-comment'>-- * Elementwise operations</span>
<a name="line-69"></a>
<a name="line-70"></a> <span class='hs-comment'>-- ** Indexing</span>
<a name="line-71"></a> <span class='hs-varid'>indexed</span><span class='hs-layout'>,</span>
<a name="line-72"></a>
<a name="line-73"></a> <span class='hs-comment'>-- ** Mapping</span>
<a name="line-74"></a> <span class='hs-varid'>map</span><span class='hs-layout'>,</span> <span class='hs-varid'>imap</span><span class='hs-layout'>,</span> <span class='hs-varid'>concatMap</span><span class='hs-layout'>,</span>
<a name="line-75"></a>
<a name="line-76"></a> <span class='hs-comment'>-- ** Monadic mapping</span>
<a name="line-77"></a> <span class='hs-varid'>mapM</span><span class='hs-layout'>,</span> <span class='hs-varid'>mapM_</span><span class='hs-layout'>,</span> <span class='hs-varid'>forM</span><span class='hs-layout'>,</span> <span class='hs-varid'>forM_</span><span class='hs-layout'>,</span>
<a name="line-78"></a>
<a name="line-79"></a> <span class='hs-comment'>-- ** Zipping</span>
<a name="line-80"></a> <span class='hs-varid'>zipWith</span><span class='hs-layout'>,</span> <span class='hs-varid'>zipWith3</span><span class='hs-layout'>,</span> <span class='hs-varid'>zipWith4</span><span class='hs-layout'>,</span> <span class='hs-varid'>zipWith5</span><span class='hs-layout'>,</span> <span class='hs-varid'>zipWith6</span><span class='hs-layout'>,</span>
<a name="line-81"></a> <span class='hs-varid'>izipWith</span><span class='hs-layout'>,</span> <span class='hs-varid'>izipWith3</span><span class='hs-layout'>,</span> <span class='hs-varid'>izipWith4</span><span class='hs-layout'>,</span> <span class='hs-varid'>izipWith5</span><span class='hs-layout'>,</span> <span class='hs-varid'>izipWith6</span><span class='hs-layout'>,</span>
<a name="line-82"></a> <span class='hs-varid'>zip</span><span class='hs-layout'>,</span> <span class='hs-varid'>zip3</span><span class='hs-layout'>,</span> <span class='hs-varid'>zip4</span><span class='hs-layout'>,</span> <span class='hs-varid'>zip5</span><span class='hs-layout'>,</span> <span class='hs-varid'>zip6</span><span class='hs-layout'>,</span>
<a name="line-83"></a>
<a name="line-84"></a> <span class='hs-comment'>-- ** Monadic zipping</span>
<a name="line-85"></a> <span class='hs-varid'>zipWithM</span><span class='hs-layout'>,</span> <span class='hs-varid'>zipWithM_</span><span class='hs-layout'>,</span>
<a name="line-86"></a>
<a name="line-87"></a> <span class='hs-comment'>-- ** Unzipping</span>
<a name="line-88"></a> <span class='hs-varid'>unzip</span><span class='hs-layout'>,</span> <span class='hs-varid'>unzip3</span><span class='hs-layout'>,</span> <span class='hs-varid'>unzip4</span><span class='hs-layout'>,</span> <span class='hs-varid'>unzip5</span><span class='hs-layout'>,</span> <span class='hs-varid'>unzip6</span><span class='hs-layout'>,</span>
<a name="line-89"></a>
<a name="line-90"></a> <span class='hs-comment'>-- * Working with predicates</span>
<a name="line-91"></a>
<a name="line-92"></a> <span class='hs-comment'>-- ** Filtering</span>
<a name="line-93"></a> <span class='hs-varid'>filter</span><span class='hs-layout'>,</span> <span class='hs-varid'>ifilter</span><span class='hs-layout'>,</span> <span class='hs-varid'>filterM</span><span class='hs-layout'>,</span>
<a name="line-94"></a> <span class='hs-varid'>takeWhile</span><span class='hs-layout'>,</span> <span class='hs-varid'>dropWhile</span><span class='hs-layout'>,</span>
<a name="line-95"></a>
<a name="line-96"></a> <span class='hs-comment'>-- ** Partitioning</span>
<a name="line-97"></a> <span class='hs-varid'>partition</span><span class='hs-layout'>,</span> <span class='hs-varid'>unstablePartition</span><span class='hs-layout'>,</span> <span class='hs-varid'>span</span><span class='hs-layout'>,</span> <span class='hs-varid'>break</span><span class='hs-layout'>,</span>
<a name="line-98"></a>
<a name="line-99"></a> <span class='hs-comment'>-- ** Searching</span>
<a name="line-100"></a> <span class='hs-varid'>elem</span><span class='hs-layout'>,</span> <span class='hs-varid'>notElem</span><span class='hs-layout'>,</span> <span class='hs-varid'>find</span><span class='hs-layout'>,</span> <span class='hs-varid'>findIndex</span><span class='hs-layout'>,</span> <span class='hs-varid'>findIndices</span><span class='hs-layout'>,</span> <span class='hs-varid'>elemIndex</span><span class='hs-layout'>,</span> <span class='hs-varid'>elemIndices</span><span class='hs-layout'>,</span>
<a name="line-101"></a>
<a name="line-102"></a> <span class='hs-comment'>-- * Folding</span>
<a name="line-103"></a> <span class='hs-varid'>foldl</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldl1</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldl'</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldl1'</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldr</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldr1</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldr'</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldr1'</span><span class='hs-layout'>,</span>
<a name="line-104"></a> <span class='hs-varid'>ifoldl</span><span class='hs-layout'>,</span> <span class='hs-varid'>ifoldl'</span><span class='hs-layout'>,</span> <span class='hs-varid'>ifoldr</span><span class='hs-layout'>,</span> <span class='hs-varid'>ifoldr'</span><span class='hs-layout'>,</span>
<a name="line-105"></a>
<a name="line-106"></a> <span class='hs-comment'>-- ** Specialised folds</span>
<a name="line-107"></a> <span class='hs-varid'>all</span><span class='hs-layout'>,</span> <span class='hs-varid'>any</span><span class='hs-layout'>,</span> <span class='hs-varid'>and</span><span class='hs-layout'>,</span> <span class='hs-varid'>or</span><span class='hs-layout'>,</span>
<a name="line-108"></a> <span class='hs-varid'>sum</span><span class='hs-layout'>,</span> <span class='hs-varid'>product</span><span class='hs-layout'>,</span>
<a name="line-109"></a> <span class='hs-varid'>maximum</span><span class='hs-layout'>,</span> <span class='hs-varid'>maximumBy</span><span class='hs-layout'>,</span> <span class='hs-varid'>minimum</span><span class='hs-layout'>,</span> <span class='hs-varid'>minimumBy</span><span class='hs-layout'>,</span>
<a name="line-110"></a> <span class='hs-varid'>minIndex</span><span class='hs-layout'>,</span> <span class='hs-varid'>minIndexBy</span><span class='hs-layout'>,</span> <span class='hs-varid'>maxIndex</span><span class='hs-layout'>,</span> <span class='hs-varid'>maxIndexBy</span><span class='hs-layout'>,</span>
<a name="line-111"></a>
<a name="line-112"></a> <span class='hs-comment'>-- ** Monadic folds</span>
<a name="line-113"></a> <span class='hs-varid'>foldM</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldM'</span><span class='hs-layout'>,</span> <span class='hs-varid'>fold1M</span><span class='hs-layout'>,</span> <span class='hs-varid'>fold1M'</span><span class='hs-layout'>,</span>
<a name="line-114"></a> <span class='hs-varid'>foldM_</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldM'_</span><span class='hs-layout'>,</span> <span class='hs-varid'>fold1M_</span><span class='hs-layout'>,</span> <span class='hs-varid'>fold1M'_</span><span class='hs-layout'>,</span>
<a name="line-115"></a>
<a name="line-116"></a> <span class='hs-comment'>-- ** Monadic sequencing</span>
<a name="line-117"></a> <span class='hs-varid'>sequence</span><span class='hs-layout'>,</span> <span class='hs-varid'>sequence_</span><span class='hs-layout'>,</span>
<a name="line-118"></a>
<a name="line-119"></a> <span class='hs-comment'>-- * Prefix sums (scans)</span>
<a name="line-120"></a> <span class='hs-varid'>prescanl</span><span class='hs-layout'>,</span> <span class='hs-varid'>prescanl'</span><span class='hs-layout'>,</span>
<a name="line-121"></a> <span class='hs-varid'>postscanl</span><span class='hs-layout'>,</span> <span class='hs-varid'>postscanl'</span><span class='hs-layout'>,</span>
<a name="line-122"></a> <span class='hs-varid'>scanl</span><span class='hs-layout'>,</span> <span class='hs-varid'>scanl'</span><span class='hs-layout'>,</span> <span class='hs-varid'>scanl1</span><span class='hs-layout'>,</span> <span class='hs-varid'>scanl1'</span><span class='hs-layout'>,</span>
<a name="line-123"></a> <span class='hs-varid'>prescanr</span><span class='hs-layout'>,</span> <span class='hs-varid'>prescanr'</span><span class='hs-layout'>,</span>
<a name="line-124"></a> <span class='hs-varid'>postscanr</span><span class='hs-layout'>,</span> <span class='hs-varid'>postscanr'</span><span class='hs-layout'>,</span>
<a name="line-125"></a> <span class='hs-varid'>scanr</span><span class='hs-layout'>,</span> <span class='hs-varid'>scanr'</span><span class='hs-layout'>,</span> <span class='hs-varid'>scanr1</span><span class='hs-layout'>,</span> <span class='hs-varid'>scanr1'</span><span class='hs-layout'>,</span>
<a name="line-126"></a>
<a name="line-127"></a> <span class='hs-comment'>-- * Conversions</span>
<a name="line-128"></a>
<a name="line-129"></a> <span class='hs-comment'>-- ** Lists</span>
<a name="line-130"></a> <span class='hs-varid'>toList</span><span class='hs-layout'>,</span> <span class='hs-varid'>fromList</span><span class='hs-layout'>,</span> <span class='hs-varid'>fromListN</span><span class='hs-layout'>,</span>
<a name="line-131"></a>
<a name="line-132"></a> <span class='hs-comment'>-- ** Different vector types</span>
<a name="line-133"></a> <span class='hs-varid'>convert</span><span class='hs-layout'>,</span>
<a name="line-134"></a>
<a name="line-135"></a> <span class='hs-comment'>-- ** Mutable vectors</span>
<a name="line-136"></a> <span class='hs-varid'>freeze</span><span class='hs-layout'>,</span> <span class='hs-varid'>thaw</span><span class='hs-layout'>,</span> <span class='hs-varid'>copy</span><span class='hs-layout'>,</span>
<a name="line-137"></a>
<a name="line-138"></a> <span class='hs-comment'>-- * Fusion support</span>
<a name="line-139"></a>
<a name="line-140"></a> <span class='hs-comment'>-- ** Conversion to/from Streams</span>
<a name="line-141"></a> <span class='hs-varid'>stream</span><span class='hs-layout'>,</span> <span class='hs-varid'>unstream</span><span class='hs-layout'>,</span> <span class='hs-varid'>streamR</span><span class='hs-layout'>,</span> <span class='hs-varid'>unstreamR</span><span class='hs-layout'>,</span>
<a name="line-142"></a>
<a name="line-143"></a> <span class='hs-comment'>-- ** Recycling support</span>
<a name="line-144"></a> <span class='hs-varid'>new</span><span class='hs-layout'>,</span> <span class='hs-varid'>clone</span><span class='hs-layout'>,</span>
<a name="line-145"></a>
<a name="line-146"></a> <span class='hs-comment'>-- * Utilities</span>
<a name="line-147"></a>
<a name="line-148"></a> <span class='hs-comment'>-- ** Comparisons</span>
<a name="line-149"></a> <span class='hs-varid'>eq</span><span class='hs-layout'>,</span> <span class='hs-varid'>cmp</span><span class='hs-layout'>,</span>
<a name="line-150"></a>
<a name="line-151"></a> <span class='hs-comment'>-- ** @Data@ and @Typeable@</span>
<a name="line-152"></a> <span class='hs-varid'>gfoldl</span><span class='hs-layout'>,</span> <span class='hs-varid'>dataCast</span><span class='hs-layout'>,</span> <span class='hs-varid'>mkType</span>
<a name="line-153"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-154"></a>
<a name="line-155"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Vector</span><span class='hs-varop'>.</span><span class='hs-conid'>Generic</span>
<a name="line-156"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Prelude</span> <span class='hs-conid'>()</span>
<a name="line-157"></a>
</pre></body>
</html>
