From 31dd36bc07861a492e457cf74cf5219045cbb31e Mon Sep 17 00:00:00 2001
From: Gabriel Studer <gabriel.studer@unibas.ch>
Date: Fri, 19 Oct 2018 14:29:36 +0200
Subject: [PATCH] document the DeNovoCloser
---
modelling/doc/monte_carlo.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/modelling/doc/monte_carlo.rst b/modelling/doc/monte_carlo.rst
index 91281f73..d0aad327 100644
--- a/modelling/doc/monte_carlo.rst
+++ b/modelling/doc/monte_carlo.rst
@@ -418,6 +418,19 @@ functionality of :class:`CloserBase`.
:returns: Whether closing was successful
+
+.. class:: DeNovoCloser
+
+ In case of sampling a full stretch, you dont have external constraints. The
+ closer has a rather boring job in this case.
+
+ .. method:: Close(actual_positions,closed_positions)
+
+ Does absolutely nothing, except copying over the coordinates from
+ *actual_positions* to *closed_positions* and return true.
+
+
+
.. _mc-scorer-object:
--
GitLab