# NAG FL Interfacee04ycf (lsq_​uncon_​covariance)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

e04ycf returns estimates of elements of the variance-covariance matrix of the estimated regression coefficients for a nonlinear least squares problem. The estimates are derived from the Jacobian of the function $f\left(x\right)$ at the solution.
This routine may be used following any one of the nonlinear least squares routines e04fcf, e04fyf, e04gbf, e04gdf, e04gyf, e04gzf, e04hef or e04hyf.

## 2Specification

Fortran Interface
 Subroutine e04ycf ( job, m, n, s, v, ldv, cj, work,
 Integer, Intent (In) :: job, m, n, ldv Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: fsumsq, s(n) Real (Kind=nag_wp), Intent (Inout) :: v(ldv,n) Real (Kind=nag_wp), Intent (Out) :: cj(n), work(n)
#include <nag.h>
 void e04ycf_ (const Integer *job, const Integer *m, const Integer *n, const double *fsumsq, const double s[], double v[], const Integer *ldv, double cj[], double work[], Integer *ifail)
The routine may be called by the names e04ycf or nagf_opt_lsq_uncon_covariance.

## 3Description

e04ycf is intended for use when the nonlinear least squares function, $F\left(x\right)={f}^{\mathrm{T}}\left(x\right)f\left(x\right)$, represents the goodness-of-fit of a nonlinear model to observed data. The routine assumes that the Hessian of $F\left(x\right)$, at the solution, can be adequately approximated by $2{J}^{\mathrm{T}}J$, where $J$ is the Jacobian of $f\left(x\right)$ at the solution. The estimated variance-covariance matrix $C$ is then given by
 $C=σ2(JTJ)−1, JTJ nonsingular,$
where ${\sigma }^{2}$ is the estimated variance of the residual at the solution, $\overline{x}$, given by
 $σ2=F(x¯) m-n ,$
$m$ being the number of observations and $n$ the number of variables.
The diagonal elements of $C$ are estimates of the variances of the estimated regression coefficients. See the E04 Chapter Introduction, Bard (1974) and Wolberg (1967) for further information on the use of $C$.
When ${J}^{\mathrm{T}}J$ is singular then $C$ is taken to be
 $C=σ2 (JTJ) †,$
where ${\left({J}^{\mathrm{T}}J\right)}^{†}$ is the pseudo-inverse of ${J}^{\mathrm{T}}J$, and
 $σ2 = F (x¯) m-k , k=rank ​(J)$
but in this case the argument ifail is returned as nonzero as a warning to you that $J$ has linear dependencies in its columns. The assumed rank of $J$ can be obtained from ifail.
The routine can be used to find either the diagonal elements of $C$, or the elements of the $j$th column of $C$, or the whole of $C$.
e04ycf must be preceded by one of the nonlinear least squares routines mentioned in Section 1, and requires the arguments fsumsq, s and v to be supplied by those routines (e.g., see e04fcf). fsumsq is the residual sum of squares $F\left(\overline{x}\right)$ and s and v contain the singular values and right singular vectors respectively in the singular value decomposition of $J$. s and v are returned directly by the comprehensive routines e04fcf, e04gbf, e04gdf and e04hef, but are returned as part of the workspace argument w (from one of the easy-to-use routines e04fyf, e04gyf, e04gzf and e04hyf). In the case of e04fyf, s starts at ${\mathbf{w}}\left(\mathit{NS}\right)$, where
 $NS=6× n+2× m+m× n+1+ max(1, n × (n-1) / 2 )$
and in the cases of the remaining easy-to-use routines, s starts at ${\mathbf{w}}\left(\mathit{NS}\right)$, where
 $NS=7× n+2× m+m× n+n× (n+1) / 2+1+ max(1, n × (n-1) / 2 ) .$
The argument v starts immediately following the elements of s, so that v starts at ${\mathbf{w}}\left(\mathit{NV}\right)$, where
 $NV=NS+n .$
For all the easy-to-use routines the argument ldv must be supplied as n. Thus a call to e04ycf following e04fyf can be illustrated as
```.
.
.
Call e04fyf (m, n, lfun1, x, fsumsq, w, lw, iuser, ruser, ifail)
.
.
.
ns = 6*n + 2*m + m*n + 1 + max(1,n*(n-1)/2)
nv = ns + n
Call e04ycf (job, m, n, fsumsq, w(ns), w(nv), n, cj, work, ifail)```
where the arguments m, n, fsumsq and the $\left(n+{n}^{2}\right)$ elements ${\mathbf{w}}\left(\mathit{NS}\right),{\mathbf{w}}\left(\mathit{NS}+1\right),\dots ,\phantom{\rule{0ex}{0ex}}{\mathbf{w}}\left(\mathit{NV}+{{\mathbf{n}}}^{2}-1\right)$ must not be altered between the calls to e04fyf and e04ycf. The above illustration also holds for a call to e04ycf following a call to one of e04gyf, e04gzf or e04hyf, except that $\mathit{NS}$ must be computed as
 $NS=7× n+2× m+m× n+ (n×(n+1)) /2+1+ max((1, n × (n-1) )/2) .$
Bard Y (1974) Nonlinear Parameter Estimation Academic Press
Wolberg J R (1967) Prediction Analysis Van Nostrand

## 5Arguments

1: $\mathbf{job}$Integer Input
On entry: which elements of $C$ are returned as follows:
${\mathbf{job}}=-1$
The $n×n$ symmetric matrix $C$ is returned.
${\mathbf{job}}=0$
The diagonal elements of $C$ are returned.
${\mathbf{job}}>0$
The elements of column job of $C$ are returned.
Constraint: $-1\le {\mathbf{job}}\le {\mathbf{n}}$.
2: $\mathbf{m}$Integer Input
On entry: the number $m$ of observations (residuals ${f}_{i}\left(x\right)$).
Constraint: ${\mathbf{m}}\ge {\mathbf{n}}$.
3: $\mathbf{n}$Integer Input
On entry: the number $n$ of variables $\left({x}_{j}\right)$.
Constraint: $1\le {\mathbf{n}}\le {\mathbf{m}}$.
4: $\mathbf{fsumsq}$Real (Kind=nag_wp) Input
On entry: the sum of squares of the residuals, $F\left(\overline{x}\right)$, at the solution $\overline{x}$, as returned by the nonlinear least squares routine.
Constraint: ${\mathbf{fsumsq}}\ge 0.0$.
5: $\mathbf{s}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: the $n$ singular values of the Jacobian as returned by the nonlinear least squares routine. See Section 3 for information on supplying s following one of the easy-to-use routines.
6: $\mathbf{v}\left({\mathbf{ldv}},{\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: the $n×n$ right-hand orthogonal matrix (the right singular vectors) of $J$ as returned by the nonlinear least squares routine. See Section 3 for information on supplying v following one of the easy-to-use routines.
On exit: if ${\mathbf{job}}\ge 0$, v is unchanged.
If ${\mathbf{job}}=-1$, the leading $n×n$ part of v is overwritten by the $n×n$ matrix $C$. When e04ycf is called with ${\mathbf{job}}=-1$ following an easy-to-use routine this means that $C$ is returned, column by column, in the ${n}^{2}$ elements of w given by ${\mathbf{w}}\left(\mathit{NV}\right),{\mathbf{w}}\left(\mathit{NV}+1\right),\dots ,{\mathbf{w}}\left(\mathit{NV}+{{\mathbf{n}}}^{2}-1\right)$. (See Section 3 for the definition of $\mathit{NV}$.)
7: $\mathbf{ldv}$Integer Input
On entry: the first dimension of the array v as declared in the (sub)program from which e04ycf is called. When v is passed in the workspace argument w (following one of the easy-to-use least square routines), ldv must be the value n.
Constraint: ${\mathbf{ldv}}\ge {\mathbf{n}}$.
8: $\mathbf{cj}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
On exit: if ${\mathbf{job}}=0$, cj returns the $n$ diagonal elements of $C$.
If ${\mathbf{job}}=j>0$, cj returns the $n$ elements of the $j$th column of $C$.
If ${\mathbf{job}}=-1$, cj is not referenced.
9: $\mathbf{work}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Workspace
If ${\mathbf{job}}=-1$ or $0$, work is used as internal workspace.
If ${\mathbf{job}}>0$, work is not referenced.
10: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $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$ or $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 ${\mathbf{ifail}}\ne {\mathbf{0}}$ on exit. When the value $-\mathbf{1}$ 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).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-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 e04ycf may return useful information.
${\mathbf{ifail}}=1$
On entry, ${\mathbf{fsumsq}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{fsumsq}}\ge 0.0$.
On entry, ${\mathbf{job}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{job}}\ge -1$.
On entry, ${\mathbf{job}}=-1$, ${\mathbf{ldv}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constaint: if ${\mathbf{job}}=-1$, ${\mathbf{ldv}}\ge {\mathbf{n}}$.
On entry, ${\mathbf{job}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{job}}\le {\mathbf{n}}$.
On entry, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{m}}\ge {\mathbf{n}}$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 1$.
${\mathbf{ifail}}=2$
The singular values are all zero, so that at the solution the Jacobian matrix has rank $0$.
${\mathbf{ifail}}>2$
At the solution the Jacobian matrix contains linear, or near linear, dependencies amongst its columns. The required elements of $C$ have still been computed based upon $J$ having an assumed rank ${\mathbf{ifail}}-2=⟨\mathit{\text{value}}⟩$. The rank is computed by regarding as zero singular values $SV\left(j\right)$ that are not larger than $10×\epsilon ×SV\left(1\right)$, where $\epsilon$ is the machine precision (see x02ajf).
Overflow
If overflow occurs then either an element of $C$ is very large, or the singular values or singular vectors have been incorrectly supplied.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{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.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

## 7Accuracy

The computed elements of $C$ will be the exact covariances corresponding to a closely neighbouring Jacobian matrix $J$.

## 8Parallelism and Performance

e04ycf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
e04ycf 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.

When ${\mathbf{job}}=-1$ the time taken by e04ycf is approximately proportional to ${n}^{3}$. When ${\mathbf{job}}\ge 0$ the time taken by the routine is approximately proportional to ${n}^{2}$.

## 10Example

This example estimates the variance-covariance matrix $C$ for the least squares estimates of ${x}_{1}$, ${x}_{2}$ and ${x}_{3}$ in the model
 $y=x1+t1x2t2+x3t3$
using the $15$ sets of data given in the following table:
 $y t1 t2 t3 0.14 1.0 15.0 1.0 0.18 2.0 14.0 2.0 0.22 3.0 13.0 3.0 0.25 4.0 12.0 4.0 0.29 5.0 11.0 5.0 0.32 6.0 10.0 6.0 0.35 7.0 9.0 7.0 0.39 8.0 8.0 8.0 0.37 9.0 7.0 7.0 0.58 10.0 6.0 6.0 0.73 11.0 5.0 5.0 0.96 12.0 4.0 4.0 1.34 13.0 3.0 3.0 2.10 14.0 2.0 2.0 4.39 15.0 1.0 1.0$
The program uses $\left(0.5,1.0,1.5\right)$ as the initial guess at the position of the minimum and computes the least squares solution using e04fyf. See the routine document e04fyf for further information.

### 10.1Program Text

Program Text (e04ycfe.f90)

### 10.2Program Data

Program Data (e04ycfe.d)

### 10.3Program Results

Program Results (e04ycfe.r)