Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history
Deploy website version based on 769e443
  • Loading branch information
Docusaurus bot committed Jan 9, 2025
1 parent f552012 commit 3cb2d30
Show file tree
Hide file tree
Showing 32 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion api/monocle/PLens.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/monocle/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
the modified source of a <a href="PIso.html" name="monocle.PIso" id="monocle.PIso" class="extype">PIso</a></p></dd><dt class="tparam">A</dt><dd class="cmt"><p>
the target of a <a href="PIso.html" name="monocle.PIso" id="monocle.PIso" class="extype">PIso</a></p></dd><dt class="tparam">B</dt><dd class="cmt"><p>
the modified target of a <a href="PIso.html" name="monocle.PIso" id="monocle.PIso" class="extype">PIso</a></p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p>
<a href="law/IsoLaws.html" name="monocle.law.IsoLaws" id="monocle.law.IsoLaws" class="extype">monocle.law.IsoLaws</a></p></span></dd></dl></div></li><li class="indented0 " name="monocle.PIsoSyntax" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PIsoSyntax[S,T,A,B]extendsAnyValwithProductwithSerializable" class="anchorToMember"></a><a id="PIsoSyntax[S,T,A,B]:PIsoSyntax[S,T,A,B]" class="anchorToMember"></a> <span class="permalink"><a href="../monocle/PIsoSyntax.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PIsoSyntax.html" title=""><span class="name">PIsoSyntax</span></a><span class="tparams">[<span name="S">S</span>, <span name="T">T</span>, <span name="A">A</span>, <span name="B">B</span>]</span><span class="params">(<span name="self">self: <a href="PIso.html" name="monocle.PIso" id="monocle.PIso" class="extype">PIso</a>[<span name="monocle.PIsoSyntax.S" class="extype">S</span>, <span name="monocle.PIsoSyntax.T" class="extype">T</span>, <span name="monocle.PIsoSyntax.A" class="extype">A</span>, <span name="monocle.PIsoSyntax.B" class="extype">B</span>]</span>)</span><span class="result"> extends <a href="https://www.scala-lang.org/api/2.13.15/scala/AnyVal.html#scala.AnyVal" name="scala.AnyVal" id="scala.AnyVal" class="extype">AnyVal</a> with <a href="https://www.scala-lang.org/api/2.13.15/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="monocle.PLens" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="PLens[S,T,A,B]extendsPOptional[S,T,A,B]withGetter[S,A]" class="anchorToMember"></a><a id="PLens[S,T,A,B]:PLens[S,T,A,B]" class="anchorToMember"></a> <span class="permalink"><a href="../monocle/PLens.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="PLens.html" title="A PLens can be seen as a pair of functions:"><span class="name">PLens</span></a><span class="tparams">[<span name="S">S</span>, <span name="T">T</span>, <span name="A">A</span>, <span name="B">B</span>]</span><span class="result"> extends <a href="POptional.html" name="monocle.POptional" id="monocle.POptional" class="extype">POptional</a>[<span name="monocle.PLens.S" class="extype">S</span>, <span name="monocle.PLens.T" class="extype">T</span>, <span name="monocle.PLens.A" class="extype">A</span>, <span name="monocle.PLens.B" class="extype">B</span>] with <a href="Getter.html" name="monocle.Getter" id="monocle.Getter" class="extype">Getter</a>[<span name="monocle.PLens.S" class="extype">S</span>, <span name="monocle.PLens.A" class="extype">A</span>]</span></span><p class="shortcomment cmt">A <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> can be seen as a pair of functions:</p><div class="fullcomment"><div class="comment cmt"><p>A <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> can be seen as a pair of functions:</p><ul><li><code>get: S =&gt; A</code> i.e. from an <code>S</code>, we can extract an <code>A</code></li><li><code>set: (B, S) =&gt; T</code> i.e. if we replace an <code>A</code> by a <code>B</code> in an <code>S</code>, we obtain a <code>T</code></li></ul><p>A <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> could also be defined as a weaker <a href="PIso.html" name="monocle.PIso" id="monocle.PIso" class="extype">PIso</a> where replace requires an additional parameter than
<a href="law/IsoLaws.html" name="monocle.law.IsoLaws" id="monocle.law.IsoLaws" class="extype">monocle.law.IsoLaws</a></p></span></dd></dl></div></li><li class="indented0 " name="monocle.PIsoSyntax" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PIsoSyntax[S,T,A,B]extendsAnyValwithProductwithSerializable" class="anchorToMember"></a><a id="PIsoSyntax[S,T,A,B]:PIsoSyntax[S,T,A,B]" class="anchorToMember"></a> <span class="permalink"><a href="../monocle/PIsoSyntax.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PIsoSyntax.html" title=""><span class="name">PIsoSyntax</span></a><span class="tparams">[<span name="S">S</span>, <span name="T">T</span>, <span name="A">A</span>, <span name="B">B</span>]</span><span class="params">(<span name="self">self: <a href="PIso.html" name="monocle.PIso" id="monocle.PIso" class="extype">PIso</a>[<span name="monocle.PIsoSyntax.S" class="extype">S</span>, <span name="monocle.PIsoSyntax.T" class="extype">T</span>, <span name="monocle.PIsoSyntax.A" class="extype">A</span>, <span name="monocle.PIsoSyntax.B" class="extype">B</span>]</span>)</span><span class="result"> extends <a href="https://www.scala-lang.org/api/2.13.15/scala/AnyVal.html#scala.AnyVal" name="scala.AnyVal" id="scala.AnyVal" class="extype">AnyVal</a> with <a href="https://www.scala-lang.org/api/2.13.15/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="monocle.PLens" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="PLens[S,T,A,B]extendsPOptional[S,T,A,B]withGetter[S,A]" class="anchorToMember"></a><a id="PLens[S,T,A,B]:PLens[S,T,A,B]" class="anchorToMember"></a> <span class="permalink"><a href="../monocle/PLens.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="PLens.html" title="A PLens can be seen as a pair of functions:"><span class="name">PLens</span></a><span class="tparams">[<span name="S">S</span>, <span name="T">T</span>, <span name="A">A</span>, <span name="B">B</span>]</span><span class="result"> extends <a href="POptional.html" name="monocle.POptional" id="monocle.POptional" class="extype">POptional</a>[<span name="monocle.PLens.S" class="extype">S</span>, <span name="monocle.PLens.T" class="extype">T</span>, <span name="monocle.PLens.A" class="extype">A</span>, <span name="monocle.PLens.B" class="extype">B</span>] with <a href="Getter.html" name="monocle.Getter" id="monocle.Getter" class="extype">Getter</a>[<span name="monocle.PLens.S" class="extype">S</span>, <span name="monocle.PLens.A" class="extype">A</span>]</span></span><p class="shortcomment cmt">A <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> can be seen as a pair of functions:</p><div class="fullcomment"><div class="comment cmt"><p>A <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> can be seen as a pair of functions:</p><ul><li><code>get: S =&gt; A</code> i.e. from an <code>S</code>, we can extract an <code>A</code></li><li><code>replace: (B, S) =&gt; T</code> i.e. if we replace an <code>A</code> by a <code>B</code> in an <code>S</code>, we obtain a <code>T</code></li></ul><p>A <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> could also be defined as a weaker <a href="PIso.html" name="monocle.PIso" id="monocle.PIso" class="extype">PIso</a> where replace requires an additional parameter than
reverseGet.</p><p><a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> stands for Polymorphic Lens as it replace and modify methods change a type <code>A</code> to <code>B</code> and <code>S</code> to <code>T</code>.
<a href="#Lens[S,A]=monocle.PLens[S,S,A,A]" name="monocle.Lens" id="monocle.Lens" class="extmbr">Lens</a> is a type alias for <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> restricted to monomorphic updates:</p><pre><span class="kw">type</span> Lens[S, A] = PLens[S, S, A, A]</pre><p>A <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> is also a valid <a href="Getter.html" name="monocle.Getter" id="monocle.Getter" class="extype">Getter</a>, <a href="Fold.html" name="monocle.Fold" id="monocle.Fold" class="extype">Fold</a>, <a href="POptional.html" name="monocle.POptional" id="monocle.POptional" class="extype">POptional</a>, <a href="PTraversal.html" name="monocle.PTraversal" id="monocle.PTraversal" class="extype">PTraversal</a> and <a href="PSetter.html" name="monocle.PSetter" id="monocle.PSetter" class="extype">PSetter</a></p><p>Typically a <a href="PLens.html" name="monocle.PLens" id="monocle.PLens" class="extype">PLens</a> or <a href="#Lens[S,A]=monocle.PLens[S,S,A,A]" name="monocle.Lens" id="monocle.Lens" class="extmbr">Lens</a> can be defined between a Product (e.g. case class, tuple, HList) and one of its
component.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@
<ul>
<li><a href="examples/university_example.html">University</a></li>
</ul>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/modules"><span class="arrow-prev"></span><span>Modules</span></a><a class="docs-next button" href="/Monocle/docs/faq"><span>FAQ</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2024.</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/modules"><span class="arrow-prev"></span><span>Modules</span></a><a class="docs-next button" href="/Monocle/docs/faq"><span>FAQ</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2025.</section></footer></div></body></html>
2 changes: 1 addition & 1 deletion docs/examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@
<ul>
<li><a href="examples/university_example.html">University</a></li>
</ul>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/modules"><span class="arrow-prev"></span><span>Modules</span></a><a class="docs-next button" href="/Monocle/docs/faq"><span>FAQ</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2024.</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/modules"><span class="arrow-prev"></span><span>Modules</span></a><a class="docs-next button" href="/Monocle/docs/faq"><span>FAQ</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2025.</section></footer></div></body></html>
2 changes: 1 addition & 1 deletion docs/examples/university_example.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,4 @@ <h2><a class="anchor" aria-hidden="true" id="how-to-create-your-own-traversal"><
<span class="hljs-comment">// )</span>
<span class="hljs-comment">// )</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-remove-or-add-elements-in-a-map">How to remove or add elements in a Map</a></li><li><a href="#how-to-update-a-field-in-a-nested-case-class">How to update a field in a nested case class</a></li><li><a href="#how-to-create-your-own-traversal">How to create your own Traversal</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2024.</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-remove-or-add-elements-in-a-map">How to remove or add elements in a Map</a></li><li><a href="#how-to-update-a-field-in-a-nested-case-class">How to update a field in a nested case class</a></li><li><a href="#how-to-create-your-own-traversal">How to create your own Traversal</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2025.</section></footer></div></body></html>
2 changes: 1 addition & 1 deletion docs/examples/university_example/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,4 @@ <h2><a class="anchor" aria-hidden="true" id="how-to-create-your-own-traversal"><
<span class="hljs-comment">// )</span>
<span class="hljs-comment">// )</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-remove-or-add-elements-in-a-map">How to remove or add elements in a Map</a></li><li><a href="#how-to-update-a-field-in-a-nested-case-class">How to update a field in a nested case class</a></li><li><a href="#how-to-create-your-own-traversal">How to create your own Traversal</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2024.</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-remove-or-add-elements-in-a-map">How to remove or add elements in a Map</a></li><li><a href="#how-to-update-a-field-in-a-nested-case-class">How to update a field in a nested case class</a></li><li><a href="#how-to-create-your-own-traversal">How to create your own Traversal</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2025.</section></footer></div></body></html>
2 changes: 1 addition & 1 deletion docs/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@
<span class="hljs-type">GenLens</span>[<span class="hljs-type">Bar</span>](_.kv).index(<span class="hljs-string">"two"</span>).replace(<span class="hljs-number">0</span>)(<span class="hljs-type">Bar</span>(m))
<span class="hljs-comment">// res6: Bar = Bar(kv = Map("one" -&gt; 1, "two" -&gt; 0))</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/examples"><span class="arrow-prev"></span><span>Examples</span></a><a class="docs-next button" href="/Monocle/docs/release_notes"><span>Release Notes</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-the-difference-between-at-and-index-when-should-i-use-one-or-the-other">What is the difference between at and index? When should I use one or the other?</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2024.</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/examples"><span class="arrow-prev"></span><span>Examples</span></a><a class="docs-next button" href="/Monocle/docs/release_notes"><span>Release Notes</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-the-difference-between-at-and-index-when-should-i-use-one-or-the-other">What is the difference between at and index? When should I use one or the other?</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2025.</section></footer></div></body></html>
2 changes: 1 addition & 1 deletion docs/faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@
<span class="hljs-type">GenLens</span>[<span class="hljs-type">Bar</span>](_.kv).index(<span class="hljs-string">"two"</span>).replace(<span class="hljs-number">0</span>)(<span class="hljs-type">Bar</span>(m))
<span class="hljs-comment">// res6: Bar = Bar(kv = Map("one" -&gt; 1, "two" -&gt; 0))</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/examples"><span class="arrow-prev"></span><span>Examples</span></a><a class="docs-next button" href="/Monocle/docs/release_notes"><span>Release Notes</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-the-difference-between-at-and-index-when-should-i-use-one-or-the-other">What is the difference between at and index? When should I use one or the other?</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2024.</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/Monocle/docs/examples"><span class="arrow-prev"></span><span>Examples</span></a><a class="docs-next button" href="/Monocle/docs/release_notes"><span>Release Notes</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-the-difference-between-at-and-index-when-should-i-use-one-or-the-other">What is the difference between at and index? When should I use one or the other?</a></li></ul></nav></div><footer class="nav-footer" id="footer"><hr class="separator"/><section class="copyright">Copyright the maintainers © 2016-2025.</section></footer></div></body></html>
Loading

0 comments on commit 3cb2d30

Please sign in to comment.