summaryrefslogtreecommitdiff
path: root/man/optimOptions.Rd
diff options
context:
space:
mode:
authorSuraj Yerramilli2016-02-15 22:05:37 +0530
committerSuraj Yerramilli2016-02-15 22:05:37 +0530
commite8a1dbb636058ae1b542428fb0973a6319553f9f (patch)
treee7491c19e1be0e1ae9be1489ff1cb0b047c28797 /man/optimOptions.Rd
parent1f8a4a5df91140c98baf0d4ece22ad4589923b37 (diff)
downloadSysID-R-code-e8a1dbb636058ae1b542428fb0973a6319553f9f.tar.gz
SysID-R-code-e8a1dbb636058ae1b542428fb0973a6319553f9f.tar.bz2
SysID-R-code-e8a1dbb636058ae1b542428fb0973a6319553f9f.zip
document + argument update
Diffstat (limited to 'man/optimOptions.Rd')
-rw-r--r--man/optimOptions.Rd14
1 files changed, 8 insertions, 6 deletions
diff --git a/man/optimOptions.Rd b/man/optimOptions.Rd
index 067ded3..1d77f64 100644
--- a/man/optimOptions.Rd
+++ b/man/optimOptions.Rd
@@ -4,19 +4,21 @@
\alias{optimOptions}
\title{Create optimization options}
\usage{
-optimOptions(tol = 0.001, maxIter = 20, LMinit = 0.01, LMstep = 2)
+optimOptions(tol = 0.01, maxIter = 20, LMinit = 0.01, LMstep = 2,
+ display = c("off", "on")[1])
}
\arguments{
-\item{tol}{Minimum ratio of the improvement to the current loss
-function. Iterations stop if this ratio goes below the tolerance
-limit (Default: \code{1e-5})}
+\item{tol}{Minimum 2-norm of the gradient (Default: \code{1e-2})}
\item{maxIter}{Maximum number of iterations to be performed}
\item{LMinit}{Starting value of search-direction length
-in the Levenberg-Marquardt method.}
+in the Levenberg-Marquardt method (Default: \code{0.01})}
-\item{LMstep}{Size of the Levenberg-Marquardt step}
+\item{LMstep}{Size of the Levenberg-Marquardt step (Default: \code{2})}
+
+\item{display}{Argument whether to display iteration details or not
+(Default: \code{"off"})}
}
\description{
Specify optimization options that are to be passed to the