/usr/share/doc/libghc-vector-doc/html/src/Data-Vector-Generic-Base.html is in libghc-vector-doc 0.11.0.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | <?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/Base.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE Rank2Types, MultiParamTypeClasses, FlexibleContexts,
<a name="line-2"></a> TypeFamilies, ScopedTypeVariables, BangPatterns #-}</span>
<a name="line-3"></a><span class='hs-comment'>{-# OPTIONS_HADDOCK hide #-}</span>
<a name="line-4"></a>
<a name="line-5"></a><span class='hs-comment'>-- |</span>
<a name="line-6"></a><span class='hs-comment'>-- Module : Data.Vector.Generic.Base</span>
<a name="line-7"></a><span class='hs-comment'>-- Copyright : (c) Roman Leshchinskiy 2008-2010</span>
<a name="line-8"></a><span class='hs-comment'>-- License : BSD-style</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- Maintainer : Roman Leshchinskiy <rl@cse.unsw.edu.au></span>
<a name="line-11"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-12"></a><span class='hs-comment'>-- Portability : non-portable</span>
<a name="line-13"></a><span class='hs-comment'>--</span>
<a name="line-14"></a><span class='hs-comment'>-- Class of pure vectors</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'>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'>Base</span> <span class='hs-layout'>(</span>
<a name="line-18"></a> <span class='hs-conid'>Vector</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Mutable</span>
<a name="line-19"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-20"></a>
<a name="line-21"></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><span class='hs-varop'>.</span><span class='hs-conid'>Mutable</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span> <span class='hs-layout'>(</span> <span class='hs-conid'>MVector</span> <span class='hs-layout'>)</span>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</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'>Mutable</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>M</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Primitive</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-comment'>-- | @Mutable v s a@ is the mutable version of the pure vector type @v a@ with</span>
<a name="line-27"></a><span class='hs-comment'>-- the state token @s@</span>
<a name="line-28"></a><span class='hs-comment'>--</span>
<a name="line-29"></a><span class='hs-keyword'>type</span> <span class='hs-varid'>family</span> <span class='hs-conid'>Mutable</span> <span class='hs-layout'>(</span><span class='hs-varid'>v</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>*</span> <span class='hs-keyglyph'>-></span> <span class='hs-varop'>*</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>*</span> <span class='hs-keyglyph'>-></span> <span class='hs-varop'>*</span> <span class='hs-keyglyph'>-></span> <span class='hs-varop'>*</span>
<a name="line-30"></a>
<a name="line-31"></a><a name="Vector"></a><span class='hs-comment'>-- | Class of immutable vectors. Every immutable vector is associated with its</span>
<a name="line-32"></a><a name="Vector"></a><span class='hs-comment'>-- mutable version through the 'Mutable' type family. Methods of this class</span>
<a name="line-33"></a><a name="Vector"></a><span class='hs-comment'>-- should not be used directly. Instead, "Data.Vector.Generic" and other</span>
<a name="line-34"></a><a name="Vector"></a><span class='hs-comment'>-- Data.Vector modules provide safe and fusible wrappers.</span>
<a name="line-35"></a><a name="Vector"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><a name="Vector"></a><span class='hs-comment'>-- Minimum complete implementation:</span>
<a name="line-37"></a><a name="Vector"></a><span class='hs-comment'>--</span>
<a name="line-38"></a><a name="Vector"></a><span class='hs-comment'>-- * 'basicUnsafeFreeze'</span>
<a name="line-39"></a><a name="Vector"></a><span class='hs-comment'>--</span>
<a name="line-40"></a><a name="Vector"></a><span class='hs-comment'>-- * 'basicUnsafeThaw'</span>
<a name="line-41"></a><a name="Vector"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><a name="Vector"></a><span class='hs-comment'>-- * 'basicLength'</span>
<a name="line-43"></a><a name="Vector"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><a name="Vector"></a><span class='hs-comment'>-- * 'basicUnsafeSlice'</span>
<a name="line-45"></a><a name="Vector"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><a name="Vector"></a><span class='hs-comment'>-- * 'basicUnsafeIndexM'</span>
<a name="line-47"></a><a name="Vector"></a><span class='hs-comment'>--</span>
<a name="line-48"></a><a name="Vector"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>MVector</span> <span class='hs-layout'>(</span><span class='hs-conid'>Mutable</span> <span class='hs-varid'>v</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Vector</span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>where</span>
<a name="line-49"></a> <span class='hs-comment'>-- | /Assumed complexity: O(1)/</span>
<a name="line-50"></a> <span class='hs-comment'>--</span>
<a name="line-51"></a> <span class='hs-comment'>-- Unsafely convert a mutable vector to its immutable version</span>
<a name="line-52"></a> <span class='hs-comment'>-- without copying. The mutable vector may not be used after</span>
<a name="line-53"></a> <span class='hs-comment'>-- this operation.</span>
<a name="line-54"></a> <span class='hs-varid'>basicUnsafeFreeze</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Mutable</span> <span class='hs-varid'>v</span> <span class='hs-layout'>(</span><span class='hs-conid'>PrimState</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-varid'>v</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-55"></a>
<a name="line-56"></a> <span class='hs-comment'>-- | /Assumed complexity: O(1)/</span>
<a name="line-57"></a> <span class='hs-comment'>--</span>
<a name="line-58"></a> <span class='hs-comment'>-- Unsafely convert an immutable vector to its mutable version without</span>
<a name="line-59"></a> <span class='hs-comment'>-- copying. The immutable vector may not be used after this operation.</span>
<a name="line-60"></a> <span class='hs-varid'>basicUnsafeThaw</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Mutable</span> <span class='hs-varid'>v</span> <span class='hs-layout'>(</span><span class='hs-conid'>PrimState</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-61"></a>
<a name="line-62"></a> <span class='hs-comment'>-- | /Assumed complexity: O(1)/</span>
<a name="line-63"></a> <span class='hs-comment'>--</span>
<a name="line-64"></a> <span class='hs-comment'>-- Yield the length of the vector.</span>
<a name="line-65"></a> <span class='hs-varid'>basicLength</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span>
<a name="line-66"></a>
<a name="line-67"></a> <span class='hs-comment'>-- | /Assumed complexity: O(1)/</span>
<a name="line-68"></a> <span class='hs-comment'>--</span>
<a name="line-69"></a> <span class='hs-comment'>-- Yield a slice of the vector without copying it. No range checks are</span>
<a name="line-70"></a> <span class='hs-comment'>-- performed.</span>
<a name="line-71"></a> <span class='hs-varid'>basicUnsafeSlice</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ starting index</span>
<a name="line-72"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ length</span>
<a name="line-73"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span>
<a name="line-74"></a>
<a name="line-75"></a> <span class='hs-comment'>-- | /Assumed complexity: O(1)/</span>
<a name="line-76"></a> <span class='hs-comment'>--</span>
<a name="line-77"></a> <span class='hs-comment'>-- Yield the element at the given position in a monad. No range checks are</span>
<a name="line-78"></a> <span class='hs-comment'>-- performed.</span>
<a name="line-79"></a> <span class='hs-comment'>--</span>
<a name="line-80"></a> <span class='hs-comment'>-- The monad allows us to be strict in the vector if we want. Suppose we had</span>
<a name="line-81"></a> <span class='hs-comment'>--</span>
<a name="line-82"></a> <span class='hs-comment'>-- > unsafeIndex :: v a -> Int -> a</span>
<a name="line-83"></a> <span class='hs-comment'>--</span>
<a name="line-84"></a> <span class='hs-comment'>-- instead. Now, if we wanted to copy a vector, we'd do something like</span>
<a name="line-85"></a> <span class='hs-comment'>--</span>
<a name="line-86"></a> <span class='hs-comment'>-- > copy mv v ... = ... unsafeWrite mv i (unsafeIndex v i) ...</span>
<a name="line-87"></a> <span class='hs-comment'>--</span>
<a name="line-88"></a> <span class='hs-comment'>-- For lazy vectors, the indexing would not be evaluated which means that we</span>
<a name="line-89"></a> <span class='hs-comment'>-- would retain a reference to the original vector in each element we write.</span>
<a name="line-90"></a> <span class='hs-comment'>-- This is not what we want!</span>
<a name="line-91"></a> <span class='hs-comment'>--</span>
<a name="line-92"></a> <span class='hs-comment'>-- With 'basicUnsafeIndexM', we can do</span>
<a name="line-93"></a> <span class='hs-comment'>--</span>
<a name="line-94"></a> <span class='hs-comment'>-- > copy mv v ... = ... case basicUnsafeIndexM v i of</span>
<a name="line-95"></a> <span class='hs-comment'>-- > Box x -> unsafeWrite mv i x ...</span>
<a name="line-96"></a> <span class='hs-comment'>--</span>
<a name="line-97"></a> <span class='hs-comment'>-- which does not have this problem because indexing (but not the returned</span>
<a name="line-98"></a> <span class='hs-comment'>-- element!) is evaluated immediately.</span>
<a name="line-99"></a> <span class='hs-comment'>--</span>
<a name="line-100"></a> <span class='hs-varid'>basicUnsafeIndexM</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-101"></a>
<a name="line-102"></a> <span class='hs-comment'>-- | /Assumed complexity: O(n)/</span>
<a name="line-103"></a> <span class='hs-comment'>--</span>
<a name="line-104"></a> <span class='hs-comment'>-- Copy an immutable vector into a mutable one. The two vectors must have</span>
<a name="line-105"></a> <span class='hs-comment'>-- the same length but this is not checked.</span>
<a name="line-106"></a> <span class='hs-comment'>--</span>
<a name="line-107"></a> <span class='hs-comment'>-- Instances of 'Vector' should redefine this method if they wish to support</span>
<a name="line-108"></a> <span class='hs-comment'>-- an efficient block copy operation.</span>
<a name="line-109"></a> <span class='hs-comment'>--</span>
<a name="line-110"></a> <span class='hs-comment'>-- Default definition: copying basic on 'basicUnsafeIndexM' and</span>
<a name="line-111"></a> <span class='hs-comment'>-- 'basicUnsafeWrite'.</span>
<a name="line-112"></a> <span class='hs-varid'>basicUnsafeCopy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Mutable</span> <span class='hs-varid'>v</span> <span class='hs-layout'>(</span><span class='hs-conid'>PrimState</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-113"></a>
<a name="line-114"></a> <span class='hs-comment'>{-# INLINE basicUnsafeCopy #-}</span>
<a name="line-115"></a> <span class='hs-varid'>basicUnsafeCopy</span> <span class='hs-varop'>!</span><span class='hs-varid'>dst</span> <span class='hs-varop'>!</span><span class='hs-varid'>src</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>do_copy</span> <span class='hs-num'>0</span>
<a name="line-116"></a> <span class='hs-keyword'>where</span>
<a name="line-117"></a> <span class='hs-varop'>!</span><span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>basicLength</span> <span class='hs-varid'>src</span>
<a name="line-118"></a>
<a name="line-119"></a> <span class='hs-varid'>do_copy</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>i</span> <span class='hs-varop'><</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-120"></a> <span class='hs-varid'>x</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>basicUnsafeIndexM</span> <span class='hs-varid'>src</span> <span class='hs-varid'>i</span>
<a name="line-121"></a> <span class='hs-conid'>M</span><span class='hs-varop'>.</span><span class='hs-varid'>basicUnsafeWrite</span> <span class='hs-varid'>dst</span> <span class='hs-varid'>i</span> <span class='hs-varid'>x</span>
<a name="line-122"></a> <span class='hs-varid'>do_copy</span> <span class='hs-layout'>(</span><span class='hs-varid'>i</span><span class='hs-varop'>+</span><span class='hs-num'>1</span><span class='hs-layout'>)</span>
<a name="line-123"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-124"></a>
<a name="line-125"></a> <span class='hs-comment'>-- | Evaluate @a@ as far as storing it in a vector would and yield @b@.</span>
<a name="line-126"></a> <span class='hs-comment'>-- The @v a@ argument only fixes the type and is not touched. The method is</span>
<a name="line-127"></a> <span class='hs-comment'>-- only used for optimisation purposes. Thus, it is safe for instances of</span>
<a name="line-128"></a> <span class='hs-comment'>-- 'Vector' to evaluate @a@ less than it would be when stored in a vector</span>
<a name="line-129"></a> <span class='hs-comment'>-- although this might result in suboptimal code.</span>
<a name="line-130"></a> <span class='hs-comment'>--</span>
<a name="line-131"></a> <span class='hs-comment'>-- > elemseq v x y = (singleton x `asTypeOf` v) `seq` y</span>
<a name="line-132"></a> <span class='hs-comment'>--</span>
<a name="line-133"></a> <span class='hs-comment'>-- Default defintion: @a@ is not evaluated at all</span>
<a name="line-134"></a> <span class='hs-comment'>--</span>
<a name="line-135"></a> <span class='hs-varid'>elemseq</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>v</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span>
<a name="line-136"></a>
<a name="line-137"></a> <span class='hs-comment'>{-# INLINE elemseq #-}</span>
<a name="line-138"></a> <span class='hs-varid'>elemseq</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>x</span>
<a name="line-139"></a>
<a name="line-140"></a>
</pre></body>
</html>
|