paradox (version 0.1.0)

ParamInt: Integer Parameter

Description

A Param to describe integer parameters.

Arguments

Format

R6::R6Class object inheriting from Param.

Construction

ParamInt$new(id, lower = -Inf, upper = Inf, special_vals = list(), default = NO_DEF, tags = character())

Arguments of Param, and additionally:

  • lower :: numeric(1) Lower bound, can be -Inf.

  • upper :: numeric(1) Upper bound can be +Inf.

Fields

Fields of Param, and additionally:

  • lower :: numeric(1) Lower bound.

  • upper :: numeric(1) Upper bound.

  • levels :: NULL Allowed levels. Always NULL for this parameter.

  • nlevels :: integer(1) Number of categorical levels. Here, the number integers in the range [lower, upper], or Inf if unbounded.

  • is_bounded :: logical(1) Are the bounds finite?

Methods

See Param.

See Also

Other Params: ParamDbl, ParamFct, ParamLgl, ParamUty, Param

Examples

Run this code
# NOT RUN {
ParamInt$new("count", lower = 0, upper = 10, default = 1)
# }

Run the code above in your browser using DataLab