strategy: wip traversal.

[topbloke-formulae.git] / notation.tex

diff --git a/notation.tex b/notation.tex
index e5212fa43804240793e060e44f381fb7e8f8ef9b..19cf243733e1a9ba8edce18d7d7a70a8e0fb1097 100644 (file)
--- a/notation.tex
+++ b/notation.tex
@@ -1,4 +1,7 @@
-\section{Notation}
+\stdsection{Notation}
+
+Throughout, any free variables are implicitly universally quantified
+at the outermost level.
 
 \begin{basedescript}{
 \desclabelwidth{5em}
@@ -27,12 +30,21 @@ A patch $\p$ consists of two sets of commits $\pn$ and $\py$, which
 are respectively the base and tip git branches.  $\p$ may be used
 where the context requires a set, in which case the statement
 is to be taken as applying to both $\py$ and $\pn$.
-All of these sets are disjoint.  Hence:
+All of these sets will be disjoint by construction
+(see Invariants, below).
+
+\item[ $\foreign$ ]
+The set of all commits which are not part of a Topbloke branch.  We
+call these foreign commits.  Hence:
 
 \item[ $ \patchof{ C } $ ]
-Either $\p$ s.t. $ C \in \p $, or $\bot$.
+Either $\p$ s.t. $ C \in \p $, or $\foreign$.
 A function from commits to patches' sets $\p$.
 
+\item[ $\set A$, $\set P$, $\ldots$ ]
+Arbitrary sets of commits.  Maybe $\set P = \p$ i.e.\ some $\py$ or $\pn$, but
+maybe not.
+
 \item[ $ \pancsof{C}{\set P} $ ]
 $ \{ A \; | \; A \le C \land A \in \set P \} $
 i.e. all the ancestors of $C$
@@ -58,11 +70,13 @@ $\displaystyle \bigforall_{D \in \py} D \isin C \equiv D \le C $.
 ~ Informally, $C$ has all the reachable contents of $\p$.
 
 \item[ $ C \haspatch \p $ ]
-$\displaystyle C \zhaspatch \p \land \exists_{D \in \py} D \le C $.
+$\displaystyle C \zhaspatch \p \land \exists_{F \in \py} F \le C $.
 ~ Informally, $C$ nontrivially has all the reachable contents of $\p$.
 
-Note that $\zhaspatch$ and $\nothaspatch$ are not mutually exclusive.
-$\haspatch$ and $\nothaspatch$ are.
+Note that $\zhaspatch$ and $\nothaspatch$ are neither
+mutually exclusive nor exhaustive.
+$\haspatch$ and $\nothaspatch$ are mutually exclusive but not
+necessarily exhaustive.
 
 Commits on Non-Topbloke branches are $\nothaspatch \p$ for all $\p$.  This
 includes commits on plain git branches made by applying a Topbloke
@@ -72,15 +86,41 @@ the relevant Topbloke branches, we hope that
 if the user still cares about the Topbloke patch,
 git's merge algorithm will DTRT when trying to re-apply the changes.
 
-\item[ $\displaystyle \mergeof{C}{L}{M}{R} $ ]
-The contents of a git merge result:
+\item[ $\displaystyle \stmtmergeof{L}{M}{R} $ ]
+The proper results of a merge.  Formally,
+where $L$, $M$ and $R$ are statements:
+$$
+  \stmtmergeof{L}{M}{R}
+    \equiv
+  \begin{cases}
+         (L \land R)      : & \true \\
+    (\neg L \land \neg R) : & \false \\
+    \text{otherwise} : & \neg M
+  \end{cases}
+$$
+
+May also be used where $L$, $M$ and $R$ are sets, in which case
+$$
+  \setmergeof{L}{M}{R}
+     =
+  \left\{
+    \;
+    D \; \middle| \;
+      \setmergeof{ D \in L }{ D \in M }{ D \in R }
+    \;
+  \right\}
+$$
+
+\item[ $\displaystyle \commitmergeof{C}{L}{M}{R} $ ]
+$C$ has exactly the contents of a git merge result:
 
 $\displaystyle D \isin C \equiv
   \begin{cases}
-    (D \isin L \land D \isin R) \lor D = C : & \true \\
-    (D \not\isin L \land D \not\isin R) \land D \neq C : & \false \\
-    \text{otherwise} : & D \not\isin M
+    D = C : & \true \\
+    D \neq C : & \stmtmergeof{ D \isin L }{ D \isin M }{ D \isin R }
   \end{cases}
 $
 
+We will refer to this as \commitmergename.
+
 \end{basedescript}