NAG Library Routine Document

g10zaf  (data_order)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{weight}$ – Character(1)Input

On entry: indicates whether user-defined weights are to be used.

• If $\mathbf{weight}=\text{'W'}$, user-defined weights are to be used and must be supplied in wt.
• If $\mathbf{weight}=\text{'U'}$, the data is treated as unweighted.

Constraint: $\mathbf{weight}=\text{'W'}$ or $\text{'U'}$.

2:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the number of observations.

Constraint: $\mathbf{n}\ge 1$.

3:     $\mathbf{x}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the values, $x_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$.

4:     $\mathbf{y}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the values $y_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$.

5:     $\mathbf{wt}\left(*\right)$ – Real (Kind=nag_wp) arrayInput

Note: the dimension of the array wt must be at least $\mathbf{n}$ if $\mathbf{weight}=\text{'W'}$.

On entry: if $\mathbf{weight}=\text{'W'}$, wt must contain the $n$ weights. Otherwise wt is not referenced and unit weights are assumed.

Constraints:

• if $\mathbf{weight}=\text{'W'}$, $\mathbf{wt}\left(\mathit{i}\right)>0.0$, for $\mathit{i}=1,2,\dots ,n$;
• if $\mathbf{weight}=\text{'W'}$, ${\sum }_{i=1}^n\mathbf{wt}\left(i\right)>0$.

6:     $\mathbf{nord}$ – IntegerOutput

On exit: the number of distinct observations.

7:     $\mathbf{xord}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the first nord elements contain the ordered and distinct $x_i$.

8:     $\mathbf{yord}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the first nord elements contain the values $y^{\prime }$ corresponding to the values in xord.

9:     $\mathbf{wtord}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the first nord elements contain the values $w^{\prime }$ corresponding to the values of xord and yord.

10:   $\mathbf{rss}$ – Real (Kind=nag_wp)Output

On exit: the within group sum of squares for tied observations.

11:   $\mathbf{iwrk}\left(\mathbf{n}\right)$ – Integer arrayWorkspace

12:   $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ 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\text{ 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 $-\mathbf{1}\text{ 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).

6

Error Indicators and Warnings

$\mathbf{ifail}=1$

On entry,	$\mathbf{weight}\ne \text{'W'}$ or $\text{'U'}$,
or	$\mathbf{n}<1$.

$\mathbf{ifail}=2$

On entry,

$\mathbf{weight}=\text{'W'}$ and at least one element of wt is $<0.0$, or all elements of wt are $0.0$.

$\mathbf{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.

$\mathbf{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.

$\mathbf{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

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (g10zafe.f90)

10.2

Program Data

Program Data (g10zafe.d)

10.3

Program Results

Program Results (g10zafe.r)