Integer, Intent (In)	::	m, isx(m), ldq, ip, ix
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	x(*), y, wt
Real (Kind=nag_wp), Intent (Inout)	::	q(ldq,ip+1), rss
Real (Kind=nag_wp), Intent (Out)	::	wk(3*ip)
Character (1), Intent (In)	::	update, mean, weight

C Header Interface

#include <nag.h>

void

g02dcf_ (const char *update, const char *mean, const char *weight, const Integer *m, const Integer isx[], double q[], const Integer *ldq, const Integer *ip, const double x[], const Integer *ix, const double *y, const double *wt, double *rss, double wk[], Integer *ifail, const Charlen length_update, const Charlen length_mean, const Charlen length_weight)

The routine may be called by the names g02dcf or nagf_correg_linregm_obs_edit.

3 Description

g02daf fits a general linear regression model to a dataset. You may wish to change the model by either adding or deleting an observation from the dataset. g02dcf takes the results from g02daf and makes the required changes to the vector

c

and the upper triangular matrix

R

produced by g02daf. The regression coefficients, standard errors and the variance-covariance matrix of the regression coefficients can be obtained from g02ddf after all required changes to the dataset have been made.

g02daf performs a

Q R

decomposition on the (weighted)

X

matrix of independent variables. To add a new observation to a model with

p

parameters, the upper triangular matrix

R

and vector

c_{1}

(the first

p

elements of

c

) are augmented by the new observation on independent variables in

x^{T}

and dependent variable

y_{new}

. Givens rotations are then used to restore the upper triangular form.

(\begin{array}{l} R : c_{1} \\ x : y_{new} \end{array}) \to (\begin{array}{l} R^{*} : c_{1}^{*} \\ 0 : y_{new}^{*} \end{array}) .

Note: only

R

and the upper part of

c

are updated the remainder of the

Q

matrix is unchanged.

4 References

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

Hammarling S (1985) The singular value decomposition in multivariate statistics SIGNUM Newsl. 20(3) 2–25

5 Arguments

1: $update$ – Character(1) Input

On entry: indicates if an observation is to be added or deleted.

$update ='A'$: The observation is added.
$update ='D'$: The observation is deleted.

Constraint:

update ='A'

'D'

2: $mean$ – Character(1) Input

On entry: indicates if a mean has been used in the model.

$mean ='M'$: A mean term or intercept will have been included in the model by g02daf.
$mean ='Z'$: A model with no mean term or intercept will have been fitted by g02daf.

Constraint:

mean ='M'

'Z'

3: $weight$ – Character(1) Input

On entry: indicates if a weight is to be used.

$weight ='U'$: The new observation is unweighted.
$weight ='W'$: The new observation is to be weighted and the weight must be supplied in wt.

Constraint:

weight ='U'

'W'

4: $m$ – Integer Input

On entry:

m

, the total number of independent variables in the dataset.

Constraint:

m \geq 1

5: $isx (m)$ – Integer array Input

On entry: if

isx (j)

is greater than

0

, the value contained in

x ((j - 1) \times ix + 1)

is to be included as a value of

x^{T}

, for

j = 1, 2, \dots, m

Constraint: if

mean ='M'

, exactly

ip - 1

elements of isx must be

> 0

and if

mean ='Z'

, exactly ip elements of isx must be

> 0

6: $q (ldq, ip + 1)$ – Real (Kind=nag_wp) array Input/Output

On entry: must be array q as output by g02daf, g02def, g02dff or g02eef, or a previous call to g02dcf.

On exit: the first ip elements of the first column of q will contain

c_{1}^{*}

the upper triangular part of columns

2

ip + 1

will contain

R^{*}

the remainder is unchanged.

7: $ldq$ – Integer Input

On entry: the first dimension of the array q as declared in the (sub)program from which g02dcf is called.

Constraint:

ldq \geq ip

8: $ip$ – Integer Input

On entry: the number of linear terms in general linear regression model (including mean if there is one).

Constraint:

ip \geq 1

9: $x (*)$ – Real (Kind=nag_wp) array Input

Note: the dimension of the array x must be at least

(m - 1) \times ix + 1

On entry: the ip values for the dependent variables of the new observation,

x^{T}

. The positions will depend on the value of ix.

10: $ix$ – Integer Input

On entry: the increment for elements of x. Two situations are common:

$ix = 1$: The values of $x$ are to be chosen from consecutive locations in x, i.e., $x (1), x (2), \dots, x (m)$ .
$ix = ldx$: The values of $x$ are to be chosen from a row of a two-dimensional array with first dimension ldx, i.e., $x (1), x (ldx + 1), \dots, x ((m - 1) ldx + 1)$ .

Constraint:

ix \geq 1

11: $y$ – Real (Kind=nag_wp) Input

On entry: the value of the dependent variable for the new observation,

y_{new}

12: $wt$ – Real (Kind=nag_wp) Input

On entry: if

weight ='W'

, wt must contain the weight to be used with the new observation.

wt = 0.0

, the observation is not included in the model.

weight ='U'

, wt is not referenced.

Constraint: if

weight ='W'

wt \geq 0.0

13: $rss$ – Real (Kind=nag_wp) Input/Output

On entry: the value of the residual sums of squares for the original set of observations.

Constraint:

rss \geq 0.0

On exit: the updated values of the residual sums of squares.

Note: this will only be valid if the model is of full rank.

14: $wk (3 \times ip)$ – Real (Kind=nag_wp) array Workspace

15: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

- 1 or 1

. If you are unfamiliar with this argument you should refer to Section 4 in the Introduction to the NAG Library FL Interface for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value

- 1 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 $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $〈value〉$ elements of $isx > 0$ instead of $ip = 〈value〉$ .

On entry, $〈value〉$ elements of $isx > 0$ instead of $ip - 1$ (for mean) $= 〈value〉$ .

On entry, $ip = 〈value〉$ .
Constraint: $ip \geq 1$ .

On entry, $ix = 〈value〉$ .
Constraint: $ix \geq 1$ .

On entry, $ldq = 〈value〉$ and $ip = 〈value〉$ .
Constraint: $ldq \geq ip$ .

On entry, $mean = 〈value〉$ .
Constraint: $mean ='M'$ or $'Z'$ .

On entry, $rss = 〈value〉$ .
Constraint: $rss \geq 0.0$ .

On entry, $update = 〈value〉$ .
Constraint: $update ='A'$ or $'D'$ .

On entry, $weight = 〈value〉$ .
Constraint: $weight ='U'$ or $'W'$ .

$ifail = 2$: On entry, $wt = 〈value〉$ .
Constraint: $wt \geq 0.0$ .

$ifail = 3$: The $R$ matrix could not be updated. This may occur if an attempt is made to delete an observation which was not in the original dataset or to add an observation to a $R$ matrix with a zero diagonal element. This error is also possible when removing an observation which reduces the rank of design matrix. In such cases the model should be recomputed using g02daf.

$ifail = 4$: The residual sums of squares cannot be updated. This will occur if the input residual sum of squares is less than the calculated decrease in residual sum of squares when the new observation is deleted.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Higher accuracy is achieved by updating the

R

matrix rather than the traditional methods of updating

X^{'} X

8 Parallelism and Performance

g02dcf 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.

9 Further Comments

Care should be taken with the use of g02dcf.

(a)It is possible to delete observations which were not included in the original model.
(b)If several additions/deletions have been performed you are advised to recompute the regression using g02daf.
(c)Adding or deleting observations can alter the rank of the model. Such changes will only be detected when a call to g02ddf has been made. g02ddf should also be used to compute the new residual sum of squares when the model is not of full rank.

g02dcf may also be used after g02def, g02dff and g02eef.

10 Example

A dataset consisting of

12

observations with four independent variables is read in and a general linear regression model fitted by g02daf and parameter estimates printed. The last observation is then dropped and the parameter estimates recalculated, using g02ddf, and printed. Finally a new observation is added and new parameter estimates computed and printed.

Interfaces: FL CL AD

NAG FL Interface Introduction

G02 (Correg) Chapter Contents

G02 (Correg) Chapter Introduction

g02dc: FL CL AD

NAG FL Interfaceg02dcf (linregm_​obs_​edit)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
g02dcf (linregm_obs_edit)