distrMod: validParameter-methods – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

validParameter-methods

Methods for function validParameter in Package ‘distrMod’

Description

Methods for function validParameter in package distrMod to check whether a new parameter (e.g. "proposed" by an optimization) is valid.

Usage

validParameter(object, ...)
## S4 method for signature 'ParamFamily'
validParameter(object, param)
## S4 method for signature 'L2ScaleUnion'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'L2ScaleFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'L2LocationFamily'
validParameter(object, param)
## S4 method for signature 'L2LocationScaleFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'BinomFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'PoisFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'L2ScaleShapeUnion'
validParameter(object, param, tol=.Machine$double.eps)

Arguments

`object`	an object of class `ParamFamily`
`param`	either a numeric vector or an object of class `ParamFamParameter`
`tol`	accuracy upto which the conditions have to be fulfilled
`...`	additional argument(s) for methods.

Details

method for signature

ParamFamily: checks if all parameters are finite by is.finite if their length is between 1 and the joint length of main and nuisance parameter of object, and finally, if a call to modifyParam(object) with argument param would throw an error.
L2ScaleUnion: checks if the parameter is finite by is.finite, and if it is strictly larger than 0 (upto argument tol).
L2ScaleFamily: checks if the parameter length is 1, and otherwise uses L2ScaleUnion-method.
L2LocationFamily: checks if the parameter is finite by is.finite, if its length is 1
L2LocationScaleFamily: checks if the parameter length is 1 or 2 (e.g. if one features as nuisance parameter), and also uses L2ScaleUnion-method.
BinomFamily: checks if the parameter is finite by is.finite, if its length is 1, and if it is strictly larger than 0 and strictly smaller than 1 (upto argument tol)
PoisFamily: checks if the parameter is finite by is.finite, if its length is 1, and if it is strictly larger than 0 (upto argument tol)
L2ScaleShapeUnion: uses L2ScaleUnion-method, checks if parameter length is 1 or 2 (e.g. if one features as nuisance parameter), and if shape is strictly larger than 0 (upto argument tol)

Value

logical of length 1 — valid or not

Examples

NS <- NormLocationScaleFamily()
 validParameter(NS, c(scale=0.1, loc=2))
 validParameter(NS, c(scale=-0.1, loc=2))
 validParameter(NS, c(scale=0, loc=2))
 validParameter(NS, c(mean=2, sd=2))

distrMod

Object Oriented Implementation of Probability Models

v2.8.4

LGPL-3

Authors

Matthias Kohl [aut, cph], Peter Ruckdeschel [cre, cph], R Core Team [ctb, cph] (for source file 'format.perc')

Initial release

2020-03-06