InitVarSnippet::Exponential Class Reference

Initialises variable by sampling from the exponential distribution. More...

#include <initVarSnippet.h>

Inheritance diagram for InitVarSnippet::Exponential:

Public Member Functions
	DECLARE_SNIPPET (InitVarSnippet::Exponential, 1)
	SET_CODE ("$(value) = $(lambda) * $(gennrand_exponential);")
virtual StringVec	getParamNames () const override
	Gets names of of (independent) model parameters. More...
Public Member Functions inherited from InitVarSnippet::Base
virtual std::string	getCode () const
Public Member Functions inherited from Snippet::Base
virtual	~Base ()
virtual DerivedParamVec	getDerivedParams () const

Additional Inherited Members
Public Types inherited from Snippet::Base
typedef std::function< double(const std::vector< double > &, double)>	DerivedParamFunc
typedef std::vector< std::string >	StringVec
typedef std::vector< std::pair< std::string, std::string > >	StringPairVec
typedef std::vector< std::pair< std::string, std::pair< std::string, double > > >	NameTypeValVec
typedef std::vector< std::pair< std::string, DerivedParamFunc > >	DerivedParamVec

Detailed Description

Initialises variable by sampling from the exponential distribution.

This snippet takes 1 parameter:

• lambda - mean event rate (events per unit time/distance)

Member Function Documentation

DECLARE_SNIPPET()

InitVarSnippet::Exponential::DECLARE_SNIPPET	(	InitVarSnippet::Exponential	,
		1
	)

getParamNames()

virtual StringVec InitVarSnippet::Exponential::getParamNames ( ) const

inlineoverridevirtual

Gets names of of (independent) model parameters.

Reimplemented from Snippet::Base.

SET_CODE()

InitVarSnippet::Exponential::SET_CODE

(

)

---

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

• initVarSnippet.h