NAG Library Routine Document

g05nef  (sample_wgt)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

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

On entry: a flag indicating the sorted status of the wt vector.

$\mathbf{order}=\text{'A'}$

wt is sorted in ascending order,

$\mathbf{order}=\text{'D'}$

wt is sorted in descending order,

$\mathbf{order}=\text{'U'}$

wt is unsorted and g05nef will sort the weights prior to using them.

Irrespective of the value of order, no checks are made on the sorted status of wt, e.g., it is possible to supply $\mathbf{order}=\text{'A'}$, even when wt is not sorted. In such cases the wt array will not be sorted internally, but g05nef will still work correctly except, possibly, in cases of extreme weight values.

It is usually more efficient to specify a value of order that is consistent with the status of wt.

Constraint: $\mathbf{order}=\text{'A'}$, $\text{'D'}$ or $\text{'U'}$.

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

On entry: $w_i$, the relative probability weights. These weights need not sum to $1.0$.

Constraints:

• $\mathbf{wt}\left(\mathit{i}\right)\ge 0.0$, for $\mathit{i}=1,2,\dots ,\mathbf{n}$;
• at least m values must be nonzero.

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

On entry: a flag indicating whether a population to be sampled has been supplied.

$\mathbf{pop}=\text{'D'}$

the population is assumed to be the integers $\left(1,2,\dots ,\mathbf{n}\right)$ and ipop is not referenced,

$\mathbf{pop}=\text{'S'}$

the population must be supplied in ipop.

Constraint: $\mathbf{pop}=\text{'D'}$ or $\text{'S'}$.

4:     $\mathbf{ipop}\left(*\right)$ – Integer arrayInput

Note: the dimension of the array ipop must be at least $\mathbf{n}$ if $\mathbf{pop}=\text{'S'}$.

On entry: the population to be sampled. If $\mathbf{pop}=\text{'D'}$ then the population is assumed to be the set of values $\left(1,2,\dots ,\mathbf{n}\right)$ and the array ipop is not referenced. Elements of ipop with the same value are not combined, therefore if $\mathbf{wt}\left(i\right)\ne 0,\mathbf{wt}\left(j\right)\ne 0$ and $i\ne j$ then there is a nonzero probability that the sample will contain both $\mathbf{ipop}\left(i\right)$ and $\mathbf{ipop}\left(j\right)$. If $\mathbf{ipop}\left(i\right)=\mathbf{ipop}\left(j\right)$ then that value can appear in isampl more than once.

5:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the size of the population.

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

6:     $\mathbf{isampl}\left(\mathbf{m}\right)$ – Integer arrayOutput

On exit: the selected sample.

7:     $\mathbf{m}$ – IntegerInput

On entry: $m$, the size of the sample required.

Constraint: $0\le \mathbf{m}\le \mathbf{n}$.

8:     $\mathbf{state}\left(*\right)$ – Integer arrayCommunication Array

Note: the actual argument supplied must be the array state supplied to the initialization routines g05kff or g05kgf.

On entry: contains information on the selected base generator and its current state.

On exit: contains updated information on the state of the generator.

9:     $\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{order}=〈\mathit{\text{value}}〉$ was an illegal value.

On entry, order had an illegal value.

$\mathbf{ifail}=2$

On entry, at least one weight was less than zero.

$\mathbf{ifail}=3$

On entry, pop had an illegal value.

$\mathbf{ifail}=5$

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

$\mathbf{ifail}=7$

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

$\mathbf{ifail}=8$

On entry, state vector has been corrupted or not initialized.

$\mathbf{ifail}=21$

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$, number of nonzero weights $=〈\mathit{\text{value}}〉$.
Constraint: must be at least m nonzero weights.

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

10.2

Program Data

Program Data (g05nefe.d)

10.3

Program Results

Program Results (g05nefe.r)