# NAG FL Interfaceg07bef (estim_​weibull)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

g07bef computes maximum likelihood estimates for parameters of the Weibull distribution from data which may be right-censored.

## 2Specification

Fortran Interface
 Subroutine g07bef ( cens, n, x, ic, beta, tol, corr, dev, nit, wk,
 Integer, Intent (In) :: n, ic(*), maxit Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: nit Real (Kind=nag_wp), Intent (In) :: x(n), tol Real (Kind=nag_wp), Intent (Inout) :: gamma Real (Kind=nag_wp), Intent (Out) :: beta, sebeta, segam, corr, dev, wk(n) Character (1), Intent (In) :: cens
#include <nag.h>
 void g07bef_ (const char *cens, const Integer *n, const double x[], const Integer ic[], double *beta, double *gamma, const double *tol, const Integer *maxit, double *sebeta, double *segam, double *corr, double *dev, Integer *nit, double wk[], Integer *ifail, const Charlen length_cens)
The routine may be called by the names g07bef or nagf_univar_estim_weibull.

## 3Description

g07bef computes maximum likelihood estimates of the parameters of the Weibull distribution from exact or right-censored data.
For $n$ realizations, ${y}_{i}$, from a Weibull distribution a value ${x}_{i}$ is observed such that
 $xi≤yi.$
There are two situations:
1. (a)exactly specified observations, when ${x}_{i}={y}_{i}$
2. (b)right-censored observations, known by a lower bound, when ${x}_{i}<{y}_{i}$.
The probability density function of the Weibull distribution, and hence the contribution of an exactly specified observation to the likelihood, is given by:
 $f(x;λ,γ)=λγxγ-1exp(-λxγ), x>0, for ​λ,γ>0;$
while the survival function of the Weibull distribution, and hence the contribution of a right-censored observation to the likelihood, is given by:
 $S(x;λ,γ)=exp(-λxγ), x> 0, for ​ λ ,γ> 0.$
If $d$ of the $n$ observations are exactly specified and indicated by $i\in D$ and the remaining $\left(n-d\right)$ are right-censored, then the likelihood function, $\text{Like ​}\left(\lambda ,\gamma \right)$ is given by
 $Like(λ,γ)∝(λγ)d (∏i∈Dxiγ-1) exp(-λ∑i=1nxiγ) .$
To avoid possible numerical instability a different parameterisation $\beta ,\gamma$ is used, with $\beta =\mathrm{log}\left(\lambda \right)$. The kernel log-likelihood function, $L\left(\beta ,\gamma \right)$, is then:
 $L(β,γ)=dlog(γ)+dβ+(γ-1)∑i∈Dlog(xi)-eβ∑i=1nxiγ.$
If the derivatives $\frac{\partial L}{\partial \beta }$, $\frac{\partial L}{\partial \gamma }$, $\frac{{\partial }^{2}L}{{\partial \beta }^{2}}$, $\frac{{\partial }^{2}L}{\partial \beta \partial \gamma }$ and $\frac{{\partial }^{2}L}{{\partial \gamma }^{2}}$ are denoted by ${L}_{1}$, ${L}_{2}$, ${L}_{11}$, ${L}_{12}$ and ${L}_{22}$, respectively, then the maximum likelihood estimates, $\stackrel{^}{\beta }$ and $\stackrel{^}{\gamma }$, are the solution to the equations:
 $L1(β^,γ^)=0$ (1)
and
 $L2(β^,γ^)=0$ (2)
Estimates of the asymptotic standard errors of $\stackrel{^}{\beta }$ and $\stackrel{^}{\gamma }$ are given by:
 $se(β^)=-L22 L11L22-L122 , se(γ^)=-L11 L11L22-L122 .$
An estimate of the correlation coefficient of $\stackrel{^}{\beta }$ and $\stackrel{^}{\gamma }$ is given by:
 $L12L12L22 .$
Note:  if an estimate of the original parameter $\lambda$ is required, then
 $λ^=exp(β^) and se(λ^)=λ^se(β^).$
The equations (1) and (2) are solved by the Newton–Raphson iterative method with adjustments made to ensure that $\stackrel{^}{\gamma }>0.0$.

## 4References

Gross A J and Clark V A (1975) Survival Distributions: Reliability Applications in the Biomedical Sciences Wiley
Kalbfleisch J D and Prentice R L (1980) The Statistical Analysis of Failure Time Data Wiley

## 5Arguments

1: $\mathbf{cens}$Character(1) Input
On entry: indicates whether the data is censored or non-censored.
${\mathbf{cens}}=\text{'N'}$
Each observation is assumed to be exactly specified. ic is not referenced.
${\mathbf{cens}}=\text{'C'}$
Each observation is censored according to the value contained in ${\mathbf{ic}}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,n$.
Constraint: ${\mathbf{cens}}=\text{'N'}$ or $\text{'C'}$.
2: $\mathbf{n}$Integer Input
On entry: $n$, the number of observations.
Constraint: ${\mathbf{n}}\ge 1$.
3: $\mathbf{x}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: ${\mathbf{x}}\left(\mathit{i}\right)$ contains the $\mathit{i}$th observation, ${x}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$.
Constraint: ${\mathbf{x}}\left(\mathit{i}\right)>0.0$, for $\mathit{i}=1,2,\dots ,n$.
4: $\mathbf{ic}\left(*\right)$Integer array Input
Note: the dimension of the array ic must be at least ${\mathbf{n}}$ if ${\mathbf{cens}}=\text{'C'}$, and at least $1$ otherwise.
On entry: if ${\mathbf{cens}}=\text{'C'}$, ${\mathbf{ic}}\left(\mathit{i}\right)$ contains the censoring codes for the $\mathit{i}$th observation, for $\mathit{i}=1,2,\dots ,n$.
If ${\mathbf{ic}}\left(i\right)=0$, the $i$th observation is exactly specified.
If ${\mathbf{ic}}\left(i\right)=1$, the $i$th observation is right-censored.
If ${\mathbf{cens}}=\text{'N'}$, ic is not referenced.
Constraint: if ${\mathbf{cens}}=\text{'C'}$, then ${\mathbf{ic}}\left(\mathit{i}\right)=0$ or $1$, for $\mathit{i}=1,2,\dots ,n$.
5: $\mathbf{beta}$Real (Kind=nag_wp) Output
On exit: the maximum likelihood estimate, $\stackrel{^}{\beta }$, of $\beta$.
6: $\mathbf{gamma}$Real (Kind=nag_wp) Input/Output
On entry: indicates whether an initial estimate of $\gamma$ is provided.
If ${\mathbf{gamma}}>0.0$, it is taken as the initial estimate of $\gamma$ and an initial estimate of $\beta$ is calculated from this value of $\gamma$.
If ${\mathbf{gamma}}\le 0.0$, initial estimates of $\gamma$ and $\beta$ are calculated, internally, providing the data contains at least two distinct exact observations. (If there are only two distinct exact observations, the largest observation must not be exactly specified.) See Section 9 for further details.
On exit: contains the maximum likelihood estimate, $\stackrel{^}{\gamma }$, of $\gamma$.
7: $\mathbf{tol}$Real (Kind=nag_wp) Input
On entry: the relative precision required for the final estimates of $\beta$ and $\gamma$. Convergence is assumed when the absolute relative changes in the estimates of both $\beta$ and $\gamma$ are less than tol.
If ${\mathbf{tol}}=0.0$, a relative precision of $0.000005$ is used.
Constraint: or ${\mathbf{tol}}=0.0$.
8: $\mathbf{maxit}$Integer Input
On entry: the maximum number of iterations allowed.
If ${\mathbf{maxit}}\le 0$, a value of $25$ is used.
9: $\mathbf{sebeta}$Real (Kind=nag_wp) Output
On exit: an estimate of the standard error of $\stackrel{^}{\beta }$.
10: $\mathbf{segam}$Real (Kind=nag_wp) Output
On exit: an estimate of the standard error of $\stackrel{^}{\gamma }$.
11: $\mathbf{corr}$Real (Kind=nag_wp) Output
On exit: an estimate of the correlation between $\stackrel{^}{\beta }$ and $\stackrel{^}{\gamma }$.
12: $\mathbf{dev}$Real (Kind=nag_wp) Output
On exit: the maximized kernel log-likelihood, $L\left(\stackrel{^}{\beta },\stackrel{^}{\gamma }\right)$.
13: $\mathbf{nit}$Integer Output
On exit: the number of iterations performed.
14: $\mathbf{wk}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Workspace
15: $\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{cens}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{cens}}=\text{'N'}$ or $\text{'C'}$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 1$.
On entry, ${\mathbf{tol}}=⟨\mathit{\text{value}}⟩$.
Constraint: or ${\mathbf{tol}}=0.0$.
${\mathbf{ifail}}=2$
On entry, $i=⟨\mathit{\text{value}}⟩$ and ${\mathbf{ic}}\left(i\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ic}}\left(i\right)=0$ or $1$.
On entry, $i=⟨\mathit{\text{value}}⟩$ and ${\mathbf{x}}\left(i\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{x}}\left(i\right)>0.0$.
${\mathbf{ifail}}=3$
On entry, there are no exactly specified observations.
Unable to calculate initial values. This is due to there being either less than two distinct exactly specified observations or exactly two and the largest observation is one of the exact observations.
${\mathbf{ifail}}=4$
The chosen method has not converged in $⟨\mathit{\text{value}}⟩$ iterations. You should either increase tol or maxit.
${\mathbf{ifail}}=5$
Hessian matrix of the Newton–Raphson process is singular. Either different initial estimates should be provided or the data should be checked to see if the Weibull distribution is appropriate.
The process has diverged. The process is deemed divergent if three successive increments of $\beta$ or $\gamma$ increase. Either different initial estimates should be provided or the data should be checked to see if the Weibull distribution is appropriate.
${\mathbf{ifail}}=6$
Potential overflow detected. This is an unlikely error exit usually caused by a large input estimate of $\gamma$.
${\mathbf{ifail}}=-99$
An unexpected error has been triggered by this routine. Please contact NAG.
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.

## 7Accuracy

Given that the Weibull distribution is a suitable model for the data and that the initial values are reasonable the convergence to the required accuracy, indicated by tol, should be achieved.

## 8Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
g07bef is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
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 initial estimate of $\gamma$ is found by calculating a Kaplan–Meier estimate of the survival function, $\stackrel{^}{S}\left(x\right)$, and estimating the gradient of the plot of $\mathrm{log}\left(-\mathrm{log}\left(\stackrel{^}{S}\left(x\right)\right)\right)$ against $x$. This requires the Kaplan–Meier estimate to have at least two distinct points.
The initial estimate of $\stackrel{^}{\beta }$, given a value of $\stackrel{^}{\gamma }$, is calculated as
 $β^=log(d∑i=1nxiγ^ ) .$

## 10Example

In a study, $20$ patients receiving an analgesic to relieve headache pain had the following recorded relief times (in hours):
(See Gross and Clark (1975).) This data is read in and a Weibull distribution fitted assuming no censoring; the parameter estimates and their standard errors are printed.

### 10.1Program Text

Program Text (g07befe.f90)

### 10.2Program Data

Program Data (g07befe.d)

### 10.3Program Results

Program Results (g07befe.r)