ExactSurvivor¶

Implementation of recursion for exact missed-event survivor function.

Implements the exact-missed event probability calculations, as detailed in Hawkes, Jalali, and Colquhoun (1990). Specifically, this is equation 3.2.

Public Functions

ExactSurvivor(QMatrix const & _qmatrix, t_real _tau)

Initializes exact survivor functor.

Parameters

• _qmatrix -

  Partitioned matrix with open states in top left corner.

• _tau -

  Missed event cutoff time.

template < class T >

ExactSurvivor(Eigen::DenseBase< T > const & _qmatrix, t_uint _nopen, t_real _tau)

Initializes exact survivor functor.

Parameters

• _qmatrix -

  A transition matrix with open states in top left corner

• _nopen -

  Number of open states.

• _tau -

  Missed event cutoff time.

ExactSurvivor(ExactSurvivor && _c)

Move constructor.

void set(QMatrix const & _qmatrix, t_real _tau)

Sets the values for which to compute exact g.

t_rmatrix af(t_real t)

Probability of no shut times detected between 0 and t.

t_rmatrix fa(t_real t)

Probability of no open times detected between 0 and t.

t_real get_tau()

Gets the value of tau;.

t_rmatrix recursion_af(t_uint _i, t_uint _m, t_uint _l)

Returns recursion matrix for af.

t_rmatrix recursion_fa(t_uint _i, t_uint _m, t_uint _l)

Returns recursion matrix for af.

t_rmatrix D_af(t_uint _i)

Returns Di matrix for af.

t_rmatrix D_fa(t_uint _i)

Returns Di matrix for af.

t_rvector eigenvalues_af()

Returns eigenvalues for af matrix.

t_rvector eigenvalues_fa()

Returns eigenvalues for fa matrix.

ExactSurvivor & operator=(ExactSurvivor && _c)

Move assignment.

class RecursionInterface

Implementation of recursion for exact missed-event Survivor function.

This is an interface to the function recursion_formula. In practice, this object needs not be called directly. Rather the public interface (which is about computing the likelihood for an event of duration t) is in the containing class ExactSurvivor.

Public Type

typedef t_rmatrix t_element

Element on which to perform recursion.

Public Functions

RecursionInterface(QMatrix const & _qmatrix, t_real _tau, bool _doAF = true)

Constructor.

Parameters

• _qmatrix -

  The transition state matrix for which to compute \(^eR_{AF}(t\rightarrow\infty)\)

• _tau -

  Maximum length of missed events

• _doAF -

  Whether to do AF (true) or FA

t_element operator()(t_uint _i, t_uint _m, t_uint _l)

Recursion element i, m, l.

t_element const & getD(t_uint _i)

Returns D values.

t_real get_eigvals(t_uint _i)

Returns i \(^{th}\) eigenvalue.

t_uint nbeigvals()

Returns the number of eigenvalues.

t_rvector const & eigenvalues()

Reference to eigenvalues.

decltype(t_rmatrix::Zero(1, 1)) zero()

A null matrix of appropriate size.