/
Data-Bits-Lens.html
177 lines (177 loc) · 28.5 KB
/
Data-Bits-Lens.html
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<?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>src/Data/Bits/Lens.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE LiberalTypeSynonyms #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE FlexibleContexts #-}</span>
<a name="line-3"></a><span class='hs-comment'>{-# LANGUAGE Rank2Types #-}</span>
<a name="line-4"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-5"></a><span class='hs-comment'>-- |</span>
<a name="line-6"></a><span class='hs-comment'>-- Module : Data.Bits.Lens</span>
<a name="line-7"></a><span class='hs-comment'>-- Copyright : (C) 2012 Edward Kmett</span>
<a name="line-8"></a><span class='hs-comment'>-- License : BSD-style (see the file LICENSE)</span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer : Edward Kmett <ekmett@gmail.com></span>
<a name="line-10"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-11"></a><span class='hs-comment'>-- Portability : LiberalTypeSynonyms</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>----------------------------------------------------------------------------</span>
<a name="line-14"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Bits</span><span class='hs-varop'>.</span><span class='hs-conid'>Lens</span>
<a name="line-15"></a> <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-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-layout'>(</span><span class='hs-varop'><&~</span><span class='hs-layout'>)</span>
<a name="line-16"></a> <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-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-layout'>(</span><span class='hs-varop'><&=</span><span class='hs-layout'>)</span>
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>bitAt</span>
<a name="line-18"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>traverseBits</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'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Lens</span>
<a name="line-22"></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'>State</span><span class='hs-varop'>.</span><span class='hs-conid'>Class</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Bits</span>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Functor</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-keyword'>infixr</span> <span class='hs-num'>4</span> <span class='hs-varop'>|~</span><span class='hs-layout'>,</span> <span class='hs-varop'>&~</span><span class='hs-layout'>,</span> <span class='hs-varop'><|~</span><span class='hs-layout'>,</span> <span class='hs-varop'><&~</span>
<a name="line-27"></a><span class='hs-keyword'>infix</span> <span class='hs-num'>4</span> <span class='hs-varop'>|=</span><span class='hs-layout'>,</span> <span class='hs-varop'>&=</span><span class='hs-layout'>,</span> <span class='hs-varop'><|=</span><span class='hs-layout'>,</span> <span class='hs-varop'><&=</span>
<a name="line-28"></a>
<a name="line-29"></a><a name="%7c~"></a><span class='hs-comment'>-- | Bitwise '.|.' the target(s) of a 'Lens' or 'Setter'</span>
<a name="line-30"></a><span class='hs-comment'>--</span>
<a name="line-31"></a><span class='hs-comment'>-- >>> _2 |~ 6 $ ("hello",3)</span>
<a name="line-32"></a><span class='hs-comment'>-- ("hello",7)</span>
<a name="line-33"></a><span class='hs-comment'>--</span>
<a name="line-34"></a><span class='hs-comment'>-- @</span>
<a name="line-35"></a><span class='hs-comment'>-- ('|~') :: 'Bits' c => 'Setter' a b c c -> c -> a -> b</span>
<a name="line-36"></a><span class='hs-comment'>-- ('|~') :: 'Bits' c => 'Iso' a b c c -> c -> a -> b</span>
<a name="line-37"></a><span class='hs-comment'>-- ('|~') :: 'Bits' c => 'Lens' a b c c -> c -> a -> b</span>
<a name="line-38"></a><span class='hs-comment'>-- ('|~') :: ('Monoid c', 'Bits' c) => 'Traversal' a b c c -> c -> a -> b</span>
<a name="line-39"></a><span class='hs-comment'>-- @</span>
<a name="line-40"></a><span class='hs-layout'>(</span><span class='hs-varop'>|~</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Setting</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>c</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span>
<a name="line-41"></a><a name="l"></a><span class='hs-definition'>l</span> <span class='hs-varop'>|~</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>over</span> <span class='hs-varid'>l</span> <span class='hs-layout'>(</span><span class='hs-varop'>.|.</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span>
<a name="line-42"></a><span class='hs-comment'>{-# INLINE (|~) #-}</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="&~"></a><span class='hs-comment'>-- | Bitwise '.&.' the target(s) of a 'Lens' or 'Setter'</span>
<a name="line-45"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><span class='hs-comment'>-- >>> _2 &~ 7 $ ("hello",254)</span>
<a name="line-47"></a><span class='hs-comment'>-- ("hello",6)</span>
<a name="line-48"></a><span class='hs-comment'>--</span>
<a name="line-49"></a><span class='hs-comment'>-- @</span>
<a name="line-50"></a><span class='hs-comment'>-- ('&~') :: 'Bits' c => 'Setter' a b c c -> c -> a -> b</span>
<a name="line-51"></a><span class='hs-comment'>-- ('&~') :: 'Bits' c => 'Iso' a b c c -> c -> a -> b</span>
<a name="line-52"></a><span class='hs-comment'>-- ('&~') :: 'Bits' c => 'Lens' a b c c -> c -> a -> b</span>
<a name="line-53"></a><span class='hs-comment'>-- ('&~') :: ('Monoid c', 'Bits' c) => 'Traversal' a b c c -> c -> a -> b</span>
<a name="line-54"></a><span class='hs-comment'>-- @</span>
<a name="line-55"></a><span class='hs-layout'>(</span><span class='hs-varop'>&~</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Setting</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>c</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span>
<a name="line-56"></a><span class='hs-definition'>l</span> <span class='hs-varop'>&~</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>over</span> <span class='hs-varid'>l</span> <span class='hs-layout'>(</span><span class='hs-varop'>.&.</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span>
<a name="line-57"></a><span class='hs-comment'>{-# INLINE (&~) #-}</span>
<a name="line-58"></a>
<a name="line-59"></a><a name="&="></a><span class='hs-comment'>-- | Modify the target(s) of a 'Simple' 'Lens', 'Setter' or 'Traversal' by computing its bitwise '.&.' with another value.</span>
<a name="line-60"></a><span class='hs-comment'>--</span>
<a name="line-61"></a><span class='hs-comment'>-- @</span>
<a name="line-62"></a><span class='hs-comment'>-- ('&=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Setter' a b -> b -> m ()</span>
<a name="line-63"></a><span class='hs-comment'>-- ('&=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Iso' a b -> b -> m ()</span>
<a name="line-64"></a><span class='hs-comment'>-- ('&=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Lens' a b -> b -> m ()</span>
<a name="line-65"></a><span class='hs-comment'>-- ('&=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Traversal' a b -> b -> m ()</span>
<a name="line-66"></a><span class='hs-comment'>-- @</span>
<a name="line-67"></a><span class='hs-layout'>(</span><span class='hs-varop'>&=</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadState</span> <span class='hs-varid'>a</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Simple</span> <span class='hs-conid'>Setting</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-68"></a><span class='hs-definition'>l</span> <span class='hs-varop'>&=</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>modify</span> <span class='hs-layout'>(</span><span class='hs-varid'>l</span> <span class='hs-varop'>&~</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-69"></a><span class='hs-comment'>{-# INLINE (&=) #-}</span>
<a name="line-70"></a>
<a name="line-71"></a><a name="%7c="></a><span class='hs-comment'>-- | Modify the target(s) of a 'Simple' 'Lens', 'Setter' or 'Traversal' by computing its bitwise '.|.' with another value.</span>
<a name="line-72"></a><span class='hs-comment'>--</span>
<a name="line-73"></a><span class='hs-comment'>-- @</span>
<a name="line-74"></a><span class='hs-comment'>-- ('|=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Setter' a b -> b -> m ()</span>
<a name="line-75"></a><span class='hs-comment'>-- ('|=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Iso' a b -> b -> m ()</span>
<a name="line-76"></a><span class='hs-comment'>-- ('|=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Lens' a b -> b -> m ()</span>
<a name="line-77"></a><span class='hs-comment'>-- ('|=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Traversal' a b -> b -> m ()</span>
<a name="line-78"></a><span class='hs-comment'>-- @</span>
<a name="line-79"></a><span class='hs-layout'>(</span><span class='hs-varop'>|=</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadState</span> <span class='hs-varid'>a</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Simple</span> <span class='hs-conid'>Setting</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-80"></a><span class='hs-definition'>l</span> <span class='hs-varop'>|=</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>modify</span> <span class='hs-layout'>(</span><span class='hs-varid'>l</span> <span class='hs-varop'>|~</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-81"></a><span class='hs-comment'>{-# INLINE (|=) #-}</span>
<a name="line-82"></a>
<a name="line-83"></a><a name="%3c%7c~"></a><span class='hs-comment'>-- | Bitwise '.|.' the target(s) of a 'Lens' (or 'Traversal'), returning the result</span>
<a name="line-84"></a><span class='hs-comment'>-- (or a monoidal summary of all of the results).</span>
<a name="line-85"></a><span class='hs-comment'>--</span>
<a name="line-86"></a><span class='hs-comment'>-- >>> _2 <|~ 6 $ ("hello",3)</span>
<a name="line-87"></a><span class='hs-comment'>-- (7,("hello",7))</span>
<a name="line-88"></a><span class='hs-comment'>--</span>
<a name="line-89"></a><span class='hs-comment'>-- @</span>
<a name="line-90"></a><span class='hs-comment'>-- ('<|~') :: 'Bits' c => 'Iso' a b c c -> c -> a -> (c, b)</span>
<a name="line-91"></a><span class='hs-comment'>-- ('<|~') :: 'Bits' c => 'Lens' a b c c -> c -> a -> (c, b)</span>
<a name="line-92"></a><span class='hs-comment'>-- ('<|~') :: ('Bits' c, 'Monoid c) => 'Traversal' a b c c -> c -> a -> (c, b)</span>
<a name="line-93"></a><span class='hs-comment'>-- @</span>
<a name="line-94"></a><span class='hs-layout'>(</span><span class='hs-varop'><|~</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>LensLike</span> <span class='hs-layout'>(</span><span class='hs-conid'>(,)</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>c</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>c</span><span class='hs-layout'>,</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-95"></a><span class='hs-definition'>l</span> <span class='hs-varop'><|~</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>l</span> <span class='hs-varop'><%~</span> <span class='hs-layout'>(</span><span class='hs-varop'>.|.</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span>
<a name="line-96"></a><span class='hs-comment'>{-# INLINE (<|~) #-}</span>
<a name="line-97"></a>
<a name="line-98"></a><a name="%3c&~"></a><span class='hs-comment'>-- | Bitwise '.&.' the target(s) of a 'Lens' or 'Traversal', returning the result</span>
<a name="line-99"></a><span class='hs-comment'>-- (or a monoidal summary of all of the results).</span>
<a name="line-100"></a><span class='hs-comment'>--</span>
<a name="line-101"></a><span class='hs-comment'>-- >>> _2 <&~ 7 $ ("hello",254)</span>
<a name="line-102"></a><span class='hs-comment'>-- (6,("hello",6))</span>
<a name="line-103"></a><span class='hs-comment'>--</span>
<a name="line-104"></a><span class='hs-comment'>-- @</span>
<a name="line-105"></a><span class='hs-comment'>-- ('<&~') :: 'Bits' c => 'Iso' a b c c -> c -> a -> (c, b)</span>
<a name="line-106"></a><span class='hs-comment'>-- ('<&~') :: 'Bits' c => 'Lens' a b c c -> c -> a -> (c, b)</span>
<a name="line-107"></a><span class='hs-comment'>-- ('<&~') :: ('Bits' c, 'Monoid c) => 'Traversal' a b c c -> c -> a -> (c, b)</span>
<a name="line-108"></a><span class='hs-comment'>-- @</span>
<a name="line-109"></a><span class='hs-layout'>(</span><span class='hs-varop'><&~</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>LensLike</span> <span class='hs-layout'>(</span><span class='hs-conid'>(,)</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>c</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>c</span><span class='hs-layout'>,</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-110"></a><span class='hs-definition'>l</span> <span class='hs-varop'><&~</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>l</span> <span class='hs-varop'><%~</span> <span class='hs-layout'>(</span><span class='hs-varop'>.&.</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span>
<a name="line-111"></a><span class='hs-comment'>{-# INLINE (<&~) #-}</span>
<a name="line-112"></a>
<a name="line-113"></a><a name="%3c&="></a><span class='hs-comment'>-- | Modify the target(s) of a 'Simple' 'Lens' (or 'Traversal') by computing its bitwise '.&.' with another value,</span>
<a name="line-114"></a><span class='hs-comment'>-- returning the result (or a monoidal summary of all of the results traversed)</span>
<a name="line-115"></a><span class='hs-comment'>--</span>
<a name="line-116"></a><span class='hs-comment'>-- @</span>
<a name="line-117"></a><span class='hs-comment'>-- ('<&=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Lens' a b -> b -> m b</span>
<a name="line-118"></a><span class='hs-comment'>-- ('<&=') :: ('MonadState' a m, 'Bits' b, 'Monoid' b) => 'Simple' 'Traversal' a b -> b -> m b</span>
<a name="line-119"></a><span class='hs-comment'>-- @</span>
<a name="line-120"></a><span class='hs-layout'>(</span><span class='hs-varop'><&=</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadState</span> <span class='hs-varid'>a</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>SimpleLensLike</span> <span class='hs-layout'>(</span><span class='hs-conid'>(,)</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>b</span>
<a name="line-121"></a><span class='hs-definition'>l</span> <span class='hs-varop'><&=</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>l</span> <span class='hs-varop'><%=</span> <span class='hs-layout'>(</span><span class='hs-varop'>.&.</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-122"></a><span class='hs-comment'>{-# INLINE (<&=) #-}</span>
<a name="line-123"></a>
<a name="line-124"></a><a name="%3c%7c="></a><span class='hs-comment'>-- | Modify the target(s) of a 'Simple' 'Lens', (or 'Traversal') by computing its bitwise '.|.' with another value,</span>
<a name="line-125"></a><span class='hs-comment'>-- returning the result (or a monoidal summary of all of the results traversed)</span>
<a name="line-126"></a><span class='hs-comment'>--</span>
<a name="line-127"></a><span class='hs-comment'>-- @</span>
<a name="line-128"></a><span class='hs-comment'>-- ('<|=') :: ('MonadState' a m, 'Bits' b) => 'Simple' 'Lens' a b -> b -> m b</span>
<a name="line-129"></a><span class='hs-comment'>-- ('<|=') :: ('MonadState' a m, 'Bits' b, 'Monoid' b) => 'Simple' 'Traversal' a b -> b -> m b</span>
<a name="line-130"></a><span class='hs-comment'>-- @</span>
<a name="line-131"></a><span class='hs-layout'>(</span><span class='hs-varop'><|=</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadState</span> <span class='hs-varid'>a</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>SimpleLensLike</span> <span class='hs-layout'>(</span><span class='hs-conid'>(,)</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>b</span>
<a name="line-132"></a><span class='hs-definition'>l</span> <span class='hs-varop'><|=</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>l</span> <span class='hs-varop'><%=</span> <span class='hs-layout'>(</span><span class='hs-varop'>.|.</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-133"></a><span class='hs-comment'>{-# INLINE (<|=) #-}</span>
<a name="line-134"></a>
<a name="line-135"></a><a name="bitAt"></a><span class='hs-comment'>-- | This lens can be used to access the value of the nth bit in a number.</span>
<a name="line-136"></a><span class='hs-comment'>--</span>
<a name="line-137"></a><span class='hs-comment'>-- @'bitAt' n@ is only a legal 'Lens' into @b@ if @0 <= n < 'bitSize' ('undefined' :: b)@</span>
<a name="line-138"></a><span class='hs-comment'>--</span>
<a name="line-139"></a><span class='hs-comment'>-- >>> 16^.bitAt 4</span>
<a name="line-140"></a><span class='hs-comment'>-- True</span>
<a name="line-141"></a><span class='hs-comment'>--</span>
<a name="line-142"></a><span class='hs-comment'>-- >>> 15^.bitAt 4</span>
<a name="line-143"></a><span class='hs-comment'>-- False</span>
<a name="line-144"></a><span class='hs-definition'>bitAt</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SimpleIndexedLens</span> <span class='hs-conid'>Int</span> <span class='hs-varid'>b</span> <span class='hs-conid'>Bool</span>
<a name="line-145"></a><span class='hs-definition'>bitAt</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>index</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>f</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>if</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>setBit</span> <span class='hs-varid'>b</span> <span class='hs-varid'>n</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>clearBit</span> <span class='hs-varid'>b</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-varop'><$></span> <span class='hs-varid'>f</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-varid'>testBit</span> <span class='hs-varid'>b</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span>
<a name="line-146"></a><span class='hs-comment'>{-# INLINE bitAt #-}</span>
<a name="line-147"></a>
<a name="line-148"></a><a name="traverseBits"></a><span class='hs-comment'>-- | Traverse over all bits in a numeric type.</span>
<a name="line-149"></a><span class='hs-comment'>--</span>
<a name="line-150"></a><span class='hs-comment'>-- The bit position is available as the index.</span>
<a name="line-151"></a><span class='hs-comment'>--</span>
<a name="line-152"></a><span class='hs-comment'>-- >>> import Data.Word</span>
<a name="line-153"></a><span class='hs-comment'>-- >>> toListOf traverseBits (5 :: Word8)</span>
<a name="line-154"></a><span class='hs-comment'>-- [True,False,True,False,False,False,False,False]</span>
<a name="line-155"></a><span class='hs-comment'>--</span>
<a name="line-156"></a><span class='hs-comment'>-- If you supply this an 'Integer', the result will</span>
<a name="line-157"></a><span class='hs-comment'>-- be an infinite 'Traversal' that can be productively consumed.</span>
<a name="line-158"></a><span class='hs-definition'>traverseBits</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Num</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>SimpleIndexedTraversal</span> <span class='hs-conid'>Int</span> <span class='hs-varid'>b</span> <span class='hs-conid'>Bool</span>
<a name="line-159"></a><span class='hs-definition'>traverseBits</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>index</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>f</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>let</span>
<a name="line-160"></a> <span class='hs-varid'>g</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>(,)</span> <span class='hs-varid'>n</span> <span class='hs-varop'><$></span> <span class='hs-varid'>f</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-varid'>testBit</span> <span class='hs-varid'>b</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span>
<a name="line-161"></a> <span class='hs-varid'>bits</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Prelude</span><span class='hs-varop'>.</span><span class='hs-varid'>takeWhile</span> <span class='hs-varid'>hasBit</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>0</span><span class='hs-keyglyph'>..</span><span class='hs-keyglyph'>]</span>
<a name="line-162"></a> <span class='hs-varid'>hasBit</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>complementBit</span> <span class='hs-varid'>b</span> <span class='hs-varid'>n</span> <span class='hs-varop'>/=</span> <span class='hs-varid'>b</span> <span class='hs-comment'>-- test to make sure that complementing this bit actually changes the value</span>
<a name="line-163"></a> <span class='hs-varid'>step</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-conid'>True</span><span class='hs-layout'>)</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>setBit</span> <span class='hs-varid'>r</span> <span class='hs-varid'>n</span>
<a name="line-164"></a> <span class='hs-varid'>step</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>r</span>
<a name="line-165"></a> <span class='hs-keyword'>in</span> <span class='hs-conid'>Prelude</span><span class='hs-varop'>.</span><span class='hs-varid'>foldr</span> <span class='hs-varid'>step</span> <span class='hs-num'>0</span> <span class='hs-varop'><$></span> <span class='hs-varid'>traverse</span> <span class='hs-varid'>g</span> <span class='hs-varid'>bits</span>
<a name="line-166"></a><span class='hs-comment'>{-# INLINE traverseBits #-}</span>
</pre></body>
</html>