GEVParameter-class {RobExtremes}R Documentation

Parameter of generalized Pareto distributions

Description

The class of the parameter of generalized Pareto distribution.

Objects from the Class

Objects can be created by calls of the form new("GEVParameter", ...).

Slots

loc

real number: location parameter of a GEV distribution.

scale

real number: scale parameter of a GEV distribution.

shape

real number: shape parameter of a GEV distribution.

name

default name is “parameter of a GEV distribution”.

Extends

Class "Parameter", directly.
Class "OptionalParameter", by class "Parameter".

Methods

loc

signature(object = "GEVParameter"): access method for slot loc.

location

signature(object = "GEVParameter"): alias to loc, to support argument naming of package VGAM.

scale

signature(object = "GEVParameter"): access method for slot scale.

shape

signature(object = "GEVParameter"): access method for slot shape.

loc<-

signature(object = "GEVParameter"): replace method for slot loc.

location<-

signature(object = "GEVParameter"): alias to loc<-, to support argument naming of package VGAM.

shape<-

signature(object = "GEVParameter"): replace method for slot shape.

shape<-

signature(object = "GEVParameter"): replace method for slot shape.

Author(s)

Nataliya Horbenko nhorbenko@gmail.com

See Also

GEV-class, Parameter-class

Examples

P <- new("GEVParameter")
loc(P)
## same as
location(P)
scale(P)
shape(P)

scale(P) <- 2
location(P) <- 4
shape(P) <- -1 # may be negative!
P

[Package RobExtremes version 1.3.0 Index]