NAG CL Interface
g07eac (robust_​1var_​ci)

Settings help

CL Name Style:


1 Purpose

g07eac computes a rank based (nonparametric) estimate and confidence interval for the location parameter of a single population.

2 Specification

#include <nag.h>
void  g07eac (Nag_RCIMethod method, Integer n, const double x[], double clevel, double *theta, double *thetal, double *thetau, double *estcl, double *wlower, double *wupper, NagError *fail)
The function may be called by the names: g07eac, nag_univar_robust_1var_ci or nag_rank_ci_1var.

3 Description

Consider a vector of independent observations, x= (x1,x2,,xn) T with unknown common symmetric density f(xi-θ). g07eac computes the Hodges–Lehmann location estimator (see Lehmann (1975)) of the centre of symmetry θ, together with an associated confidence interval. The Hodges–Lehmann estimate is defined as
θ^=median {xi+xj2,1ijn} .  
Let m=(n(n+1))/2 and let ak, for k=1,2,,m denote the m ordered averages (xi+xj)/2 for 1ijn. Then
This estimator arises from inverting the one-sample Wilcoxon signed-rank test statistic, W(x-θ0), for testing the hypothesis that θ=θ0. Effectively W(x-θ0) is a monotonically decreasing step function of θ0 with
mean ​(W)=μ= n(n+1)4, var(W)=σ2= n(n+1)(2n+1)24.  
The estimate θ^ is the solution to the equation W(x-θ^)=μ; two methods are available for solving this equation. These methods avoid the computation of all the ordered averages ak; this is because for large n both the storage requirements and the computation time would be excessive.
The first is an exact method based on a set partitioning procedure on the set of all ordered averages (xi+xj)/2 for ij. This is based on the algorithm proposed by Monahan (1984).
The second is an iterative algorithm, based on the Illinois method which is a modification of the regula falsi method, see McKean and Ryan (1977). This algorithm has proved suitable for the function W(x-θ0) which is asymptotically linear as a function of θ0.
The confidence interval limits are also based on the inversion of the Wilcoxon test statistic.
Given a desired percentage for the confidence interval, 1-α, expressed as a proportion between 0 and 1, initial estimates for the lower and upper confidence limits of the Wilcoxon statistic are found from
Wl=μ-0.5+(σΦ-1(α/2))  
and
Wu=μ+ 0.5+(σΦ-1(1-α/2)),  
where Φ-1 is the inverse cumulative Normal distribution function.
Wl and Wu are rounded to the nearest integer values. These estimates are then refined using an exact method if n80, and a Normal approximation otherwise, to find Wl and Wu satisfying
P(WWl)α/2 P(WWl+1)>α/2  
and
P(WWu)α /2 P(WWu-1)>α /2.  
Let Wu=m-k; then θl=ak+1. This is the largest value θl such that W(x-θl)=Wu.
Let Wl=k; then θu=am-k. This is the smallest value θu such that W(x-θu)=Wl.
As in the case of θ^, these equations may be solved using either the exact or the iterative methods to find the values θl and θu.
Then (θl,θu) is the confidence interval for θ. The confidence interval is thus defined by those values of θ0 such that the null hypothesis, θ=θ0, is not rejected by the Wilcoxon signed-rank test at the (100×α)% level.

4 References

Lehmann E L (1975) Nonparametrics: Statistical Methods Based on Ranks Holden–Day
Marazzi A (1987) Subroutines for robust estimation of location and scale in ROBETH Cah. Rech. Doc. IUMSP, No. 3 ROB 1 Institut Universitaire de Médecine Sociale et Préventive, Lausanne
McKean J W and Ryan T A (1977) Algorithm 516: An algorithm for obtaining confidence intervals and point estimates based on ranks in the two-sample location problem ACM Trans. Math. Software 10 183–185
Monahan J F (1984) Algorithm 616: Fast computation of the Hodges–Lehman location estimator ACM Trans. Math. Software 10 265–270

5 Arguments

1: method Nag_RCIMethod Input
On entry: specifies the method to be used.
method=Nag_RCI_Exact
The exact algorithm is used.
method=Nag_RCI_Approx
The iterative algorithm is used.
Constraint: method=Nag_RCI_Exact or Nag_RCI_Approx.
2: n Integer Input
On entry: n, the sample size.
Constraint: n2.
3: x[n] const double Input
On entry: the sample observations, xi, for i=1,2,,n.
4: clevel double Input
On entry: the confidence interval desired.
For example, for a 95% confidence interval set clevel=0.95.
Constraint: 0.0<clevel<1.0.
5: theta double * Output
On exit: the estimate of the location, θ^.
6: thetal double * Output
On exit: the estimate of the lower limit of the confidence interval, θl.
7: thetau double * Output
On exit: the estimate of the upper limit of the confidence interval, θu.
8: estcl double * Output
On exit: an estimate of the actual percentage confidence of the interval found, as a proportion between (0.0,1.0).
9: wlower double * Output
On exit: the upper value of the Wilcoxon test statistic, Wu, corresponding to the lower limit of the confidence interval.
10: wupper double * Output
On exit: the lower value of the Wilcoxon test statistic, Wl, corresponding to the upper limit of the confidence interval.
11: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_CONVERGENCE
The iterative procedure used to estimate θ has not converged. This is an unlikely exit but the estimate should still be a reasonable approximation.
The iterative procedure used to estimate, θl, the lower confidence limit has not converged. This is an unlikely exit but the estimate should still be a reasonable approximation.
The iterative procedure used to estimate, θu, the upper confidence limit has not converged. This is an unlikely exit but the estimate should still be a reasonable approximation.
NE_INT
On entry, n=value.
Constraint: n2.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_REAL
On entry, clevel=value.
Constraint: 0.0<clevel<1.0.
NE_SAMPLE_IDEN
Not enough information to compute an interval estimate since the whole sample is identical. The common value is returned in theta, thetal and thetau.

7 Accuracy

g07eac should produce results accurate to five significant figures in the width of the confidence interval; that is the error for any one of the three estimates should be less than 0.00001×(thetau-thetal).

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
g07eac 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The time taken increases with the sample size n.

10 Example

The following program calculates a 95% confidence interval for θ, a measure of symmetry of the sample of 50 observations.

10.1 Program Text

Program Text (g07eace.c)

10.2 Program Data

Program Data (g07eace.d)

10.3 Program Results

Program Results (g07eace.r)