validParameter-methods: Methods for function validParameter in Package 'RobExtremes'

In RobExtremes: Optimally Robust Estimation for Extreme Value Distributions

Methods for function validParameter in Package ‘RobExtremes’

Description

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

Usage

validParameter(object, ...)
## S4 method for signature 'GParetoFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'WeibullFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'GEVFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'ParetoFamily'
validParameter(object, param, tol=.Machine$double.eps)
## S4 method for signature 'GEVFamilyMuUnknown'
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

GParetoFamily

checks if both parameters are finite by is.finite, if their length is 1 or 2 (e.g. if one features as nuisance parameter), and if both are strictly larger than 0 (upto argument tol)

WeibullFamily

checks if both parameters are finite by is.finite, if their length is 1 or 2 (e.g. if one features as nuisance parameter), and if both are strictly larger than 0 (upto argument tol)

GEVFamily

checks if both parameters are finite by is.finite, if their length is 1 or 2 (e.g. if one features as nuisance parameter), and if both are strictly larger than 0 (upto argument tol)

GParetoFamily

checks if both parameters are finite by is.finite, if their length is 1 or 2 (e.g. if one features as nuisance parameter), and if both are strictly larger than 0 (upto argument tol)

GEVFamilyMuUnknown

checks if all parameters are finite by is.finite, if their length is in 1,2,3 (e.g. if one features as nuisance parameter), and scale and shape both are strictly larger than 0 (upto argument tol)

Value

logical of length 1 — valid or not

Examples

 G <- GParetoFamily()
 validParameter(G, c(scale=0.1, shape=2))
 validParameter(G, c(scale=-0.1, shape=-2))

RobExtremes documentation built on April 12, 2025, 2:31 a.m.