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
boost::uuids::detail::sha1::digest_type	getHashDigest () const
	Update hash from snippet. More...
bool	requiresKernel () const
	Does this var init snippet require kernel-based connectivity. More...
Public Member Functions inherited from Snippet::Base
virtual	~Base ()
virtual DerivedParamVec	getDerivedParams () const
virtual EGPVec	getExtraGlobalParams () const
size_t	getExtraGlobalParamIndex (const std::string &paramName) const
	Find the index of a named extra global parameter. More...

Additional Inherited Members
Public Types inherited from Snippet::Base
typedef std::vector< std::string >	StringVec
typedef std::vector< EGP >	EGPVec
typedef std::vector< ParamVal >	ParamValVec
typedef std::vector< DerivedParam >	DerivedParamVec
Protected Member Functions inherited from Snippet::Base
void	updateHash (boost::uuids::detail::sha1 &hash) const
void	validate () const
	Validate names of parameters etc. More...
Static Protected Member Functions inherited from Snippet::Base
template<typename T >
static size_t	getNamedVecIndex (const std::string &name, const std::vector< T > &vec)

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