PDF version (NAG web site
, 64-bit version, 64-bit version)
NAG Toolbox: nag_nonpar_randtest_gaps (g08ed)
Purpose
nag_nonpar_randtest_gaps (g08ed) performs a gaps test on a sequence of observations.
Syntax
[
ngaps,
ncount,
ex,
chi,
df,
prob,
ifail] = g08ed(
cl,
x,
m,
rlo,
rup,
totlen,
ngaps,
ncount, 'n',
n, 'maxg',
maxg)
[
ngaps,
ncount,
ex,
chi,
df,
prob,
ifail] = nag_nonpar_randtest_gaps(
cl,
x,
m,
rlo,
rup,
totlen,
ngaps,
ncount, 'n',
n, 'maxg',
maxg)
Description
Gaps tests are used to test for cyclical trend in a sequence of observations. nag_nonpar_randtest_gaps (g08ed) computes certain statistics for the gaps test.
nag_nonpar_randtest_gaps (g08ed) may be used in two different modes:
(i) |
a single call to nag_nonpar_randtest_gaps (g08ed) which computes all test statistics after counting the gaps; |
(ii) |
multiple calls to nag_nonpar_randtest_gaps (g08ed) with the final test statistics only being computed in the last call. |
The second mode is necessary if all the data does not fit into the memory. See argument
cl in
Arguments for details on how to invoke each mode.
The term gap is used to describe the distance between two numbers in the sequence that lie in the interval . That is, a gap ends at if . The next gap then begins at . The interval should lie within the region of all possible numbers. For example if the test is carried out on a sequence of random numbers then the interval must be contained in the whole interval . Let be the length of the interval which specifies all possible numbers.
nag_nonpar_randtest_gaps (g08ed) counts the number of gaps of different lengths. Let denote the number of gaps of length , for . The number of gaps of length or greater is then denoted by . An unfinished gap at the end of a sequence is not counted unless the sequence is part of an initial or intermediate call to nag_nonpar_randtest_gaps (g08ed) (i.e., unless there is another call to nag_nonpar_randtest_gaps (g08ed) to follow) in which case the unfinished gap is used. The following is a trivial example.
Suppose we called
nag_nonpar_randtest_gaps (g08ed) twice (i.e., with
and then with
) with the following two sequences and with
and
:
- ( ) and
- ( ).
Then after the second call
nag_nonpar_randtest_gaps (g08ed) would have counted the gaps of the following lengths:
When the counting of gaps is complete
nag_nonpar_randtest_gaps (g08ed) computes the expected values of the counts. An approximate
statistic with
degrees of freedom is computed where
where
- , if ;
- , if ;
- the number of gaps found and
- .
The use of the -distribution as an approximation to the exact distribution of the test statistic improves as the expected values increase.
You may specify the total number of gaps to be found. If the specified number of gaps is found before the end of a sequence nag_nonpar_randtest_gaps (g08ed) will exit before counting any further gaps.
References
Dagpunar J (1988) Principles of Random Variate Generation Oxford University Press
Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley
Morgan B J T (1984) Elements of Simulation Chapman and Hall
Ripley B D (1987) Stochastic Simulation Wiley
Parameters
Compulsory Input Parameters
- 1:
– string (length ≥ 1)
-
Indicates the type of call to
nag_nonpar_randtest_gaps (g08ed).
- This is the one and only call to nag_nonpar_randtest_gaps (g08ed) (single call mode). All data are to be input at once. All test statistics are computed after the counting of gaps is complete.
- This is the first call to the function. All initializations are carried out before the counting of gaps begins. The final test statistics are not computed since further calls will be made to nag_nonpar_randtest_gaps (g08ed).
- This is an intermediate call during which the counts of gaps are updated. The final test statistics are not computed since further calls will be made to nag_nonpar_randtest_gaps (g08ed).
- This is the last call to nag_nonpar_randtest_gaps (g08ed). The test statistics are computed after the final counting of gaps is complete.
Constraint:
, , or .
- 2:
– double array
-
The sequence of observations.
- 3:
– int64int32nag_int scalar
-
The maximum number of gaps to be sought. If
then there is no limit placed on the number of gaps that are found.
m should not be changed between calls to
nag_nonpar_randtest_gaps (g08ed).
Constraint:
if , .
- 4:
– double scalar
-
The lower limit of the interval to be used to define the gaps,
.
rlo must not be changed between calls to
nag_nonpar_randtest_gaps (g08ed).
- 5:
– double scalar
-
The upper limit of the interval to be used to define the gaps,
.
rup must not be changed between calls to
nag_nonpar_randtest_gaps (g08ed).
Constraint:
.
- 6:
– double scalar
-
The total length of the interval which contains all possible numbers that may arise in the sequence.
Constraint:
and .
- 7:
– int64int32nag_int scalar
-
If
or
,
ngaps need not be set.
If
or
,
ngaps must contain the value returned by the previous call to
nag_nonpar_randtest_gaps (g08ed).
- 8:
– int64int32nag_int array
-
If
or
,
ncount need not be set.
If
or
,
ncount must contain the values returned by the previous call to
nag_nonpar_randtest_gaps (g08ed).
Optional Input Parameters
- 1:
– int64int32nag_int scalar
-
Default:
the dimension of the array
x.
, the length of the current sequence of observations.
Constraint:
.
- 2:
– int64int32nag_int scalar
-
Default:
the dimension of the array
ncount.
, the length of the longest gap for which tabulation is desired.
maxg must not be changed between calls to
nag_nonpar_randtest_gaps (g08ed).
Constraints:
- ;
- if , .
Output Parameters
- 1:
– int64int32nag_int scalar
-
The number of gaps actually found, .
- 2:
– int64int32nag_int array
-
The counts of gaps of the different lengths,
, for .
- 3:
– double array
-
If
or
(i.e., if it is a final exit) then
ex contains the expected values of the counts.
Otherwise the elements of
ex are not set.
- 4:
– double scalar
-
If
or
(i.e., if it is a final exit) then
chi contains the
test statistic,
, for testing the null hypothesis of randomness.
Otherwise
chi is not set.
- 5:
– double scalar
-
If
or
(i.e., if it is a final exit) then
df contains the degrees of freedom for the
statistic.
- 6:
– double scalar
-
If
or
(i.e., if it is a final exit) then
prob contains the upper tail probability associated with the
test statistic, i.e., the significance level.
Otherwise
prob is not set.
- 7:
– int64int32nag_int scalar
unless the function detects an error (see
Error Indicators and Warnings).
Error Indicators and Warnings
Note: nag_nonpar_randtest_gaps (g08ed) may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the function:
Cases prefixed with W are classified as warnings and
do not generate an error of type NAG:error_n. See nag_issue_warnings.
-
-
On entry, .
Constraint: , , or .
-
-
Constraint: .
-
-
Constraint: if , .
-
-
Constraint: if , .
Constraint: .
-
-
Constraint: .
Constraint: .
Constraint: .
-
-
No gaps were found. Try using a longer sequence, or increase the size of the interval .
-
-
The expected frequency in class is zero. The value of
may be too close to
. or
maxg is too large relative to the number of gaps found.
- W
-
The number of gaps requested were not found, only out of the requested where found.
All statistics are returned and may still be of use.
- W
-
The expected frequency of at least one class is less than one.
This implies that the may not be a very good approximation to the distribution of the test statistics.
All statistics are returned and may still be of use.
-
An unexpected error has been triggered by this routine. Please
contact
NAG.
-
Your licence key may have expired or may not have been installed correctly.
-
Dynamic memory allocation failed.
Accuracy
The computations are believed to be stable. The computation of
prob given the values of
chi and
df will obtain a relative accuracy of five significant places for most cases.
Further Comments
The time taken by nag_nonpar_randtest_gaps (g08ed) increases with the number of observations , and depends to some extent whether the call is an only, first, intermediate or last call.
Example
The following program performs the gaps test on pseudorandom numbers. nag_nonpar_randtest_gaps (g08ed) is called times with observations on each call. All gaps of length or more are counted together.
Open in the MATLAB editor:
g08ed_example
function g08ed_example
fprintf('g08ed example results\n\n');
seed = [int64(324213)];
genid = int64(1);
subid = int64(1);
[state, ifail] = g05kf( ...
genid, subid, seed);
m = int64(0);
rlo = 0.4;
rup = 0.6;
totlen = 1;
ncount = zeros(10, 1, 'int64');
ngaps = int64(0);
nsampl = 5;
n = int64(100);
cl = 'F';
for i=1:nsampl
[state, x, ifail] = g05sq( ...
n, 0, 1, state);
[ngaps, ncount, ex, chi, df, prob, ifail] = ...
g08ed( ...
cl, x, m, rlo, rup, totlen, ngaps, ncount);
cl = 'I';
if i==nsampl-1
cl = 'L';
end
end
fprintf('Total number of gaps found = %d\n', ngaps);
fprintf('\n%33s\n', 'Count');
head = sprintf('%7d', [0:8]);
head = sprintf('%s >8', head);
fprintf('%s\n', head);
fprintf('%7d', ncount);
fprintf('\n\n%34s\n', 'Expect');
fprintf('%s\n', head);
fprintf('%7.1f', ex);
fprintf('\n\n');
fprintf('Chisq = %10.4f\n', chi);
fprintf('DF = %7.1f\n', df);
fprintf('Prob = %10.4f\n', prob);
g08ed example results
Total number of gaps found = 99
Count
0 1 2 3 4 5 6 7 8 >8
22 11 10 13 6 12 4 6 2 13
Expect
0 1 2 3 4 5 6 7 8 >8
19.8 15.8 12.7 10.1 8.1 6.5 5.2 4.2 3.3 13.3
Chisq = 9.9540
DF = 9.0
Prob = 0.3542
PDF version (NAG web site
, 64-bit version, 64-bit version)
© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2015