NAG Library Routine Document
g01naf (moments_quad_form)
1
Purpose
g01naf computes the cumulants and moments of quadratic forms in Normal variates.
2
Specification
Fortran Interface
Subroutine g01naf ( |
mom, mean, n, a, lda, emu, sigma, ldsig, l, rkum, rmom, wk, ifail) |
Integer, Intent (In) | :: | n, lda, ldsig, l | Integer, Intent (Inout) | :: | ifail | Real (Kind=nag_wp), Intent (In) | :: | a(lda,n), emu(*), sigma(ldsig,n) | Real (Kind=nag_wp), Intent (Inout) | :: | rmom(*) | Real (Kind=nag_wp), Intent (Out) | :: | rkum(l), wk(3*n*(n+1)/2+n) | Character (1), Intent (In) | :: | mom, mean |
|
C Header Interface
#include <nagmk26.h>
void |
g01naf_ (const char *mom, const char *mean, const Integer *n, const double a[], const Integer *lda, const double emu[], const double sigma[], const Integer *ldsig, const Integer *l, double rkum[], double rmom[], double wk[], Integer *ifail, const Charlen length_mom, const Charlen length_mean) |
|
3
Description
Let
have an
-dimensional multivariate Normal distribution with mean
and variance-covariance matrix
. Then for a symmetric matrix
,
g01naf computes up to the first
moments and cumulants of the quadratic form
. The
th moment (about the origin) is defined as
where
denotes expectation. The
th moment of
can also be found as the coefficient of
in the expansion of
. The
th cumulant is defined as the coefficient of
in the expansion of
.
The routine is based on the routine CUM written by
Magnus and Pesaran (1993a) and based on the theory given by
Magnus (1978),
Magnus (1979) and
Magnus (1986).
4
References
Magnus J R (1978) The moments of products of quadratic forms in Normal variables Statist. Neerlandica 32 201–210
Magnus J R (1979) The expectation of products of quadratic forms in Normal variables: the practice Statist. Neerlandica 33 131–136
Magnus J R (1986) The exact moments of a ratio of quadratic forms in Normal variables Ann. Économ. Statist. 4 95–109
Magnus J R and Pesaran B (1993a) The evaluation of cumulants and moments of quadratic forms in Normal variables (CUM): Technical description Comput. Statist. 8 39–45
Magnus J R and Pesaran B (1993b) The evaluation of moments of quadratic forms and ratios of quadratic forms in Normal variables: Background, motivation and examples Comput. Statist. 8 47–55
5
Arguments
- 1: – Character(1)Input
-
On entry: indicates if moments are computed in addition to cumulants.
- Only cumulants are computed.
- Moments are computed in addition to cumulants.
Constraint:
or .
- 2: – Character(1)Input
-
On entry: indicates if the mean,
, is zero.
- is zero.
- The value of is supplied in emu.
Constraint:
or .
- 3: – IntegerInput
-
On entry: , the dimension of the quadratic form.
Constraint:
.
- 4: – Real (Kind=nag_wp) arrayInput
-
On entry: the by symmetric matrix . Only the lower triangle is referenced.
- 5: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
g01naf is called.
Constraint:
.
- 6: – Real (Kind=nag_wp) arrayInput
-
Note: the dimension of the array
emu
must be at least
if
, and at least
otherwise.
On entry: if
,
emu must contain the
elements of the vector
.
If
,
emu is not referenced.
- 7: – Real (Kind=nag_wp) arrayInput
-
On entry: the by variance-covariance matrix . Only the lower triangle is referenced.
Constraint:
the matrix must be positive definite.
- 8: – IntegerInput
-
On entry: the first dimension of the array
sigma as declared in the (sub)program from which
g01naf is called.
Constraint:
.
- 9: – IntegerInput
-
On entry: the required number of cumulants, and moments if specified.
Constraint:
.
- 10: – Real (Kind=nag_wp) arrayOutput
-
On exit: the
l cumulants of the quadratic form.
- 11: – Real (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
rmom
must be at least
if
, and at least
otherwise.
On exit: if
, the
l moments of the quadratic form.
- 12: – Real (Kind=nag_wp) arrayWorkspace
-
- 13: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, and .
Constraint: .
On entry, and .
Constraint: .
On entry, .
Constraint: or .
On entry, .
Constraint: or .
On entry, .
Constraint: .
-
On entry,
sigma is not positive definite.
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.
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.
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
In a range of tests the accuracy was found to be a modest multiple of
machine precision. See
Magnus and Pesaran (1993b).
8
Parallelism and Performance
g01naf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the
X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
None.
10
Example
This example is given by
Magnus and Pesaran (1993b) and considers the simple autoregression
where
is a sequence of independent Normal variables with mean zero and variance one, and
is known. The moments of the quadratic form
are computed using
g01naf. The matrix
is given by:
The value of
can be computed using the relationships
and
for
and
.
The values of , , , and the number of moments required are read in and the moments and cumulants printed.
10.1
Program Text
Program Text (g01nafe.f90)
10.2
Program Data
Program Data (g01nafe.d)
10.3
Program Results
Program Results (g01nafe.r)