/usr/share/doc/libghc-lens-doc/html/Control-Lens-Internal-Level.html is in libghc-lens-doc 4.13-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 | <!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.Internal.Level</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-Internal-Level.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Control-Lens-Internal-Level.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-4.13: Lenses, Folds and Traversals</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(C) 2012-2015 Edward Kmett</td></tr><tr><th>License</th><td>BSD-style (see the file LICENSE)</td></tr><tr><th>Maintainer</th><td>Edward Kmett <ekmett@gmail.com></td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>non-portable</td></tr><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Control.Lens.Internal.Level</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Levels</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides implementation details of the combinators in
<a href="Control-Lens-Level.html">Control.Lens.Level</a>, which provides for the breadth-first <code><a href="Control-Lens-Traversal.html#v:Traversal">Traversal</a></code> of
an arbitrary <code><a href="Control-Lens-Traversal.html#v:Traversal">Traversal</a></code>.</p></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">data</span> <a href="#t:Level">Level</a> i a<ul class="subs"><li>= <a href="#v:Two">Two</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word">Word</a> !(<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a) !(<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a)</li><li>| <a href="#v:One">One</a> i a</li><li>| <a href="#v:Zero">Zero</a></li></ul></li><li class="src short"><span class="keyword">newtype</span> <a href="#t:Deepening">Deepening</a> i a = <a href="#v:Deepening">Deepening</a> {<ul class="subs"><li><a href="#v:runDeepening">runDeepening</a> :: <span class="keyword">forall</span> r. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> -> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a> -> r) -> r</li></ul>}</li><li class="src short"><a href="#v:deepening">deepening</a> :: i -> a -> <a href="Control-Lens-Internal-Level.html#t:Deepening">Deepening</a> i a</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:Flows">Flows</a> i b a = <a href="#v:Flows">Flows</a> {<ul class="subs"><li><a href="#v:runFlows">runFlows</a> :: [<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i b] -> a</li></ul>}</li></ul></div><div id="interface"><h1 id="g:1">Levels</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Level" class="def">Level</a> i a <a href="src/Control-Lens-Internal-Level.html#Level" class="link">Source</a></p><div class="doc"><p>This data type represents a path-compressed copy of one level of a source
data structure. We can safely use path-compression because we know the depth
of the tree.</p><p>Path compression is performed by viewing a <code><a href="Control-Lens-Internal-Level.html#t:Level">Level</a></code> as a PATRICIA trie of the
paths into the structure to leaves at a given depth, similar in many ways
to a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/containers-0.5.6.2/Data-IntMap.html#v:IntMap">IntMap</a></code>, but unlike a regular PATRICIA trie we do not need
to store the mask bits merely the depth of the fork.</p><p>One invariant of this structure is that underneath a <code><a href="Control-Lens-Internal-Level.html#v:Two">Two</a></code> node you will not
find any <code><a href="Control-Lens-Internal-Level.html#v:Zero">Zero</a></code> nodes, so <code><a href="Control-Lens-Internal-Level.html#v:Zero">Zero</a></code> can only occur at the root.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Two" class="def">Two</a> !<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word">Word</a> !(<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a) !(<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:One" class="def">One</a> i a</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Zero" class="def">Zero</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Level" class="caption collapser" onclick="toggleSection('i:Level')">Instances</p><div id="section.i:Level" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="Control-Lens-Indexed.html#t:TraversableWithIndex">TraversableWithIndex</a> i (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i)</span> <a href="src/Control-Lens-Indexed.html#line-730" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="Control-Lens-Indexed.html#t:FoldableWithIndex">FoldableWithIndex</a> i (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i)</span> <a href="src/Control-Lens-Indexed.html#line-723" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="Control-Lens-Indexed.html#t:FunctorWithIndex">FunctorWithIndex</a> i (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i)</span> <a href="src/Control-Lens-Indexed.html#line-716" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i)</span> <a href="src/Control-Lens-Internal-Level.html#line-74" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Foldable.html#t:Foldable">Foldable</a> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i)</span> <a href="src/Control-Lens-Internal-Level.html#line-81" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="Control-Lens-Traversal.html#t:Traversable">Traversable</a> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i)</span> <a href="src/Control-Lens-Internal-Level.html#line-88" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left">(<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> i, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a)</span> <a href="src/Control-Lens-Internal-Level.html#line-59" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left">(<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Ord.html#t:Ord">Ord</a> i, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Ord.html#t:Ord">Ord</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Ord.html#t:Ord">Ord</a> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a)</span> <a href="src/Control-Lens-Internal-Level.html#line-59" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left">(<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Read.html#t:Read">Read</a> i, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Read.html#t:Read">Read</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Read.html#t:Read">Read</a> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a)</span> <a href="src/Control-Lens-Internal-Level.html#line-59" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left">(<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> i, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> a) => <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a)</span> <a href="src/Control-Lens-Internal-Level.html#line-59" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:Deepening" class="def">Deepening</a> i a <a href="src/Control-Lens-Internal-Level.html#Deepening" class="link">Source</a></p><div class="doc"><p>This is an illegal <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Monoid.html#t:Monoid">Monoid</a></code> used to construct a single <code><a href="Control-Lens-Internal-Level.html#t:Level">Level</a></code>.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Deepening" class="def">Deepening</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:runDeepening" class="def">runDeepening</a> :: <span class="keyword">forall</span> r. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> -> (<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i a -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a> -> r) -> r</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Deepening" class="caption collapser" onclick="toggleSection('i:Deepening')">Instances</p><div id="section.i:Deepening" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Monoid.html#t:Monoid">Monoid</a> (<a href="Control-Lens-Internal-Level.html#t:Deepening">Deepening</a> i a)</span> <a href="src/Control-Lens-Internal-Level.html#line-109" class="link">Source</a></td><td class="doc"><p>This is an illegal <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Monoid.html#t:Monoid">Monoid</a></code>.</p></td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/libghc-semigroups-doc/html/Data-Semigroup.html#t:Semigroup">Semigroup</a> (<a href="Control-Lens-Internal-Level.html#t:Deepening">Deepening</a> i a)</span> <a href="src/Control-Lens-Internal-Level.html#line-102" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:deepening" class="def">deepening</a> :: i -> a -> <a href="Control-Lens-Internal-Level.html#t:Deepening">Deepening</a> i a <a href="src/Control-Lens-Internal-Level.html#deepening" class="link">Source</a></p><div class="doc"><p>Generate the leaf of a given <code><a href="Control-Lens-Internal-Level.html#t:Deepening">Deepening</a></code> based on whether or not we're at the correct depth.</p></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:Flows" class="def">Flows</a> i b a <a href="src/Control-Lens-Internal-Level.html#Flows" class="link">Source</a></p><div class="doc"><p>This is an illegal <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Applicative.html#t:Applicative">Applicative</a></code> used to replace the contents of a list of consecutive <code><a href="Control-Lens-Internal-Level.html#t:Level">Level</a></code> values
representing each layer of a structure into the original shape that they were derived from.</p><p>Attempting to <code>Flow</code> something back into a shape other than the one it was taken from will fail.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Flows" class="def">Flows</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:runFlows" class="def">runFlows</a> :: [<a href="Control-Lens-Internal-Level.html#t:Level">Level</a> i b] -> a</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Flows" class="caption collapser" onclick="toggleSection('i:Flows')">Instances</p><div id="section.i:Flows" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> (<a href="Control-Lens-Internal-Level.html#t:Flows">Flows</a> i b)</span> <a href="src/Control-Lens-Internal-Level.html#line-132" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Applicative.html#t:Applicative">Applicative</a> (<a href="Control-Lens-Internal-Level.html#t:Flows">Flows</a> i b)</span> <a href="src/Control-Lens-Internal-Level.html#line-157" class="link">Source</a></td><td class="doc"><p>This is an illegal <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Applicative.html#t:Applicative">Applicative</a></code>.</p></td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/libghc-semigroupoids-doc/html/Data-Functor-Apply.html#t:Apply">Apply</a> (<a href="Control-Lens-Internal-Level.html#t:Flows">Flows</a> i b)</span> <a href="src/Control-Lens-Internal-Level.html#line-150" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>
|