NAG CPP Interface
nagcpp::stat::quantiles (g01am)

1 Purpose

2 Specification

#include "g01/nagcpp_g01am.hpp"

template <typename RV, typename Q, typename QV>

void function quantiles(RV &&rv, const Q &q, QV &&qv, OptionalG01AM opt)

template <typename RV, typename Q, typename QV>

void function quantiles(RV &&rv, const Q &q, QV &&qv)

3 Description

4 References

5 Arguments

1: $\mathbf{rv}\left(\mathbf{n}\right)$ – double array Input/Output

On entry: the vector whose quantiles are to be determined.

On exit: the order of the elements in rv is not, in general, preserved.

2: $\mathbf{q}\left(\mathbf{nq}\right)$ – double array Input

On entry: the quantiles to be calculated, in ascending order. Note that these must be between $0.0$ and $1.0$, with $0.0$ returning the smallest element and $1.0$ the largest.

Constraints:

• $0.0\le \mathbf{q}\left(\mathit{i}-1\right)\le 1.0$, for $\mathit{i}=1,2,\dots ,\mathbf{nq}$;
• $\mathbf{q}\left(\mathit{i}-1\right)\le \mathbf{q}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nq}-1$.

3: $\mathbf{qv}\left(\mathbf{nq}\right)$ – double array Output

On exit: $\mathbf{qv}\left(i-1\right)$ contains the quantile specified by the value provided in $\mathbf{q}\left(i-1\right)$, or an interpolated value if the quantile falls between two data values.

4: $\mathbf{opt}$ – OptionalG01AM Input/Output

Optional parameter container, derived from Optional.

6 Exceptions and Warnings

Raises: ErrorException

$\mathbf{errorid}=1$

On entry, $\mathbf{n}=⟨\mathit{value}⟩$.
Constraint: $\mathbf{n}>0$.

$\mathbf{errorid}=2$

On entry, $\mathbf{nq}=⟨\mathit{value}⟩$.
Constraint: $\mathbf{nq}>0$.

$\mathbf{errorid}=3$

On entry, an element of q was less than $0.0$ or greater than $1.0$.

$\mathbf{errorid}=4$

On entry, q was not in ascending order.

$\mathbf{errorid}=10601$

On entry, argument $⟨\mathit{\text{value}}⟩$ must be a vector of size $⟨\mathit{\text{value}}⟩$ array.
Supplied argument has $⟨\mathit{\text{value}}⟩$ dimensions.

$\mathbf{errorid}=10601$

On entry, argument $⟨\mathit{\text{value}}⟩$ must be a vector of size $⟨\mathit{\text{value}}⟩$ array.
Supplied argument was a vector of size $⟨\mathit{\text{value}}⟩$.

$\mathbf{errorid}=10601$

On entry, argument $⟨\mathit{\text{value}}⟩$ must be a vector of size $⟨\mathit{\text{value}}⟩$ array.
The size for the supplied array could not be ascertained.

$\mathbf{errorid}=10602$

On entry, the raw data component of $⟨\mathit{\text{value}}⟩$ is null.

$\mathbf{errorid}=10603$

On entry, unable to ascertain a value for $⟨\mathit{\text{value}}⟩$.

$\mathbf{errorid}=\mathrm{-99}$

An unexpected error has been triggered by this routine.

$\mathbf{errorid}=\mathrm{-399}$

Your licence key may have expired or may not have been installed correctly.

$\mathbf{errorid}=\mathrm{-999}$

Dynamic memory allocation failed.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Example Program