NAG Library Routine Document

g01ajf (withdraw_plot_histogram)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

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

On entry: the data values.

2:     $\mathbf{n}$ – IntegerInput

On entry: the number of data values.

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

3:     $\mathbf{nstepx}$ – IntegerInput/Output

On entry: the number of character positions to be used in the horizontal direction, i.e., the number of categories in the histogram.

On exit: if $\mathbf{nstepx}<10$ on entry, nstepx is reset to $10$.

If $\mathbf{nstepx}>99$ on entry, nstepx is reset to $99$.

Otherwise, nstepx is unchanged on exit.

4:     $\mathbf{nstepy}$ – IntegerInput/Output

On entry: the number of character positions to be used in the vertical direction, i.e., the maximum height of a histogram bar.

On exit: if $\mathbf{nstepy}<10$ on entry, nstepy is reset to $10$.

If $\mathbf{nstepy}>99$ on entry, nstepy is reset to $99$.

Otherwise, nstepy is unchanged on exit.

5:     $\mathbf{itype}$ – IntegerInput

On entry: indicates whether a histogram of frequencies or cumulative frequencies is required.

$\mathbf{itype}=0$ for frequencies.

$\mathbf{itype}\ne 0$ for cumulative frequencies.

The second option effectively displays the distribution function of the data rather than the density function.

6:     $\mathbf{ispace}$ – IntegerInput/Output

On entry: indicates how many spaces are to be inserted at the beginning of each output line.

If $\mathbf{ispace}<0$ on input, $\mathbf{ispace}=0$ is used

If $\mathbf{ispace}+\mathbf{nstepx}+14>120$, $\mathbf{ispace}=0$ is used.

The second condition imposes an effective line length limit of $120$ characters.

On exit: unchanged unless $\mathbf{ispace}<0$ or $\mathbf{ispace}+\mathbf{nstepx}+14>120$, in which case ispace is set to $0$.

7:     $\mathbf{xmin}$ – Real (Kind=nag_wp)Input/Output

8:     $\mathbf{xmax}$ – Real (Kind=nag_wp)Input/Output

On entry: if $\mathbf{xmin}<\mathbf{xmax}$, only those values in x such that $\mathbf{xmin}\le \mathbf{x}\left(\mathit{i}\right)\le \mathbf{xmax}$, for $\mathit{i}=1,2,\dots ,n$, are included in the histogram.

If $\mathbf{xmin}\ge \mathbf{xmax}$, all the data are included.

On exit: if $\mathbf{xmin}<\mathbf{xmax}$ on entry, xmin and xmax are unchanged.

If $\mathbf{xmin}\ge \mathbf{xmax}$ then xmin and xmax contain the minimum and maximum data values respectively.

9:     $\mathbf{xstep}$ – Real (Kind=nag_wp)Output

On exit: the width of each class interval.

10:   $\mathbf{n1}$ – IntegerOutput

On exit: the total number of observations actually included in the histogram.

11:   $\mathbf{multy}$ – IntegerOutput

On exit: the number of observations represented by each * in the histogram.

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{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 1$.

$\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 (g01ajfe.f90)

10.2

Program Data

Program Data (g01ajfe.d)

10.3

Program Results

Program Results (g01ajfe.r)