From c41db143c477b627c8c690b621f7bb514e08bbbf Mon Sep 17 00:00:00 2001 From: Jaron Kent-Dobias Date: Fri, 19 Oct 2018 11:05:06 -0400 Subject: polished up the documentation --- doc/models.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'doc/models.rst') diff --git a/doc/models.rst b/doc/models.rst index aa80ee6..e376e2e 100644 --- a/doc/models.rst +++ b/doc/models.rst @@ -3,8 +3,8 @@ Defining a Model **************** -To define your own model, you need a class for spin states, a class for spin transformations, a bond and site coupling, and a generator of transformations. - +To define your own model, you need a class for spin states, a class for spin transformations, a bond and site coupling, and a generator of transformations. Many examples of models can be found in the headers contained in :file:`wolff/models/`. + Spin States =========== @@ -23,18 +23,30 @@ Transformations The action of the transformation on a spin, returning the transformed spin. + :param const X_t&: The spin state to transform. + :returns: The transformed spin state. + .. cpp:function:: R_t act(const R_t&) The action of the transformation on another transformation, returning the transformed transformation. + :param const R_t&: The transformation state to transform. + :returns: The transformed spin state. + .. cpp:function:: X_t act_inverse(const X_t&) The action of the inverse transformation on a spin, returning the transformed spin. + :param const X_t&: The spin state to transform. + :returns: The transformed spin state. + .. cpp:function:: R_t act_inverse(const R_t&) The action of the inverse transformation on another transformation, returning the transformed transformation. + :param const R_t&: The transformation state to transform. + :returns: The transformed spin state. + Couplings ========= -- cgit v1.2.3-70-g09d2