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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sample.R
\name{sampleValues}
\alias{sampleValues}
\title{Sample n random values from a parameter or a parameter set uniformly.}
\usage{
sampleValues(par, n, discrete.names = FALSE, trafo = FALSE)
}
\arguments{
\item{par}{(\link{Param} | \link{ParamSet})\cr
Parameter or parameter set.}
\item{n}{(\code{integer(1)})\cr
Number of values.}
\item{discrete.names}{(\code{logical(1)})\cr
Should names be sampled for discrete parameters or values instead?
Default is \code{FALSE}.}
\item{trafo}{(\code{logical(1)})\cr
Transform all parameters by using theirs respective transformation
functions. Default is \code{FALSE}.}
}
\value{
\code{list}. For consistency always a list is returned.
}
\description{
Sample n random values from a parameter or a parameter set uniformly.
Dependent parameters whose requirements are not satisfied are represented by a scalar NA in the output.
}
\examples{
p = makeIntegerParam("x", lower = -10, upper = 10)
sampleValues(p, 4)
p = makeNumericParam("x", lower = -10, upper = 10)
sampleValues(p, 4)
p = makeLogicalParam("x")
sampleValues(p, 4)
ps = makeParamSet(
makeNumericParam("u", lower = 1, upper = 10),
makeIntegerParam("v", lower = 1, upper = 10),
makeDiscreteParam("w", values = 1:2)
)
sampleValues(ps, 2)
}
|