NAG Library Function Document

nag_approx_quantiles_fixed (g01anc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:    $\mathbf{ind}$ – Integer *Input/Output

On entry: indicates the action required in the current call to nag_approx_quantiles_fixed (g01anc).

$\mathbf{ind}=0$

Return the required length of rcomm and icomm in $\mathbf{icomm}\left[0\right]$ and $\mathbf{icomm}\left[1\right]$ respectively. n and eps must be set and licomm must be at least $2$.

$\mathbf{ind}=1$

Initialise the communication arrays and process the first nb values from the data stream as supplied in rv.

$\mathbf{ind}=2$

Process the next block of nb values from the data stream. The calling program must update rv and (if required) nb, and re-enter nag_approx_quantiles_fixed (g01anc) with all other parameters unchanged.

$\mathbf{ind}=3$

Calculate the nq $\epsilon$-approximate quantiles specified in q. The calling program must set q and nq and re-enter nag_approx_quantiles_fixed (g01anc) with all other parameters unchanged. This option can be chosen only when $\mathbf{np}\ge ⌈\exp \left(1.0\right)/\mathbf{eps}⌉$.

On exit: indicates output from a successful call.

$\mathbf{ind}=1$

Lengths of rcomm and icomm have been returned in $\mathbf{icomm}\left[0\right]$ and $\mathbf{icomm}\left[1\right]$ respectively.

$\mathbf{ind}=2$

nag_approx_quantiles_fixed (g01anc) has processed np data points and expects to be called again with additional data (i.e., $\mathbf{np}<\mathbf{n}$).

$\mathbf{ind}=3$

nag_approx_quantiles_fixed (g01anc) has returned the requested $\epsilon$-approximate quantiles in qv. These quantiles are based on np data points.

$\mathbf{ind}=4$

Routine has processed all n data points (i.e., $\mathbf{np}=\mathbf{n}$).

Constraint: on entry $\mathbf{ind}=0$, $1$, $2$ or $3$.

2:    $\mathbf{n}$ – IntegerInput

On entry: $n$, the total number of values in the data stream.

Constraint: $\mathbf{n}>0$.

3:    $\mathbf{rv}\left[\mathit{dim}\right]$ – const doubleInput

Note: the dimension, dim, of the array rv must be at least $\mathbf{nb}$ when $\mathbf{ind}=1$ or $2$.

On entry: if $\mathbf{ind}=1$ or $2$, the vector containing the current block of data, otherwise rv is not referenced.

4:    $\mathbf{nb}$ – IntegerInput

On entry: if $\mathbf{ind}=1$ or $2$, the size of the current block of data. The size of blocks of data in array rv can vary; therefore nb can change between calls to nag_approx_quantiles_fixed (g01anc).

Constraint: if $\mathbf{ind}=1$ or $2$, $\mathbf{nb}>0$.

5:    $\mathbf{eps}$ – doubleInput

On entry: approximation factor $\epsilon$.

Constraint: $\mathbf{eps}\ge \exp \left(1.0\right)/\mathbf{n}\text{ and }\mathbf{eps}\le 1.0$.

6:    $\mathbf{np}$ – Integer *Output

On exit: the number of elements processed so far.

7:    $\mathbf{q}\left[\mathit{dim}\right]$ – const doubleInput

Note: the dimension, dim, of the array q must be at least $\mathbf{nq}$ when $\mathbf{ind}=3$.

On entry: if $\mathbf{ind}=3$, the quantiles to be calculated, otherwise q is not referenced. Note that $\mathbf{q}\left[i\right]=0.0$, corresponds to the minimum value and $\mathbf{q}\left[i\right]=1.0$ to the maximum value.

Constraint: if $\mathbf{ind}=3$, $0.0\le \mathbf{q}\left[\mathit{i}-1\right]\le 1.0$, for $\mathit{i}=1,2,\dots ,\mathbf{nq}$.

8:    $\mathbf{qv}\left[\mathit{dim}\right]$ – doubleOutput

Note: the dimension, dim, of the array qv must be at least $\mathbf{nq}$ when $\mathbf{ind}=3$.

On exit: if $\mathbf{ind}=3$, $\mathbf{qv}\left[i\right]$ contains the $\epsilon$-approximate quantiles specified by the value provided in $\mathbf{q}\left[i\right]$.

9:    $\mathbf{nq}$ – IntegerInput

On entry: if $\mathbf{ind}=3$, the number of quantiles requested, otherwise nq is not referenced.

Constraint: if $\mathbf{ind}=3$, $\mathbf{nq}>0$.

10:  $\mathbf{rcomm}\left[\mathbf{lrcomm}\right]$ – doubleCommunication Array

11:  $\mathbf{lrcomm}$ – IntegerInput

On entry: the dimension of the array rcomm.

Constraint: if $\mathbf{ind}\ne 0$, lrcomm must be at least equal to the value returned in $\mathbf{icomm}\left[0\right]$ by a call to nag_approx_quantiles_fixed (g01anc) with $\mathbf{ind}=0$. This will not be more than $x+2\times \min \left(x,⌈x/2.0⌉+1\right)\times {\log }_2\left(\mathbf{n}/x+1.0\right)+1$, where $x=\max \left(1,⌊\log \left(\mathbf{eps}\times \mathbf{n}\right)/\mathbf{eps}⌋\right)$.

12:  $\mathbf{icomm}\left[\mathbf{licomm}\right]$ – IntegerCommunication Array

13:  $\mathbf{licomm}$ – IntegerInput

On entry: the dimension of the array icomm.

Constraints:

• if $\mathbf{ind}=0$, $\mathbf{licomm}\ge 2$;
• otherwise licomm must be at least equal to the value returned in $\mathbf{icomm}\left[1\right]$ by a call to nag_approx_quantiles_fixed (g01anc) with $\mathbf{ind}=0$. This will not be more than $2\times \left(x+2\times \min \left(x,⌈x/2.0⌉+1\right)\times y\right)+y+6$, where $x=\max \left(1,⌊\log \left(\mathbf{eps}\times \mathbf{n}\right)/\mathbf{eps}⌋\right)$ and $y={\log }_2\left(\mathbf{n}/x+1.0\right)+1$.

14:  $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 3.2.1.2 in the Essential Introduction for further information.

NE_ARRAY_SIZE

On entry, licomm is too small: $\mathbf{licomm}=〈\mathit{\text{value}}〉$.

On entry, lrcomm is too small: $\mathbf{lrcomm}=〈\mathit{\text{value}}〉$.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_INT

On entry, $\mathbf{ind}=1$ or $2$ and $\mathbf{nb}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{ind}=1$ or $2$ then $\mathbf{nb}>0$.

On entry, $\mathbf{ind}=3$ and $\mathbf{nq}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{ind}=3$ then $\mathbf{nq}>0$.

On entry, $\mathbf{ind}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ind}=0$, $1$, $2$ or $3$.

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}>0$.

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.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.

NE_Q_OUT_OF_RANGE

On entry, $\mathbf{ind}=3$ and $\mathbf{q}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{ind}=3$ then $0.0\le \mathbf{q}\left[i\right]\le 1.0$ for all $i$.

NE_REAL

On entry, $\mathbf{eps}=〈\mathit{\text{value}}〉$.
Constraint: $\exp \left(1.0\right)/\mathbf{n}\le \mathbf{eps}\le 1.0$.

NE_TOO_SMALL

Number of data elements streamed, $〈\mathit{\text{value}}〉$ is not sufficient for a quantile query when $\mathbf{eps}=〈\mathit{\text{value}}〉$.
Supply more data or reprocess the data with a higher eps value.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (g01ance.c)

10.2  Program Data

Program Data (g01ance.d)

10.3  Program Results

Program Results (g01ance.r)