# NAG FL Interfaceg13nbf (cp_​pelt_​user)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

g13nbf detects change points in a univariate time series, that is, the time points at which some feature of the data, for example the mean, changes. Change points are detected using the PELT (Pruned Exact Linear Time) algorithm and a user-supplied cost function.

## 2Specification

Fortran Interface
 Subroutine g13nbf ( n, beta, k, ntau, tau, y,
 Integer, Intent (In) :: n, minss Integer, Intent (Inout) :: iuser(*), ifail Integer, Intent (Out) :: ntau, tau(n) Real (Kind=nag_wp), Intent (In) :: beta, k Real (Kind=nag_wp), Intent (Inout) :: y(*), ruser(*) External :: costfn
#include <nag.h>
 void g13nbf_ (const Integer *n, const double *beta, const Integer *minss, const double *k, void (NAG_CALL *costfn)(const Integer *ts, const Integer *nr, const Integer r[], double c[], double y[], Integer iuser[], double ruser[], Integer *info),Integer *ntau, Integer tau[], double y[], Integer iuser[], double ruser[], Integer *ifail)
The routine may be called by the names g13nbf or nagf_tsa_cp_pelt_user.

## 3Description

Let ${y}_{1:n}=\left\{{y}_{j}:j=1,2,\dots ,n\right\}$ denote a series of data and $\tau =\left\{{\tau }_{i}:i=1,2,\dots ,m\right\}$ denote a set of $m$ ordered (strictly monotonic increasing) indices known as change points with $1\le {\tau }_{i}\le n$ and ${\tau }_{m}=n$. For ease of notation we also define ${\tau }_{0}=0$. The $m$ change points, $\tau$, split the data into $m$ segments, with the $i$th segment being of length ${n}_{i}$ and containing ${y}_{{\tau }_{i-1}+1:{\tau }_{i}}$.
Given a user-supplied cost function, $C\left({y}_{{\tau }_{i-1}+1:{\tau }_{i}}\right)$ g13nbf solves
 $minimize m,τ ∑ i=1 m (C(yτi-1+1:τi)+β)$ (1)
where $\beta$ is a penalty term used to control the number of change points. This minimization is performed using the PELT algorithm of Killick et al. (2012). The PELT algorithm is guaranteed to return the optimal solution to (1) if there exists a constant $K$ such that
 $C ( y (u+1) : v ) + C ( y (v+1) : w ) + K ≤ C ( y (u+1) : w )$ (2)
for all $u
Chen J and Gupta A K (2010) Parametric Statistical Change Point Analysis With Applications to Genetics Medicine and Finance Second Edition Birkhäuser
Killick R, Fearnhead P and Eckely I A (2012) Optimal detection of changepoints with a linear computational cost Journal of the American Statistical Association 107:500 1590–1598

## 5Arguments

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×\mathrm{log}\left(n\right)$
AIC
$\beta =2p$
Hannan-Quinn
$\beta =2p×\mathrm{log}\left(\mathrm{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{k}$Real (Kind=nag_wp) Input
On entry: $K$, the constant value that satisfies equation (2). If $K$ exists, it is unlikely to be unique in such cases, it is recommened that the largest value of $K$, that satisfies equation (2), is chosen. No check is made that $K$ is the correct value for the supplied cost function.
5: $\mathbf{costfn}$Subroutine, supplied by the user. External Procedure
The cost function, $C$. costfn must calculate a vector of costs for a number of segments.
The specification of costfn is:
Fortran Interface
 Subroutine costfn ( ts, nr, r, c, y, info)
 Integer, Intent (In) :: ts, nr, r(nr) Integer, Intent (Inout) :: iuser(*), info Real (Kind=nag_wp), Intent (Inout) :: y(*), ruser(*) Real (Kind=nag_wp), Intent (Out) :: c(nr)
 void costfn (const Integer *ts, const Integer *nr, const Integer r[], double c[], double y[], Integer iuser[], double ruser[], Integer *info)
1: $\mathbf{ts}$Integer Input
On entry: a reference time point.
2: $\mathbf{nr}$Integer Input
On entry: number of segments being considered.
3: $\mathbf{r}\left({\mathbf{nr}}\right)$Integer array Input
On entry: time points which, along with ts, define the segments being considered, $0\le {\mathbf{r}}\left(i\right)\le n$ for $i=1,2,\dots {\mathbf{nr}}$.
4: $\mathbf{c}\left({\mathbf{nr}}\right)$Real (Kind=nag_wp) array Output
On exit: the cost function, $C$, with
 $c(i)= { C(yri:t) ​ if ​t>ri, C(yt:ri) ​ otherwise.$
where $t={\mathbf{ts}}$ and ${r}_{i}={\mathbf{r}}\left(i\right)$.
It should be noted that if $t>{r}_{i}$ for any value of $i$ then it will be true for all values of $i$. Therefore, the inequality need only be tested once per call to costfn.
5: $\mathbf{y}\left(*\right)$Real (Kind=nag_wp) array User Data
costfn is called with y as supplied to g13nbf. You are free to use the array y to supply information to costfn.
y is supplied in addition to iuser and ruser for ease of coding as in most cases costfn will require (functions of) the time series, $y$.
6: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
7: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
costfn is called with the arguments iuser and ruser as supplied to g13nbf. You should use the arrays iuser and ruser to supply information to costfn.
8: $\mathbf{info}$Integer Input/Output
On entry: ${\mathbf{info}}=0$.
On exit: set info to a nonzero value if you wish g13nbf to terminate with ${\mathbf{ifail}}={\mathbf{51}}$.
costfn must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which g13nbf is called. Arguments denoted as Input must not be changed by this procedure.
Note: costfn should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by g13nbf. If your code inadvertently does return any NaNs or infinities, g13nbf is likely to produce unexpected results.
6: $\mathbf{ntau}$Integer Output
On exit: $m$, the number of change points detected.
7: $\mathbf{tau}\left({\mathbf{n}}\right)$Integer array Output
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 g13nbf, but is passed directly to costfn 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 g13nbf, but are passed directly to costfn 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).

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

Not applicable.

## 8Parallelism and Performance

g13nbf is not threaded in any implementation.

g13naf performs the same calculations for a cost function selected from a provided set of cost functions. If the required cost function belongs to this provided set then g13naf can be used without the need to provide a cost function routine.

## 10Example

This example identifies changes in the scale parameter, under the assumption that the data has a gamma distribution, for a simulated dataset with $100$ observations. A penalty, $\beta$ of $3.6$ is used and the minimum segment size is set to $3$. The shape parameter is fixed at $2.1$ across the whole input series.
The cost function used is
 $C(yτi-1+1:τi) = 2⁢ a⁢ ni (log⁡Si-log(a⁢ni))$
where $a$ is a shape parameter that is fixed for all segments and ${n}_{i}={\tau }_{i}-{\tau }_{i-1}+1$.

### 10.1Program Text

Program Text (g13nbfe.f90)

### 10.2Program Data

Program Data (g13nbfe.d)

### 10.3Program Results

Program Results (g13nbfe.r)
This example plot shows the original data series and the estimated change points.