# NAG FL Interfaceg07bff (estim_​genpareto)

## 1Purpose

g07bff estimates parameter values for the generalized Pareto distribution by using either moments or maximum likelihood.

## 2Specification

Fortran Interface
 Subroutine g07bff ( n, y, xi, beta, asvc, ll,
 Integer, Intent (In) :: n, optopt Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: y(n) Real (Kind=nag_wp), Intent (Out) :: xi, beta, asvc(4), obsvc(4), ll
#include <nag.h>
 void g07bff_ (const Integer *n, const double y[], const Integer *optopt, double *xi, double *beta, double asvc[], double obsvc[], double *ll, Integer *ifail)
The routine may be called by the names g07bff or nagf_univar_estim_genpareto.

## 3Description

Let the distribution function of a set of $n$ observations
 $yi , i=1,2,…,n$
be given by the generalized Pareto distribution:
 $Fy = 1- 1+ ξy β -1/ξ , ξ≠0 1-e-yβ , ξ=0;$
where
• $\beta >0$ and
• $y\ge 0$, when $\xi \ge 0$;
• $0\le y\le -\frac{\beta }{\xi }$, when $\xi <0$.
Estimates $\stackrel{^}{\xi }$ and $\stackrel{^}{\beta }$ of the parameters $\xi$ and $\beta$ are calculated by using one of:
• method of moments (MOM);
• probability-weighted moments (PWM);
• maximum likelihood estimates (MLE) that seek to maximize the log-likelihood:
 $L = -n ln⁡ β^ - 1+ 1ξ^ ∑ i=1 n ln 1+ ξ^yi β^ .$
The variances and covariance of the asymptotic Normal distribution of parameter estimates $\stackrel{^}{\xi }$ and $\stackrel{^}{\beta }$ are returned if $\stackrel{^}{\xi }$ satisfies:
• $\stackrel{^}{\xi }<\frac{1}{4}$ for the MOM;
• $\stackrel{^}{\xi }<\frac{1}{2}$ for the PWM method;
• $\stackrel{^}{\xi }<-\frac{1}{2}$ for the MLE method.
If the MLE option is exercised, the observed variances and covariance of $\stackrel{^}{\xi }$ and $\stackrel{^}{\beta }$ is returned, given by the negative inverse Hessian of $L$.
Hosking J R M and Wallis J R (1987) Parameter and quantile estimation for the generalized Pareto distribution Technometrics 29(3)
McNeil A J, Frey R and Embrechts P (2005) Quantitative Risk Management Princeton University Press

## 5Arguments

1: $\mathbf{n}$Integer Input
On entry: the number of observations.
Constraint: ${\mathbf{n}}>1$.
2: $\mathbf{y}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: the $n$ observations ${y}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$, assumed to follow a generalized Pareto distribution.
Constraints:
• ${\mathbf{y}}\left(i\right)\ge 0.0$;
• $\sum _{\mathit{i}=1}^{n}{\mathbf{y}}\left(i\right)>0.0$.
3: $\mathbf{optopt}$Integer Input
On entry: determines the method of estimation, set:
${\mathbf{optopt}}=-2$
For the method of probability-weighted moments.
${\mathbf{optopt}}=-1$
For the method of moments.
${\mathbf{optopt}}=1$
For maximum likelihood with starting values given by the method of moments estimates.
${\mathbf{optopt}}=2$
For maximum likelihood with starting values given by the method of probability-weighted moments.
Constraint: ${\mathbf{optopt}}=-2$, $-1$, $1$ or $2$.
4: $\mathbf{xi}$Real (Kind=nag_wp) Output
On exit: the parameter estimate $\stackrel{^}{\xi }$.
5: $\mathbf{beta}$Real (Kind=nag_wp) Output
On exit: the parameter estimate $\stackrel{^}{\beta }$.
6: $\mathbf{asvc}\left(4\right)$Real (Kind=nag_wp) array Output
On exit: the variance-covariance of the asymptotic Normal distribution of $\stackrel{^}{\xi }$ and $\stackrel{^}{\beta }$. ${\mathbf{asvc}}\left(1\right)$ contains the variance of $\stackrel{^}{\xi }$; ${\mathbf{asvc}}\left(4\right)$ contains the variance of $\stackrel{^}{\beta }$; ${\mathbf{asvc}}\left(2\right)$ and ${\mathbf{asvc}}\left(3\right)$ contain the covariance of $\stackrel{^}{\xi }$ and $\stackrel{^}{\beta }$.
7: $\mathbf{obsvc}\left(4\right)$Real (Kind=nag_wp) array Output
On exit: if maximum likelihood estimates are requested, the observed variance-covariance of $\stackrel{^}{\xi }$ and $\stackrel{^}{\beta }$. ${\mathbf{obsvc}}\left(1\right)$ contains the variance of $\stackrel{^}{\xi }$; ${\mathbf{obsvc}}\left(4\right)$ contains the variance of $\stackrel{^}{\beta }$; ${\mathbf{obsvc}}\left(2\right)$ and ${\mathbf{obsvc}}\left(3\right)$ contain the covariance of $\stackrel{^}{\xi }$ and $\stackrel{^}{\beta }$.
8: $\mathbf{ll}$Real (Kind=nag_wp) Output
On exit: if maximum likelihood estimates are requested, ll contains the log-likelihood value $L$ at the end of the optimization; otherwise ll is set to $-1.0$.
9: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}>1$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{y}}\left(〈\mathit{\text{value}}〉\right)=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{y}}\left(i\right)\ge 0.0$ for all $i$.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{optopt}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{optopt}}=-2$, $-1$, $1$ or $2$.
${\mathbf{ifail}}=6$
The asymptotic distribution is not available for the returned parameter estimates.
${\mathbf{ifail}}=7$
The distribution of maximum likelihood estimates cannot be calculated for the returned parameter estimates because the Hessian matrix could not be inverted.
${\mathbf{ifail}}=8$
The asymptotic distribution of parameter estimates is invalid and the distribution of maximum likelihood estimates cannot be calculated for the returned parameter estimates because the Hessian matrix could not be inverted.
${\mathbf{ifail}}=9$
The optimization of log-likelihood failed to converge; no maximum likelihood estimates are returned. Try using the other maximum likelihood option by resetting optopt. If this also fails, moments-based estimates can be returned by an appropriate setting of optopt.
${\mathbf{ifail}}=10$
Variance of data in y is too low for method of moments optimization.
${\mathbf{ifail}}=11$
The sum of y is zero within machine precision.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

Not applicable.

## 8Parallelism and Performance

g07bff is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g07bff makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

The search for maximum likelihood parameter estimates is further restricted by requiring
 $1+ ξ^yi β^ > 0 ,$
as this avoids the possibility of making the log-likelihood $L$ arbitrarily high.

## 10Example

This example calculates parameter estimates for $23$ observations assumed to be drawn from a generalized Pareto distribution.

### 10.1Program Text

Program Text (g07bffe.f90)

### 10.2Program Data

Program Data (g07bffe.d)

### 10.3Program Results

Program Results (g07bffe.r)