From 6b8448e5f80a7fa623678c532d1cceba0d19ac11 Mon Sep 17 00:00:00 2001
From: Jaron Kent-Dobias <jaron@kent-dobias.com>
Date: Sat, 21 Jul 2018 13:47:01 -0400
Subject: made wolff-ising header files more pedogogical

---
 lib/z2.h | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)

(limited to 'lib/z2.h')

diff --git a/lib/z2.h b/lib/z2.h
index 599a6a5..dae1eb7 100644
--- a/lib/z2.h
+++ b/lib/z2.h
@@ -1,10 +1,21 @@
 
 #pragma once
 
-#include <gsl/gsl_rng.h>
 #include "types.h"
 #include "ising.h"
-#include "state.h"
+
+/* The minimum definition for a group type R_t to act on a spin type X_t is
+ * given by the following.
+ *
+ * void init(R_t *p);
+ * void free_spin(R_t r);
+ * R_t copy(R_t r);
+ * X_t act(R_t r, X_t x);
+ * R_t act(R_t r, R_t r);
+ * X_t act_inverse(R_t r, X_t x);
+ * R_t act_inverse(R_t r, R_t r);
+ *
+ */
 
 struct z2_t { bool x; };
 
@@ -52,13 +63,3 @@ z2_t act_inverse(z2_t r1, z2_t r2) {
   return act(r1, r2);
 }
 
-// these are all functions necessary for wolff.h
-
-z2_t generate_ising_rotation(gsl_rng *r, const state_t <z2_t, ising_t> *s) {
-  z2_t rot;
-  rot.x = true;
-  return rot;
-}
-
-
-
-- 
cgit v1.2.3-70-g09d2