G01AUF (PDF version)
G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

G01AUF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

G01AUF combines sets of summaries produced by G01ATF.

2  Specification

SUBROUTINE G01AUF ( B, MRCOMM, PN, XMEAN, XSD, XSKEW, XKURT, XMIN, XMAX, RCOMM, IFAIL)
INTEGER  B, PN, IFAIL
REAL (KIND=nag_wp)  MRCOMM(20,B), XMEAN, XSD, XSKEW, XKURT, XMIN, XMAX, RCOMM(20)

3  Description

Assume a dataset containing n observations, denoted by x = xi : i=1,2,,n  and a set of weights, w = wi : i=1,2,,n , has been split into b blocks, and each block summarised via a call to G01ATF. Then G01AUF takes the b communication arrays returned by G01ATF and returns the mean (x-), standard deviation (s2), coefficients of skewness (s3) and kurtosis (s4), and the maximum and minimum values for the whole dataset.
For a definition of x-,s2,s3 and s4 see Section 3 in G01ATF.

4  References

West D H D (1979) Updating mean and variance estimates: An improved method Comm. ACM 22 532–555

5  Arguments

1:     B – INTEGERInput
On entry: b, the number of blocks the full dataset was split into.
Constraint: B1.
2:     MRCOMM20B – REAL (KIND=nag_wp) arrayCommunication Array
On entry: the jth column of MRCOMM must contain the information returned in RCOMM from one of the runs of G01ATF.
3:     PN – INTEGEROutput
On exit: the number of valid observations, that is the number of observations with wi>0, for i=1,2,,n.
4:     XMEAN – REAL (KIND=nag_wp)Output
On exit: x-, the mean.
5:     XSD – REAL (KIND=nag_wp)Output
On exit: s2, the standard deviation.
6:     XSKEW – REAL (KIND=nag_wp)Output
On exit: s3, the coefficient of skewness.
7:     XKURT – REAL (KIND=nag_wp)Output
On exit: s4, the coefficient of kurtosis.
8:     XMIN – REAL (KIND=nag_wp)Output
On exit: the smallest value.
9:     XMAX – REAL (KIND=nag_wp)Output
On exit: the largest value.
10:   RCOMM20 – REAL (KIND=nag_wp) arrayCommunication Array
On exit: an amalgamation of the information held in MRCOMM. This is in the same format as RCOMM from G01ATF.
11:   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).

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:
IFAIL=11
On entry, B=value.
Constraint: B1.
IFAIL=21
On entry, MRCOMM is not in the expected format.
IFAIL=31
On entry, the number of valid observations is zero.
IFAIL=51
On exit we were unable to calculate XSKEW or XKURT. A value of 0 has been returned.
IFAIL=52
On exit we were unable to calculate XSD, XSKEW or XKURT. A value of 0 has been returned.
IFAIL=-99
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.
IFAIL=-399
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.
IFAIL=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7  Accuracy

Not applicable.

8  Parallelism and Performance

G01AUF is not threaded in any implementation.

9  Further Comments

The order that the b communication arrays are stored in MRCOMM is arbitrary. Different orders can lead to slightly different results due to numerical accuracy of floating-point calculations.
Both G01AUF and G01ATF consolidate results from multiple summaries. Whereas the former can only be used to combine summaries calculated sequentially, the latter combines summaries calculated in an arbitrary order allowing, for example, summaries calculated on different processing units to be combined.

10  Example

This example summarises some simulated data. The data is supplied in three blocks, the first consisting of 21 observations, the second 51 observations and the last 28 observations. Summaries are produced for each block of data separately and then an overall summary is produced.

10.1  Program Text

Program Text (g01aufe.f90)

10.2  Program Data

Program Data (g01aufe.d)

10.3  Program Results

Program Results (g01aufe.r)


G01AUF (PDF version)
G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2016