NAG Library Routine Document

g02bnf (coeffs_kspearman_overwrite)


g02bnf computes Kendall and/or Spearman nonparametric rank correlation coefficients for a set of data; the data array is overwritten with the ranks of the observations.


Fortran Interface
Subroutine g02bnf ( n, m, x, ldx, itype, rr, ldrr, kworka, kworkb, work1, work2, ifail)
Integer, Intent (In):: n, m, ldx, itype, ldrr
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: kworka(n), kworkb(n)
Real (Kind=nag_wp), Intent (Inout):: x(ldx,m), rr(ldrr,m)
Real (Kind=nag_wp), Intent (Out):: work1(m), work2(m)
C Header Interface
#include <nagmk26.h>
void  g02bnf_ (const Integer *n, const Integer *m, double x[], const Integer *ldx, const Integer *itype, double rr[], const Integer *ldrr, Integer kworka[], Integer kworkb[], double work1[], double work2[], Integer *ifail)


The input data consists of n observations for each of m variables, given as an array
xij,  i=1,2,,n n2,j=1,2,,mm2,  
where xij is the ith observation of the jth variable.
The quantities calculated are:
(a) Ranks
For a given variable, j say, each of the n observations, x1j,x2j,,xnj, has associated with it an additional number, the ‘rank’ of the observation, which indicates the magnitude of that observation relative to the magnitudes of the other n-1 observations on that same variable.
The smallest observation for variable j is assigned the rank 1, the second smallest observation for variable j the rank 2, the third smallest the rank 3, and so on until the largest observation for variable j is given the rank n.
If a number of cases all have the same value for the given variable, j, then they are each given an ‘average’ rank, e.g., if in attempting to assign the rank h+1, k observations were found to have the same value, then instead of giving them the ranks
all k observations would be assigned the rank
and the next value in ascending order would be assigned the rank
h+k+ 1.  
The process is repeated for each of the m variables.
Let yij be the rank assigned to the observation xij when the jth variable is being ranked. The actual observations xij are replaced by the ranks yij.
(b) Nonparametric rank correlation coefficients
(i) Kendall's tau:
Rjk=h=1ni=1nsignyhj-yijsignyhk-yik nn-1-Tjnn-1-Tk ,  j,k=1,2,,m,  
where signu=1 if u>0,
signu=0 if u=0,
signu=-1 if u<0,
and Tj=tjtj-1, where tj is the number of ties of a particular value of variable j, and the summation is over all tied values of variable j.
(ii) Spearman's:
Rjk*=nn2-1-6i=1n yij-yik 2-12Tj*+Tk* nn2-1-Tj*nn2-1-Tk* ,  j,k=1,2,,m,  
where Tj*=tjtj2-1, tj being the number of ties of a particular value of variable j, and the summation being over all tied values of variable j.


Siegel S (1956) Non-parametric Statistics for the Behavioral Sciences McGraw–Hill


1:     n – IntegerInput
On entry: n, the number of observations or cases.
Constraint: n2.
2:     m – IntegerInput
On entry: m, the number of variables.
Constraint: m2.
3:     xldxm – Real (Kind=nag_wp) arrayInput/Output
On entry: xij must be set to xij, the value of the ith observation on the jth variable, for i=1,2,,n and j=1,2,,m.
On exit: xij contains the rank yij of the observation xij, for i=1,2,,n and j=1,2,,m.
4:     ldx – IntegerInput
On entry: the first dimension of the array x as declared in the (sub)program from which g02bnf is called.
Constraint: ldxn.
5:     itype – IntegerInput
On entry: the type of correlation coefficients which are to be calculated.
Only Kendall's tau coefficients are calculated.
Both Kendall's tau and Spearman's coefficients are calculated.
Only Spearman's coefficients are calculated.
Constraint: itype=-1, 0 or 1.
6:     rrldrrm – Real (Kind=nag_wp) arrayOutput
On exit: the requested correlation coefficients.
If only Kendall's tau coefficients are requested (itype=-1), rrjk contains Kendall's tau for the jth and kth variables.
If only Spearman's coefficients are requested (itype=1), rrjk contains Spearman's rank correlation coefficient for the jth and kth variables.
If both Kendall's tau and Spearman's coefficients are requested (itype=0), the upper triangle of rr contains the Spearman coefficients and the lower triangle the Kendall coefficients. That is, for the jth and kth variables, where j is less than k, rrjk contains the Spearman rank correlation coefficient, and rrkj contains Kendall's tau, for j=1,2,,m and k=1,2,,m.
(Diagonal terms, rrjj, are unity for all three values of itype.)
7:     ldrr – IntegerInput
On entry: the first dimension of the array rr as declared in the (sub)program from which g02bnf is called.
Constraint: ldrrm.
8:     kworkan – Integer arrayWorkspace
9:     kworkbn – Integer arrayWorkspace
10:   work1m – Real (Kind=nag_wp) arrayWorkspace
11:   work2m – Real (Kind=nag_wp) arrayWorkspace
12:   ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 or 1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1 or 1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

Error Indicators and Warnings

If on entry 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:
On entry, n=value.
Constraint: n2.
On entry, m=value.
Constraint: m2.
On entry, ldrr=value and m=value.
Constraint: ldrrm.
On entry, ldx=value and n=value.
Constraint: ldxn.
On entry, itype=value.
Constraint: itype=-1 or 1.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.


The method used is believed to be stable.

Parallelism and Performance

g02bnf 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.

Further Comments

The time taken by g02bnf depends on n and m.


This example reads in a set of data consisting of nine observations on each of three variables. The program then calculates and prints the rank of each observation, and both Kendall's tau and Spearman's rank correlation coefficients for all three variables.

Program Text

Program Text (g02bnfe.f90)

Program Data

Program Data (g02bnfe.d)

Program Results

Program Results (g02bnfe.r)