1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/OptPath_setter.R
\name{addOptPathEl}
\alias{addOptPathEl}
\title{Add a new element to an optimization path.}
\usage{
addOptPathEl(
op,
x,
y,
dob = getOptPathLength(op) + 1L,
eol = as.integer(NA),
error.message = NA_character_,
exec.time = NA_real_,
extra = NULL,
check.feasible = !op$add.transformed.x
)
}
\arguments{
\item{op}{\link{OptPath}\cr
Optimization path.}
\item{x}{(\code{list})\cr
List of parameter values for a point in input space. Must be in same order
as parameters.}
\item{y}{(\code{numeric})\cr
Vector of fitness values. Must be in same order as \code{y.names}.}
\item{dob}{(\code{integer(1)})\cr
Date of birth of the new parameters.
Default is length of path + 1.}
\item{eol}{(\code{integer(1)})\cr
End of life of point.
Default is \code{NA}.}
\item{error.message}{(\code{character(1)})\cr
Possible error message that occurred for this parameter values.
Default is \code{NA}.}
\item{exec.time}{(\code{numeric(1)})\cr
Possible exec time for this evaluation.
Default is \code{NA}.}
\item{extra}{(\code{list})\cr
Possible list of extra values to store.
The list must be fully named. The list can contain nonscalar values, but
these nonscalar entries must have a name starting with a dot (\code{.}).
Other entries must be scalar, and must be in the same order of all calls of
\code{addOptPathEl}.
Watch out: if \code{include.extra} was set to \code{TRUE} in (makeOptPathDF())
the list of extras is mandatory.
Default is \code{NULL}.}
\item{check.feasible}{(\code{logical(1)})\cr
Should \code{x} be checked with (isFeasible())?
Default is \code{TRUE}.}
}
\value{
Nothing.
}
\description{
Changes the argument in-place. Note that when adding parameters that have
associated transformations, it is probably best to add the untransformed
values to the path. Otherwise you have to switch off the feasibility check,
as constraints might now not hold anymore.
Dependent parameters whose requirements are not satisfied must be represented
by a scalar NA in the input.
}
\examples{
ps = makeParamSet(
makeNumericParam("p1"),
makeDiscreteParam("p2", values = c("a", "b"))
)
op = makeOptPathDF(par.set = ps, y.names = "y", minimize = TRUE)
addOptPathEl(op, x = list(p1 = 7, p2 = "b"), y = 1)
addOptPathEl(op, x = list(p1 = -1, p2 = "a"), y = 2)
as.data.frame(op)
}
\seealso{
Other optpath:
\code{\link{OptPath}},
\code{\link{getOptPathBestIndex}()},
\code{\link{getOptPathCol}()},
\code{\link{getOptPathCols}()},
\code{\link{getOptPathDOB}()},
\code{\link{getOptPathEOL}()},
\code{\link{getOptPathEl}()},
\code{\link{getOptPathErrorMessages}()},
\code{\link{getOptPathExecTimes}()},
\code{\link{getOptPathLength}()},
\code{\link{getOptPathParetoFront}()},
\code{\link{getOptPathX}()},
\code{\link{getOptPathY}()},
\code{\link{setOptPathElDOB}()},
\code{\link{setOptPathElEOL}()}
}
\concept{optpath}
|