A Param to describe integer parameters.
See Param.
paradox::Param -> ParamInt
lower(numeric(1))
Lower bound.
Always NA for ParamFct, ParamLgl and ParamUty.
upper(numeric(1))
Upper bound.
Always NA for ParamFct, ParamLgl and ParamUty.
levels(character() | NULL)
Set of allowed levels.
Always NULL for ParamDbl, ParamInt and ParamUty.
Always c(TRUE, FALSE) for ParamLgl.
nlevels(integer(1) | Inf)
Number of categorical levels.
Always Inf for ParamDbl and ParamUty.
The number of integers in the range [lower, upper], or Inf if unbounded for ParamInt.
Always 2 for ParamLgl.
is_bounded(logical(1))
Are the bounds finite?
Always TRUE for ParamFct and ParamLgl.
Always FALSE for ParamUty.
storage_type(character(1))
Data type when values of this parameter are stored in a data table or sampled.
Always "numeric" for ParamDbl.
Always "character" for ParamFct.
Always "integer" for ParamInt.
Always "logical" for ParamLgl.
Always "list" for ParamUty.
new()Creates a new instance of this R6 class.
ParamInt$new(
id,
lower = -Inf,
upper = Inf,
special_vals = list(),
default = NO_DEF,
tags = character()
)id(character(1))
Identifier of the object.
lower(numeric(1))
Lower bound, can be -Inf.
upper(numeric(1))
Upper bound can be +Inf.
special_vals(list())
Arbitrary special values this parameter is allowed to take, to make it
feasible. This allows extending the domain of the parameter. Note that
these values are only used in feasibility checks, neither in generating
designs nor sampling.
default(any)
Default value. Can be from the domain of the parameter or an element of
special_vals. Has value NO_DEF if no default exists. NULL can be a
valid default.
The value has no effect on ParamSet$values or the behavior of
ParamSet$check(), $test() or $assert().
The default is intended to be used for documentation purposes.
`
tags(character())
Arbitrary tags to group and subset parameters. Some tags serve a special
purpose:
"required" implies that the parameters has to be given when setting
values in ParamSet.
convert()Converts a value to an integer.
ParamInt$convert(x)x(numeric(1))
Value to convert.
clone()The objects of this class are cloneable with this method.
ParamInt$clone(deep = FALSE)deepWhether to make a deep clone.
Other Params:
ParamDbl,
ParamFct,
ParamLgl,
ParamUty,
Param
ParamInt$new("count", lower = 0, upper = 10, default = 1)
Run the code above in your browser using DataLab