Integer, Intent (In)	::	n, ldx, m, isx(m), ip, ldv, maxit, iprint
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	idf, irank
Real (Kind=nag_wp), Intent (In)	::	x(ldx,m), y(n), wt(*), a, tol, eps
Real (Kind=nag_wp), Intent (Inout)	::	v(ldv,ip+7)
Real (Kind=nag_wp), Intent (Out)	::	dev, b(ip), se(ip), cov(ip(ip+1)/2), wk((ipip+3*ip+22)/2)
Character (1), Intent (In)	::	link, mean, offset, weight

C Header Interface

#include <nag.h>

void

g02gcf_ (const char *link, const char *mean, const char *offset, const char *weight, const Integer *n, const double x[], const Integer *ldx, const Integer *m, const Integer isx[], const Integer *ip, const double y[], const double wt[], const double *a, double *dev, Integer *idf, double b[], Integer *irank, double se[], double cov[], double v[], const Integer *ldv, const double *tol, const Integer *maxit, const Integer *iprint, const double *eps, double wk[], Integer *ifail, const Charlen length_link, const Charlen length_mean, const Charlen length_offset, const Charlen length_weight)

The routine may be called by the names g02gcf or nagf_correg_glm_poisson.

3 Description

A generalized linear model with Poisson errors consists of the following elements:

(a)a set of $n$ observations, $y_{i}$ , from a Poisson distribution:

$\frac{μ^{y} e^{- μ}}{y!} .$
(b) $X$ , a set of $p$ independent variables for each observation, $x_{1}, x_{2}, \dots, x_{p}$ .
(c)a linear model:

$η = \sum β_{j} x_{j} .$
(d)a link between the linear predictor, $η$ , and the mean of the distribution, $μ$ , $η = g (μ)$ . The possible link functions are:
1. (i)exponent link: $η = μ^{a}$ , for a constant $a$ ,
2. (ii)identity link: $η = μ$ ,
3. (iii)log link: $η = \log μ$ ,
4. (iv)square root link: $η = \sqrt{μ}$ ,
5. (v)reciprocal link: $η = \frac{1}{μ}$ .
(e)a measure of fit, the deviance:

$\sum_{i = 1}^{n} dev (y_{i}, {\hat{μ}}_{i}) = \sum_{i = 1}^{n} 2 (y_{i} \log (\frac{y_{i}}{{\hat{μ}}_{i}}) - (y_{i} - {\hat{μ}}_{i})) .$

The linear parameters are estimated by iterative weighted least squares. An adjusted dependent variable,

z

, is formed:

z = η + (y - μ) \frac{d η}{d μ}

and a working weight,

w

w^{- 1} = {(τ d \frac{d η}{d μ})}^{2},

where

τ = \sqrt{μ}

At each iteration an approximation to the estimate of

β

\hat{β}

, is found by the weighted least squares regression of

z

X

with weights

w

g02gcf finds a

Q R

decomposition of

w^{1 / 2} X

, i.e.,

w^{1 / 2} X = Q R

where

R

is a

p \times p

triangular matrix and

Q

is an

n \times p

column orthogonal matrix.

R

is of full rank, then

\hat{β}

is the solution to:

R \hat{β} = Q^{T} w^{1 / 2} z .

R

is not of full rank a solution is obtained by means of a singular value decomposition (SVD) of

R

R = Q_{*} (\begin{array}{l} D & 0 \\ 0 & 0 \end{array}) P^{T},

where

D

is a

k \times k

diagonal matrix with nonzero diagonal elements,

k

being the rank of

R

and

w^{1 / 2} X

This gives the solution

\hat{β} = P_{1} D^{- 1} (\begin{array}{l} Q_{*} & 0 \\ 0 & I \end{array}) Q^{T} w^{1 / 2} z,

P_{1}

being the first

k

columns of

P

, i.e.,

P = (P_{1} P_{0})

The iterations are continued until there is only a small change in the deviance.

The initial values for the algorithm are obtained by taking

\hat{η} = g (y) .

The fit of the model can be assessed by examining and testing the deviance, in particular by comparing the difference in deviance between nested models, i.e., when one model is a sub-model of the other. The difference in deviance between two nested models has, asymptotically, a

χ^{2}

-distribution with degrees of freedom given by the difference in the degrees of freedom associated with the two deviances.

The parameters estimates,

\hat{β}

, are asymptotically Normally distributed with variance-covariance matrix

$C = R^{- 1} {R^{- 1}}^{T}$ in the full rank case, otherwise
$C = P_{1} D^{−2} P_{1}^{T}$ .

The residuals and influence statistics can also be examined.

The estimated linear predictor

\hat{η} = X \hat{β}

, can be written as

H w^{1 / 2} z

for an

n \times n

matrix

H

. The

i

th diagonal elements of

H

h_{i}

, give a measure of the influence of the

i

th values of the independent variables on the fitted regression model. These are known as leverages.

The fitted values are given by

\hat{μ} = g^{- 1} (\hat{η})

g02gcf also computes the deviance residuals,

r

r_{i} = sign (y_{i} - {\hat{μ}}_{i}) \sqrt{dev (y_{i}, {\hat{μ}}_{i})} .

An option allows prior weights to be used with the model.

In many linear regression models the first term is taken as a mean term or an intercept, i.e.,

x_{i, 1} = 1

, for

i = 1, 2, \dots, n

. This is provided as an option.

Often only some of the possible independent variables are included in a model; the facility to select variables to be included in the model is provided.

If part of the linear predictor can be represented by a variables with a known coefficient then this can be included in the model by using an offset,

o

η = o + \sum β_{j} x_{j} .

If the model is not of full rank the solution given will be only one of the possible solutions. Other estimates may be obtained by applying constraints to the parameters. These solutions can be obtained by using g02gkf after using g02gcf. Only certain linear combinations of the parameters will have unique estimates, these are known as estimable functions, these can be estimated and tested using g02gnf.

Details of the SVD are made available in the form of the matrix

P^{*}

P^{*} = (\begin{matrix} D^{- 1} P_{1}^{T} \\ P_{0}^{T} \end{matrix}) .

The generalized linear model with Poisson errors can be used to model contingency table data; see Cook and Weisberg (1982) and McCullagh and Nelder (1983).

4 References

Cook R D and Weisberg S (1982) Residuals and Influence in Regression Chapman and Hall

McCullagh P and Nelder J A (1983) Generalized Linear Models Chapman and Hall

Plackett R L (1974) The Analysis of Categorical Data Griffin

5 Arguments

1: $link$ – Character(1) Input

On entry: indicates which link function is to be used.

$link ='E'$: An exponent link is used.
$link ='I'$: An identity link is used.
$link ='L'$: A log link is used.
$link ='S'$: A square root link is used.
$link ='R'$: A reciprocal link is used.

Constraint:

link ='E'

'I'

'L'

'S'

'R'

2: $mean$ – Character(1) Input

On entry: indicates if a mean term is to be included.

$mean ='M'$: A mean term, intercept, will be included in the model.
$mean ='Z'$: The model will pass through the origin, zero-point.

Constraint:

mean ='M'

'Z'

3: $offset$ – Character(1) Input

On entry: indicates if an offset is required.

$offset ='Y'$: An offset is required and the offsets must be supplied in the seventh column of v.
$offset ='N'$: No offset is required.

Constraint:

offset ='Y'

'N'

4: $weight$ – Character(1) Input

On entry: indicates if prior weights are to be used.

$weight ='U'$: No prior weights are used.
$weight ='W'$: Prior weights are used and weights must be supplied in wt.

Constraint:

weight ='U'

'W'

5: $n$ – Integer Input

On entry:

n

, the number of observations.

Constraint:

n \geq 2

6: $x (ldx, m)$ – Real (Kind=nag_wp) array Input

On entry: the matrix of all possible independent variables.

x (i, j)

must contain the

i j

th element of x, for

i = 1, 2, \dots, n

and

j = 1, 2, \dots, m

7: $ldx$ – Integer Input

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

Constraint:

ldx \geq n

8: $m$ – Integer Input

On entry:

m

, the total number of independent variables.

Constraint:

m \geq 1

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

On entry: indicates which independent variables are to be included in the model.

isx (j) > 0

, the variable contained in the

j

th column of x is included in the regression model.

Constraints:

$isx (j) \geq 0$ , for $j = 1, 2, \dots, m$ ;
if $mean ='M'$ , exactly $ip - 1$ values of isx must be $> 0$ ;
if $mean ='Z'$ , exactly ip values of isx must be $> 0$ .

10: $ip$ – Integer Input

On entry: the number of independent variables in the model, including the mean or intercept if present.

Constraint:

ip > 0

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

On entry:

y

, observations on the dependent variable.

Constraint:

y (i) \geq 0.0

, for

i = 1, 2, \dots, n

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

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

n

weight ='W'

On entry: if

weight ='W'

wt must contain the weights to be used with the model.

wt (i) = 0.0

, the

i

th observation is not included in the model, in which case the effective number of observations is the number of observations with nonzero weights.

weight ='U'

, wt is not referenced and the effective number of observations is

n

Constraint: if

weight ='W'

wt (i) \geq 0.0

, for

i = 1, 2, \dots, n

13: $a$ – Real (Kind=nag_wp) Input

On entry: if

link ='E'

, a must contain the power of the exponential.

link \neq'E'

, a is not referenced.

Constraint: if

a \neq 0.0

link ='E'

14: $dev$ – Real (Kind=nag_wp) Output

On exit: the deviance for the fitted model.

15: $idf$ – Integer Output

On exit: the degrees of freedom asociated with the deviance for the fitted model.

16: $b (ip)$ – Real (Kind=nag_wp) array Output

On exit: the estimates of the parameters of the generalized linear model,

\hat{β}

mean ='M'

, the first element of b will contain the estimate of the mean parameter and

b (i + 1)

will contain the coefficient of the variable contained in column

j

x

, where

isx (j)

is the

i

th positive value in the array isx.

mean ='Z'

b (i)

will contain the coefficient of the variable contained in column

j

x

, where

isx (j)

is the

i

th positive value in the array isx.

17: $irank$ – Integer Output

On exit: the rank of the independent variables.

If the model is of full rank,

irank = ip

If the model is not of full rank, irank is an estimate of the rank of the independent variables. irank is calculated as the number of singular values greater that

eps \times

(largest singular value). It is possible for the SVD to be carried out but for irank to be returned as ip.

18: $se (ip)$ – Real (Kind=nag_wp) array Output

On exit: the standard errors of the linear parameters.

se (i)

contains the standard error of the parameter estimate in

b (i)

, for

i = 1, 2, \dots, ip

19: $cov (ip \times (ip + 1) / 2)$ – Real (Kind=nag_wp) array Output

On exit: the upper triangular part of the variance-covariance matrix of the ip parameter estimates given in b. They are stored packed by column, i.e., the covariance between the parameter estimate given in

b (i)

and the parameter estimate given in

b (j)

j \geq i

, is stored in

cov ((j \times (j - 1) / 2 + i))

20: $v (ldv, ip + 7)$ – Real (Kind=nag_wp) array Input/Output

On entry: if

offset ='N'

, v need not be set.

offset ='Y'

v (i, 7)

, for

i = 1, 2, \dots, n

, must contain the offset values

o_{i}

. All other values need not be set.

On exit: auxiliary information on the fitted model.

$v (i, 1)$	contains the linear predictor value, $η_{i}$ , for $i = 1, 2, \dots, n$ .
$v (i, 2)$	contains the fitted value, ${\hat{μ}}_{i}$ , for $i = 1, 2, \dots, n$ .
$v (i, 3)$	contains the variance standardization, $\frac{1}{τ_{i}}$ , for $i = 1, 2, \dots, n$ .
$v (i, 4)$	contains the square root of the working weight, $w_{i}^{\frac{1}{2}}$ , for $i = 1, 2, \dots, n$ .
$v (i, 5)$	contains the deviance residual, $r_{i}$ , for $i = 1, 2, \dots, n$ .
$v (i, 6)$	contains the leverage, $h_{i}$ , for $i = 1, 2, \dots, n$ .
$v (i, 7)$	contains the offset, $o_{i}$ , for $i = 1, 2, \dots, n$ . If $offset ='N'$ , all values will be zero.
$v (i, j)$	for $j = 8, \dots, ip + 7$ , contains the results of the $Q R$ decomposition or the singular value decomposition.

If the model is not of full rank, i.e.,

irank < ip

, the first ip rows of columns

8

ip + 7

contain the

P^{*}

matrix.

21: $ldv$ – Integer Input

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

Constraint:

ldv \geq n

22: $tol$ – Real (Kind=nag_wp) Input

On entry: indicates the accuracy required for the fit of the model.

The iterative weighted least squares procedure is deemed to have converged if the absolute change in deviance between iterations is less than

tol \times (1.0 + Current Deviance)

. This is approximately an absolute precision if the deviance is small and a relative precision if the deviance is large.

0.0 \leq tol < machine precision

, the routine will use

10 \times machine precision

instead.

Constraint:

tol \geq 0.0

23: $maxit$ – Integer Input

On entry: the maximum number of iterations for the iterative weighted least squares.

maxit = 0

, a default value of

10

is used.

Constraint:

maxit \geq 0

24: $iprint$ – Integer Input

On entry: indicates if the printing of information on the iterations is required.

$iprint \leq 0$

There is no printing.

$iprint > 0$

Every iprint iteration, the following are printed:

the deviance;
the current estimates;
and if the weighted least squares equations are singular, then this is indicated.

When printing occurs the output is directed to the current advisory message unit (see x04abf).

25: $eps$ – Real (Kind=nag_wp) Input

On entry: the value of eps is used to decide if the independent variables are of full rank and, if not, what is the rank of the independent variables. The smaller the value of eps the stricter the criterion for selecting the singular value decomposition.

0.0 \leq eps < machine precision

, the routine will use machine precision instead.

Constraint:

eps \geq 0.0

26: $wk ((ip \times ip + 3 \times ip + 22) / 2)$ – Real (Kind=nag_wp) array Workspace

27: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

−1

is recommended since useful values can be provided in some output arguments even when

ifail \neq 0

on exit. 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:

Note: in some cases g02gcf may return useful information.

$ifail = 1$: On entry, $a = 0.0$ and $link ='E'$ .
Constraint: if $link ='E'$ , $a \neq 0.0$ .

On entry, $eps = ⟨ value ⟩$ .
Constraint: $eps \geq 0.0$ .

On entry, $ip = ⟨ value ⟩$ .
Constraint: $ip \geq 1$ .

On entry, $ldv = ⟨ value ⟩$ and $n = ⟨ value ⟩$ .
Constraint: $ldv \geq n$ .

On entry, $ldx = ⟨ value ⟩$ and $n = ⟨ value ⟩$ .
Constraint: $ldx \geq n$ .

On entry, $link = ⟨ value ⟩$ .
Constraint: $link ='E'$ , $'I'$ , $'L'$ , $'S'$ or $'R'$ .

On entry, $m = ⟨ value ⟩$ .
Constraint: $m \geq 1$ .

On entry, $maxit = ⟨ value ⟩$ .
Constraint: $maxit \geq 0$ .

On entry, $mean = ⟨ value ⟩$ .
Constraint: $mean ='M'$ or $'Z'$ .

On entry, $n = ⟨ value ⟩$ .
Constraint: $n \geq 2$ .

On entry, $offset = ⟨ value ⟩$ .
Constraint: $offset ='Y'$ or $'N'$ .

On entry, $tol = ⟨ value ⟩$ .
Constraint: $tol \geq 0.0$ .

On entry, $weight = ⟨ value ⟩$ .
Constraint: $weight ='W'$ or $'U'$ .

$ifail = 2$: On entry, $wt (⟨ value ⟩) < 0.0$ .
Constraint: $wt (i) \geq 0.0$ , for $i = 1, 2, \dots, n$ .

$ifail = 3$: Number of requested x-variables greater than n.

On entry, ip incompatible with number of nonzero values of isx: $ip = ⟨ value ⟩$ .

On entry, $isx (⟨ value ⟩) < 0$ .
Constraint: $isx (j) \geq 0.0$ , for $j = 1, 2, \dots, m$ .

$ifail = 4$: On entry, $y (⟨ value ⟩) = ⟨ value ⟩$ .
Constraint: $y (i) \geq 0.0$ , for $i = 1, 2, \dots, n$ .

$ifail = 5$: A fitted value is at the boundary, i.e., $\hat{μ} = 0.0$ . This may occur if there are $y$ values of $0.0$ and the model is too complex for the data. The model should be reformulated with, perhaps, some observations dropped.

$ifail = 6$: SVD solution failed to converge.

$ifail = 7$: The iterative weighted least squares has failed to converge in maxit (or default $10$ ) iterations. The value of maxit could be increased but it may be advantageous to examine the convergence using the iprint option. This may indicate that the convergence is slow because the solution is at a boundary in which case it may be better to reformulate the model.

$ifail = 8$: The rank of the model has changed during the weighted least squares iterations. The estimate for $β$ returned may be reasonable, but you should check how the deviance has changed during iterations.

$ifail = 9$: The degrees of freedom for error are $0$ . A saturated model has been fitted.

$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

The accuracy depends on the value of tol as described in Section 5. As the deviance is a function of

\log μ

the accuracy of the

\hat{β}

will only be a function of tol. tol should, therefore, be set smaller than the accuracy required for

\hat{β}

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

g02gcf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

g02gcf 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

None.

10 Example

3 \times 5

contingency table given by Plackett (1974) is analysed by fitting terms for rows and columns. The table is:

\begin{array}{r} 141 & 67 & 114 & 79 & 39 \\ 131 & 66 & 143 & 72 & 35 \\ 36 & 14 & 38 & 28 & 16 \end{array} .

g02gc: FL CL CPP AD PY MB

NAG FL Interfaceg02gcf (glm_​poisson)

▸▿ 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
g02gcf (glm_poisson)