Simpact Cyan: HazardFunctionExp Class Reference

Simpact Cyan

Population based event driven simulation using mNRM

Helper class for time dependent exponential hazards. More...

#include <hazardfunctionexp.h>

Inheritance diagram for HazardFunctionExp:

Inheritance graph

Collaboration diagram for HazardFunctionExp:

Collaboration graph

Public Member Functions
	HazardFunctionExp (double A=0, double B=0)
	Constructor which specifies the parameters in exp(A+Bt). More...

double	evaluate (double t)
	Evaluate the hazard at time `t`. More...

double	calculateInternalTimeInterval (double t0, double dt)
	Map the real-world time `dt` to an internal time interval. More...

double	solveForRealTimeInterval (double t0, double Tdiff)
	For the specified internal time interval Tdiff, calculate the corresponding real-world time interval. More...

Detailed Description

Helper class for time dependent exponential hazards.

This is a helper class for hazards of the form

$h = \exp(A+Bt)$

.

Constructor & Destructor Documentation

HazardFunctionExp::HazardFunctionExp	(	double	A = `0`,
		double	B = `0`
	)

inline

Constructor which specifies the parameters in exp(A+Bt).

Member Function Documentation

double HazardFunctionExp::calculateInternalTimeInterval	(	double	t0,
		double	dt
	)

inlinevirtual

Map the real-world time dt to an internal time interval.

This calculates:

$dT = \int_{t_0}^{t_0 + dt} h(s) ds$

Implements HazardFunction.

double HazardFunctionExp::evaluate ( double t )

inlinevirtual

Evaluate the hazard at time t.

Implements HazardFunction.

double HazardFunctionExp::solveForRealTimeInterval	(	double	t0,
		double	Tdiff
	)

inlinevirtual

For the specified internal time interval Tdiff, calculate the corresponding real-world time interval.

This solves the following equation for $ dt $ :

$Tdiff = \int_{t_0}^{t_0 + dt} h(s) ds$

Implements HazardFunction.

The documentation for this class was generated from the following file:

src/lib/util/hazardfunctionexp.h