Permalink
Browse files

3.7 release documentation

  • Loading branch information...
1 parent 113c9f1 commit 76553d4c36c49a9db3d71c963c913d3d3a035dda @ekmett committed Dec 7, 2012
View

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -23,11 +23,13 @@
</p></div></div><div class="top"><p class="src"><a name="v:icompose" class="def">icompose</a> :: <a href="Control-Lens-Indexed.html#t:Indexable">Indexable</a> k r =&gt; (i -&gt; j -&gt; k) -&gt; <a href="Control-Lens-Indexed.html#t:Indexed">Indexed</a> i b c -&gt; <a href="Control-Lens-Indexed.html#t:Indexed">Indexed</a> j a b -&gt; r a c<a href="src/Control-Lens-Indexed.html#icompose" class="link">Source</a></p><div class="doc"><p>Composition of <code><a href="Control-Lens-Indexed.html#t:Indexed">Indexed</a></code> functions with a user supplied function for combining indices
</p></div></div><div class="top"><p class="src"><a name="v:reindexed" class="def">reindexed</a> :: <a href="Control-Lens-Indexed.html#t:Indexable">Indexable</a> j k =&gt; (i -&gt; j) -&gt; <a href="Control-Lens-Indexed.html#t:Indexed">Indexed</a> i a b -&gt; k a b<a href="src/Control-Lens-Indexed.html#reindexed" class="link">Source</a></p><div class="doc"><p>Remap the index.
</p></div></div><h1 id="g:2">Indexing existing lenses, traversals, etc.
-</h1><div class="top"><p class="src"><a name="v:indexing" class="def">indexing</a> :: <a href="Control-Lens-Indexed.html#t:Indexable">Indexable</a> <a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a> k =&gt; ((a -&gt; <a href="Control-Lens-Internal.html#t:Indexing">Indexing</a> f b) -&gt; s -&gt; <a href="Control-Lens-Internal.html#t:Indexing">Indexing</a> f t) -&gt; k (a -&gt; f b) (s -&gt; f t)<a href="src/Control-Lens-Indexed.html#indexing" class="link">Source</a></p><div class="doc"><p>Transform an <code>Traversal</code> into an <code><a href="Control-Lens-IndexedTraversal.html#t:IndexedTraversal">IndexedTraversal</a></code>, a <code>Fold</code> into an <code><a href="Control-Lens-IndexedFold.html#t:IndexedFold">IndexedFold</a></code>, etc.
+</h1><div class="top"><p class="src"><a name="v:indexing" class="def">indexing</a> :: <a href="Control-Lens-Indexed.html#t:Indexable">Indexable</a> <a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a> k =&gt; ((a -&gt; <a href="Control-Lens-Internal.html#t:Indexing">Indexing</a> f b) -&gt; s -&gt; <a href="Control-Lens-Internal.html#t:Indexing">Indexing</a> f t) -&gt; k (a -&gt; f b) (s -&gt; f t)<a href="src/Control-Lens-Indexed.html#indexing" class="link">Source</a></p><div class="doc"><p>Transform an <code>Traversal</code> into an <code><a href="Control-Lens-IndexedTraversal.html#t:IndexedTraversal">IndexedTraversal</a></code> or
+ a <code>Fold</code> into an <code><a href="Control-Lens-IndexedFold.html#t:IndexedFold">IndexedFold</a></code>, etc.
</p><pre>
<code><a href="Control-Lens-Indexed.html#v:indexing">indexing</a></code> :: <code><a href="Control-Lens-Traversal.html#t:Traversal">Traversal</a></code> s t a b -&gt; <code><a href="Control-Lens-IndexedTraversal.html#t:IndexedTraversal">IndexedTraversal</a></code> <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a></code> s t a b
+ <code><a href="Control-Lens-Indexed.html#v:indexing">indexing</a></code> :: <code><a href="Control-Lens-Prism.html#t:Prism">Prism</a></code> s t a b -&gt; <code><a href="Control-Lens-IndexedLens.html#t:IndexedTraversal">IndexedTraversal</a></code> <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a></code> s t a b
<code><a href="Control-Lens-Indexed.html#v:indexing">indexing</a></code> :: <code><a href="Control-Lens-Type.html#t:Lens">Lens</a></code> s t a b -&gt; <code><a href="Control-Lens-IndexedLens.html#t:IndexedLens">IndexedLens</a></code> <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a></code> s t a b
- <code><a href="Control-Lens-Indexed.html#v:indexing">indexing</a></code> :: <code><a href="Control-Lens-Fold.html#t:Fold">Fold</a></code> s t -&gt; <code><a href="Control-Lens-IndexedFold.html#t:IndexedFold">IndexedFold</a></code> <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a></code> s t
<code><a href="Control-Lens-Indexed.html#v:indexing">indexing</a></code> :: <code><a href="Control-Lens-Iso.html#t:Iso">Iso</a></code> s t a b -&gt; <code><a href="Control-Lens-IndexedLens.html#t:IndexedLens">IndexedLens</a></code> <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a></code> s t a b
+ <code><a href="Control-Lens-Indexed.html#v:indexing">indexing</a></code> :: <code><a href="Control-Lens-Fold.html#t:Fold">Fold</a></code> s t -&gt; <code><a href="Control-Lens-IndexedFold.html#t:IndexedFold">IndexedFold</a></code> <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a></code> s t
<code><a href="Control-Lens-Indexed.html#v:indexing">indexing</a></code> :: <code><a href="Control-Lens-Getter.html#t:Getter">Getter</a></code> s t -&gt; <code><a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a></code> <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.2-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Int.html#t:Int">Int</a></code> s t a b
</pre></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
@@ -1,9 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Control.Lens.IndexedGetter</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Control-Lens-IndexedGetter.html");};
//]]>
-</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Control-Lens-IndexedGetter.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">lens-3.7: Lenses, Folds and Traversals</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>rank 2 types, MPTCs</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>Edward Kmett &lt;ekmett@gmail.com&gt;</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Control.Lens.IndexedGetter</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Indexed Folds
-</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc empty">&nbsp;</div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">type</span> <a href="#t:IndexedGetter">IndexedGetter</a> i s a = <span class="keyword">forall</span> k f. (<a href="Control-Lens-Classes.html#t:Indexable">Indexable</a> i k, <a href="Control-Lens-Classes.html#t:Gettable">Gettable</a> f) =&gt; k (a -&gt; f a) (s -&gt; f s)</li><li class="src short"><span class="keyword">type</span> <a href="#t:IndexedGetting">IndexedGetting</a> i m s t a b = <a href="Control-Lens-Internal.html#t:Indexed">Indexed</a> i (a -&gt; <a href="Control-Lens-Internal.html#t:Accessor">Accessor</a> m b) (s -&gt; <a href="Control-Lens-Internal.html#t:Accessor">Accessor</a> m t)</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:ReifiedIndexedGetter">ReifiedIndexedGetter</a> i s a = <a href="#v:ReifyIndexedGetter">ReifyIndexedGetter</a> {<ul class="subs"><li><a href="#v:reflectIndexedGetter">reflectIndexedGetter</a> :: <a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a> i s a</li></ul>}</li></ul></div><div id="interface"><h1 id="g:1">Indexed Folds
+</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Control-Lens-IndexedGetter.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">lens-3.7: Lenses, Folds and Traversals</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>rank 2 types, MPTCs</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>Edward Kmett &lt;ekmett@gmail.com&gt;</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Control.Lens.IndexedGetter</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Indexed Getters
+</a></li><li><a href="#g:2">Indexed Getter Combinators
+</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc empty">&nbsp;</div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">type</span> <a href="#t:IndexedGetter">IndexedGetter</a> i s a = <span class="keyword">forall</span> k f. (<a href="Control-Lens-Classes.html#t:Indexable">Indexable</a> i k, <a href="Control-Lens-Classes.html#t:Gettable">Gettable</a> f) =&gt; k (a -&gt; f a) (s -&gt; f s)</li><li class="src short"><span class="keyword">type</span> <a href="#t:IndexedGetting">IndexedGetting</a> i m s t a b = <a href="Control-Lens-Internal.html#t:Indexed">Indexed</a> i (a -&gt; <a href="Control-Lens-Internal.html#t:Accessor">Accessor</a> m b) (s -&gt; <a href="Control-Lens-Internal.html#t:Accessor">Accessor</a> m t)</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:ReifiedIndexedGetter">ReifiedIndexedGetter</a> i s a = <a href="#v:ReifyIndexedGetter">ReifyIndexedGetter</a> {<ul class="subs"><li><a href="#v:reflectIndexedGetter">reflectIndexedGetter</a> :: <a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a> i s a</li></ul>}</li><li class="src short"><a href="#v:iview">iview</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-Reader-Class.html#t:MonadReader">MonadReader</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i (i, a) s t a b -&gt; m (i, a)</li><li class="src short"><a href="#v:iviews">iviews</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-Reader-Class.html#t:MonadReader">MonadReader</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i r s t a b -&gt; (i -&gt; a -&gt; r) -&gt; m r</li><li class="src short"><a href="#v:iuse">iuse</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-State-Class.html#t:MonadState">MonadState</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i (i, a) s t a b -&gt; m (i, a)</li><li class="src short"><a href="#v:iuses">iuses</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-State-Class.html#t:MonadState">MonadState</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i r s t a b -&gt; (i -&gt; a -&gt; r) -&gt; m r</li></ul></div><div id="interface"><h1 id="g:1">Indexed Getters
</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:IndexedGetter" class="def">IndexedGetter</a> i s a = <span class="keyword">forall</span> k f. (<a href="Control-Lens-Classes.html#t:Indexable">Indexable</a> i k, <a href="Control-Lens-Classes.html#t:Gettable">Gettable</a> f) =&gt; k (a -&gt; f a) (s -&gt; f s)<a href="src/Control-Lens-IndexedGetter.html#IndexedGetter" class="link">Source</a></p><div class="doc"><p>Every <code><a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a></code> is a valid <code><a href="Control-Lens-IndexedFold.html#t:IndexedFold">IndexedFold</a></code> and <code>Getter</code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:IndexedGetting" class="def">IndexedGetting</a> i m s t a b = <a href="Control-Lens-Internal.html#t:Indexed">Indexed</a> i (a -&gt; <a href="Control-Lens-Internal.html#t:Accessor">Accessor</a> m b) (s -&gt; <a href="Control-Lens-Internal.html#t:Accessor">Accessor</a> m t)<a href="src/Control-Lens-IndexedGetter.html#IndexedGetting" class="link">Source</a></p><div class="doc"><p>Used to consume an <code><a href="Control-Lens-IndexedFold.html#t:IndexedFold">IndexedFold</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:ReifiedIndexedGetter" class="def">ReifiedIndexedGetter</a> i s a <a href="src/Control-Lens-IndexedGetter.html#ReifiedIndexedGetter" class="link">Source</a></p><div class="doc"><p>Useful for storage.
-</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ReifyIndexedGetter" class="def">ReifyIndexedGetter</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:reflectIndexedGetter" class="def">reflectIndexedGetter</a> :: <a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a> i s a</dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
+</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ReifyIndexedGetter" class="def">ReifyIndexedGetter</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:reflectIndexedGetter" class="def">reflectIndexedGetter</a> :: <a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a> i s a</dt><dd class="doc empty">&nbsp;</dd></dl><div class="clear"></div></div></td></tr></table></div></div><h1 id="g:2">Indexed Getter Combinators
+</h1><div class="top"><p class="src"><a name="v:iview" class="def">iview</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-Reader-Class.html#t:MonadReader">MonadReader</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i (i, a) s t a b -&gt; m (i, a)<a href="src/Control-Lens-IndexedGetter.html#iview" class="link">Source</a></p><div class="doc"><p>View the index and value of an <code><a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a></code> into the current environment as a pair.
+</p><p>When applied to an <code>IndexedFold</code> the result will most likely be a nonsensical monoidal summary of
+ the indices tupled with a monoidal summary of the values and probably not whatever it is you wanted.
+</p></div></div><div class="top"><p class="src"><a name="v:iviews" class="def">iviews</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-Reader-Class.html#t:MonadReader">MonadReader</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i r s t a b -&gt; (i -&gt; a -&gt; r) -&gt; m r<a href="src/Control-Lens-IndexedGetter.html#iviews" class="link">Source</a></p><div class="doc"><p>View a function of the index and value of an <code><a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a></code> into the current environment
+</p><p>When applied to an <code>IndexedFold</code> the result will be a monoidal summary instead of a single answer.
+</p><pre><code><a href="Control-Lens-IndexedGetter.html#v:iviews">iviews</a></code> &#8801; <code><a href="Control-Lens-IndexedFold.html#v:ifoldMapOf">ifoldMapOf</a></code></pre></div></div><div class="top"><p class="src"><a name="v:iuse" class="def">iuse</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-State-Class.html#t:MonadState">MonadState</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i (i, a) s t a b -&gt; m (i, a)<a href="src/Control-Lens-IndexedGetter.html#iuse" class="link">Source</a></p><div class="doc"><p>Use the index and value of an <code><a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a></code> into the current state as a pair.
+</p><p>When applied to an <code>IndexedFold</code> the result will most likely be a nonsensical monoidal summary of
+ the indices tupled with a monoidal summary of the values and probably not whatever it is you wanted.
+</p></div></div><div class="top"><p class="src"><a name="v:iuses" class="def">iuses</a> :: <a href="/Library/Haskell/ghc-7.4.2/lib/mtl-2.1.2/doc/html/Control-Monad-State-Class.html#t:MonadState">MonadState</a> s m =&gt; <a href="Control-Lens-IndexedGetter.html#t:IndexedGetting">IndexedGetting</a> i r s t a b -&gt; (i -&gt; a -&gt; r) -&gt; m r<a href="src/Control-Lens-IndexedGetter.html#iuses" class="link">Source</a></p><div class="doc"><p>Use a function of the index and value of an <code><a href="Control-Lens-IndexedGetter.html#t:IndexedGetter">IndexedGetter</a></code> into the current state.
+</p><p>When applied to an <code>IndexedFold</code> the result will be a monoidal summary instead of a single answer.
+</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
Oops, something went wrong.

0 comments on commit 76553d4

Please sign in to comment.