NAG FL Interface
g13nef (cp_​binary_​user)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{n}$ – Integer Input

On entry: $n$, the length of the time series.

Constraint: $\mathbf{n}\ge 2$.

2: $\mathbf{beta}$ – Real (Kind=nag_wp) Input

On entry: $\beta$, the penalty term.

There are a number of standard ways of setting $\beta$, including:

SIC or BIC

$\beta =p\times \log \left(n\right)$.

AIC

$\beta =2p$.

Hannan-Quinn

$\beta =2p\times \log \left(\log \left(n\right)\right)$.

where $p$ is the number of parameters being treated as estimated in each segment. The value of $p$ will depend on the cost function being used.

If no penalty is required then set $\beta =0$. Generally, the smaller the value of $\beta$ the larger the number of suggested change points.

3: $\mathbf{minss}$ – Integer Input

On entry: the minimum distance between two change points, that is ${\tau }_i-{\tau }_{i-1}\ge \mathbf{minss}$.

Constraint: $\mathbf{minss}\ge 2$.

4: $\mathbf{mdepth}$ – Integer Input

On entry: $K$, the maximum depth for the iterative process, which in turn puts an upper limit on the number of change points with $m\le 2^K$.

If $K\le 0$ then no limit is put on the depth of the iterative process and no upper limit is put on the number of change points, other than that inherent in the length of the series and the value of minss.

5: $\mathbf{chgpfn}$ – Subroutine, supplied by the user. External Procedure

chgpfn must calculate a proposed change point, and the associated costs, within a specified segment.

The specification of chgpfn is:

Fortran Interface

Subroutine chgpfn ( side, u, w, minss, v, cost, y, iuser, ruser, info) Integer, Intent (In) :: side, u, w, minss Integer, Intent (Inout) :: iuser(*), info Integer, Intent (Out) :: v Real (Kind=nag_wp), Intent (Inout) :: y(*), ruser(*) Real (Kind=nag_wp), Intent (Out) :: cost(3)

C Header Interface

void  chgpfn_ (const Integer *side, const Integer *u, const Integer *w, const Integer *minss, Integer *v, double cost[], double y[], Integer iuser[], double ruser[], Integer *info)

C++ Header Interface

#include <nag.h> extern "C" { void  chgpfn_ (const Integer &side, const Integer &u, const Integer &w, const Integer &minss, Integer &v, double cost[], double y[], Integer iuser[], double ruser[], Integer &info) }

1: $\mathbf{side}$ – Integer Input

On entry: flag indicating what chgpfn must calculate and at which point of the Binary Segmentation it has been called.

$\mathbf{side}=-1$

only $C\left(y_{u:w}\right)$ need be calculated and returned in $\mathbf{cost}\left(1\right)$, neither v nor the other elements of cost need be set. In this case, $u=1$ and $w=\mathrm{n}$.

$\mathbf{side}=0$

all elements of cost and v must be set. In this case, $u=1$ and $w=\mathrm{n}$.

$\mathbf{side}=1$

the segment, $y_{u:w}$, is a left-hand side subsegment from a previous iteration of the Binary Segmentation algorithm. All elements of cost and v must be set.

$\mathbf{side}=2$

the segment, $y_{u:w}$, is a right-hand side subsegment from a previous iteration of the Binary Segmentation algorithm. All elements of cost and v must be set.

The distinction between $\mathbf{side}=1$ and $2$ may allow for chgpfn to be implemented in a more efficient manner. See Section 10 for one such example.

The first call to chgpfn will always have $\mathbf{side}=-1$ and the second call will always have $\mathbf{side}=0$. All subsequent calls will be made with $\mathbf{side}=1$ or $2$.

2: $\mathbf{u}$ – Integer Input

On entry: $u$, the start of the segment of interest.

3: $\mathbf{w}$ – Integer Input

On entry: $w$, the end of the segment of interest.

4: $\mathbf{minss}$ – Integer Input

On entry: the minimum distance between two change points, as passed to g13nef.

5: $\mathbf{v}$ – Integer Output

On exit: if $\mathbf{side}=-1$ then v need not be set.

if $\mathbf{side}\ne -1$ then $v$, the proposed change point. That is, the value which minimizes

$$\underset{v}{\mathrm{minimize}}C\left(y_{u:v}\right)+C\left(y_{v+1:w}\right)$$

for $v=u+\mathbf{minss}-1$ to $w-\mathbf{minss}$.

6: $\mathbf{cost}\left(3\right)$ – Real (Kind=nag_wp) array Output

On exit: costs associated with the proposed change point, $v$.

If $\mathbf{side}=-1$ then $\mathbf{cost}\left(1\right)=C\left(y_{u:w}\right)$ and the remaining two elements of cost need not be set.

If $\mathbf{side}\ne -1$ then

• $\mathbf{cost}\left(1\right)=C\left(y_{u:v}\right)+C\left(y_{v+1:w}\right)$.
• $\mathbf{cost}\left(2\right)=C\left(y_{u:v}\right)$.
• $\mathbf{cost}\left(3\right)=C\left(y_{v+1:w}\right)$.

7: $\mathbf{y}\left(*\right)$ – Real (Kind=nag_wp) array User Data

chgpfn is called with y as supplied to g13nef. You are free to use the array y to supply information to chgpfn.

y is supplied in addition to iuser and ruser for ease of coding as in most cases chgpfn will require (functions of) the time series, $y$.

8: $\mathbf{iuser}\left(*\right)$ – Integer array User Workspace

9: $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) array User Workspace

chgpfn is called with the arguments iuser and ruser as supplied to g13nef. You should use the arrays iuser and ruser to supply information to chgpfn.

10: $\mathbf{info}$ – Integer Input/Output

On entry: $\mathbf{info}=0$.

On exit: in most circumstances info should remain unchanged.

If info is set to a strictly positive value then g13nef terminates with $\mathbf{ifail}=\mathbf{51}$.

If info is set to a strictly negative value the current segment is skipped (i.e., no change points are considered in this segment) and g13nef continues as normal. If info was set to a strictly negative value at any point and no other errors occur then g13nef will terminate with $\mathbf{ifail}=\mathbf{52}$.

chgpfn must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which g13nef is called. Arguments denoted as Input must not be changed by this procedure.

Note: chgpfn should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by g13nef. If your code inadvertently does return any NaNs or infinities, g13nef is likely to produce unexpected results.

6: $\mathbf{ntau}$ – Integer Output

On exit: $m$, the number of change points detected.

7: $\mathbf{tau}\left(*\right)$ – Integer array Output

Note: the dimension of the array tau must be at least $\min \left(\lceil \frac{\mathbf{n}}{\mathbf{minss}}\rceil ,2^{\mathbf{mdepth}}\right)$ if $\mathbf{mdepth}>0$, and at least $\lceil \frac{\mathbf{n}}{\mathbf{minss}}\rceil$ otherwise.

On exit: the first $m$ elements of tau hold the location of the change points. The $i$th segment is defined by $y_{\left({\tau }_{i-1}+1\right)}$ to $y_{{\tau }_i}$, where ${\tau }_0=0$ and ${\tau }_i=\mathbf{tau}\left(i\right),1\le i\le m$.

The remainder of tau is used as workspace.

8: $\mathbf{y}\left(*\right)$ – Real (Kind=nag_wp) array User Data

y is not used by g13nef, but is passed directly to chgpfn and may be used to pass information to this routine. y will usually be used to pass (functions of) the time series, $y$ of interest.

9: $\mathbf{iuser}\left(*\right)$ – Integer array User Workspace

10: $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) array User Workspace

iuser and ruser are not used by g13nef, but are passed directly to chgpfn and may be used to pass information to this routine.

11: $\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 $0$ is recommended. 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).

6 Error Indicators and Warnings

$\mathbf{ifail}=11$

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 2$.

$\mathbf{ifail}=31$

On entry, $\mathbf{minss}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{minss}\ge 2$.

$\mathbf{ifail}=51$

User requested termination by setting $\mathbf{info}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=52$

User requested a segment to be skipped by setting $\mathbf{info}=〈\mathit{\text{value}}〉$.

$\mathbf{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.

$\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.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results