<!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>Darcs.Witnesses.Eq</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_Darcs-Witnesses-Eq.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Darcs-Witnesses-Eq.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">darcs-2.8.3: a distributed, interactive, smart revision control system</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Darcs.Witnesses.Eq</p></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:EqCheck">EqCheck</a> a b <span class="keyword">where</span><ul class="subs"><li><a href="#v:IsEq">IsEq</a> :: <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a a </li><li><a href="#v:NotEq">NotEq</a> :: <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b </li></ul></li><li class="src short"><span class="keyword">class</span> <a href="#t:MyEq">MyEq</a> p <span class="keyword">where</span><ul class="subs"><li><a href="#v:unsafeCompare">unsafeCompare</a> :: p a b -> p c d -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li><a href="#v:-61--92--47--61-">(=\/=)</a> :: p a b -> p a c -> <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> b c</li><li><a href="#v:-61--47--92--61-">(=/\=)</a> :: p a c -> p b c -> <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b</li></ul></li><li class="src short"><a href="#v:isIsEq">isIsEq</a> :: <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:EqCheck" class="def">EqCheck</a> a b <span class="keyword">where</span><a href="src/Darcs-Witnesses-Eq.html#EqCheck" class="link">Source</a></p><div class="doc"><p><code><a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a></code> is used to pass around evidence (or lack thereof) of
two witness types being equal.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:IsEq" class="def">IsEq</a> :: <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a a</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NotEq" class="def">NotEq</a> :: <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:EqCheck" class="caption collapser" onclick="toggleSection('i:EqCheck')">Instances</p><div id="section.i:EqCheck" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> (<a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:MyEq" class="def">MyEq</a> p <span class="keyword">where</span><a href="src/Darcs-Witnesses-Eq.html#MyEq" class="link">Source</a></p><div class="doc"><p>An witness aware equality class.
A minimal definition defines any one of <code><a href="Darcs-Witnesses-Eq.html#v:unsafeCompare">unsafeCompare</a></code>, <code><a href="Darcs-Witnesses-Eq.html#v:-61--92--47--61-">=\/=</a></code> and <code><a href="Darcs-Witnesses-Eq.html#v:-61--47--92--61-">=/\=</a></code>.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:unsafeCompare" class="def">unsafeCompare</a> :: p a b -> p c d -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Darcs-Witnesses-Eq.html#unsafeCompare" class="link">Source</a></p><div class="doc"><p>It is unsafe to define a class instance via this method, because
if it returns True then the default implementations of <code><a href="Darcs-Witnesses-Eq.html#v:-61--92--47--61-">=\/=</a></code> and <code><a href="Darcs-Witnesses-Eq.html#v:-61--47--92--61-">=/\=</a></code>
will coerce the equality of two witnesses.
</p><p>Calling this method is safe, although <code><a href="Darcs-Witnesses-Eq.html#v:-61--92--47--61-">=\/=</a></code> or <code><a href="Darcs-Witnesses-Eq.html#v:-61--47--92--61-">=/\=</a></code> would be better
choices as it is not usually meaningul to compare two patches that
don't share either a starting or an ending context
</p></div><p class="src"><a name="v:-61--92--47--61-" class="def">(=\/=)</a> :: p a b -> p a c -> <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> b c<a href="src/Darcs-Witnesses-Eq.html#%3D%5C%2F%3D" class="link">Source</a></p><div class="doc"><p>Compare two things with the same starting witness. If the things
compare equal, evidence of the ending witnesses being equal will
be returned.
</p></div><p class="src"><a name="v:-61--47--92--61-" class="def">(=/\=)</a> :: p a c -> p b c -> <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b<a href="src/Darcs-Witnesses-Eq.html#%3D%2F%5C%3D" class="link">Source</a></p><div class="doc"><p>Compare two things with the same ending witness. If the things
compare equal, evidence of the starting witnesses being equal will
be returned.
</p></div></div><div class="subs instances"><p id="control.i:MyEq" class="caption collapser" onclick="toggleSection('i:MyEq')">Instances</p><div id="section.i:MyEq" class="show"><table><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> <a href="Darcs-Patch-Prim-V1-Core.html#t:DirPatchType">DirPatchType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> <a href="Darcs-Patch-Prim-V1-Core.html#t:FilePatchType">FilePatchType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> <a href="Darcs-Patch-Prim-V1-Core.html#t:Prim">Prim</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> <a href="Darcs-Patch-Prim-V3-Core.html#t:Prim">Prim</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> <a href="Darcs-Patch-Prim-V3-Core.html#t:Hunk">Hunk</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> <a href="Darcs-Patch-Dummy.html#t:DummyPatch">DummyPatch</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> <a href="Darcs-Patch-PatchInfoAnd.html#t:WPatchInfo">WPatchInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> p, <a href="Darcs-Patch-Commute.html#t:Commute">Commute</a> p) => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Witnesses-Ordered.html#t:RL">RL</a> p)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> p, <a href="Darcs-Patch-Commute.html#t:Commute">Commute</a> p) => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Witnesses-Ordered.html#t:FL">FL</a> p)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> prim => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Patch-V1-Core.html#t:Patch">Patch</a> prim)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Darcs-Patch-Commute.html#t:Commute">Commute</a> p, <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> p) => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Patch-Named.html#t:Named">Named</a> p)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Darcs-Patch-Commute.html#t:Commute">Commute</a> p, <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> p) => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Patch-PatchInfoAnd.html#t:PatchInfoAnd">PatchInfoAnd</a> p)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> p => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (PatchChoice p)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> p => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Patch-Choices.html#t:TaggedPatch">TaggedPatch</a> p)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Darcs-Patch-Prim-Class.html#t:PrimPatch">PrimPatch</a> prim => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Patch-V2-Real.html#t:RealPatch">RealPatch</a> prim)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> a, <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> b) => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Witnesses-Ordered.html#t::-60-">:<</a> a b)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> a, <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> b) => <a href="Darcs-Witnesses-Eq.html#t:MyEq">MyEq</a> (<a href="Darcs-Witnesses-Ordered.html#t::-62-">:></a> a b)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:isIsEq" class="def">isIsEq</a> :: <a href="Darcs-Witnesses-Eq.html#t:EqCheck">EqCheck</a> a b -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Darcs-Witnesses-Eq.html#isIsEq" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
