From e2e897db89d4746a996da0727414d8666380b9f9 Mon Sep 17 00:00:00 2001
From: Philip Mueller <philip.paul.mueller@bluemain.ch>
Date: Sat, 17 Aug 2019 14:56:15 +0200
Subject: [PATCH] Added a section to the manual that explains how the applying
condition function works.
---
doc/manual/manual/yggdrasil_manual.tex | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/doc/manual/manual/yggdrasil_manual.tex b/doc/manual/manual/yggdrasil_manual.tex
index b37e1a76..cc6e0bab 100644
--- a/doc/manual/manual/yggdrasil_manual.tex
+++ b/doc/manual/manual/yggdrasil_manual.tex
@@ -2834,6 +2834,20 @@ The interface is called \pyYggdrasil .
Supported are single sample as well as the three containers.
% END: Expanding
+ %%%%%%%%%%%%%%%%%%%%%%%%%
+
+
+ \paragraph{Applying the Conditions}
+ Assume you have a bunch of sample, either one sample or a sample container.
+ The samples are not conforming to the conditions.
+ Because the samples have wrong values in the conditioned dimensions.
+ Now you want to set these values to the ones that are forced by the condition.
+ For that the \texttt{applyConditions()} function family is provided.
+
+ From a technical perspective these function is equivalent in first restricting the samples and then expanding it.
+ But no temporary container is constructed.
+ The argument is just modified.
+
% END: Restricted and Full Samples
%%%%%%%%%%%%%%%%%%%%%%%%%%%
--
GitLab