From 3f5468e86b24ef3c58870a12fdac2a9ce01cbceb Mon Sep 17 00:00:00 2001
From: Mauricio Zambrano-Bigiarini <hzambran@users.noreply.github.com>
Date: Fri, 26 Oct 2012 20:38:32 +0000
Subject: [PATCH] hydroPSO.Rd: improced documentation for 'reltol' argument
---
man/hydroPSO.Rd | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/man/hydroPSO.Rd b/man/hydroPSO.Rd
index b75ea6e..5ab8f2e 100755
--- a/man/hydroPSO.Rd
+++ b/man/hydroPSO.Rd
@@ -130,7 +130,8 @@ numeric, absolute convergence tolerance. The algorithm stops if \code{gbest <= a
By default it is set to \code{-Inf} or \code{+Inf} for minimisation or maximisation problems, respectively
}
\item{reltol}{
-numeric, relative convergence tolerance. The algorithm stops if the absolute difference between the best \sQuote{personal best} in the current iteration and the best \sQuote{personal best} in the previous iteration is lower or equal to \code{reltol}. Defaults to \code{sqrt(.Machine$double.eps)}, typically, about 1e-8
+numeric, relative convergence tolerance. The algorithm stops if the absolute difference between the best \sQuote{personal best} in the current iteration and the best \sQuote{personal best} in the previous iteration is lower or equal to \code{reltol}. Defaults to \code{sqrt(.Machine$double.eps)}, typically, about 1e-8\cr
+If \code{reltol} is set to \code{0}, this stopping criterion is not used
}
\item{Xini.type}{
character, indicates how to initialise the particles' positions in the swarm within the ranges defined by \code{lower} and \code{upper}. Valid values are: \cr
--
GitLab