summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJaron Kent-Dobias <jaron@kent-dobias.com>2018-10-19 14:09:13 -0400
committerJaron Kent-Dobias <jaron@kent-dobias.com>2018-10-19 14:09:13 -0400
commit48dbbcff78944628b56d98a663f682e91023245c (patch)
tree77912419432c3feaa6a7d5b19c4baa76a64eeb0e /doc
parenta3ad099281e0f608d0bcfda178502fb41acd8c5b (diff)
downloadc++-48dbbcff78944628b56d98a663f682e91023245c.tar.gz
c++-48dbbcff78944628b56d98a663f682e91023245c.tar.bz2
c++-48dbbcff78944628b56d98a663f682e91023245c.zip
added examples for no field and site depedence
Diffstat (limited to 'doc')
-rw-r--r--doc/examples.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/examples.rst b/doc/examples.rst
index 71b70ce..9f07d67 100644
--- a/doc/examples.rst
+++ b/doc/examples.rst
@@ -3,7 +3,9 @@
Examples
********
-Several examples are included in the directory :file:`examples/`. The simplist, standalone example of measuring the average cluster size of an Ising model is provided in full below, demonstrating how to define a model, measurement, couplings, and initialize the algorithm.
+Several examples are included in the directory :file:`examples/`, including using site dependent fields, compiling without a field, using the same spin type for multiple transformation types, and more.
+
+The simplist, standalone example :file:`examples/ising_standalone.cpp` of measuring the average cluster size of an Ising model is provided in full below, demonstrating how to define a model, measurement, couplings, and initialize the algorithm.
.. literalinclude:: ../examples/ising_standalone.cpp
:language: cpp