viennashe::models::rate_base Struct Reference

The basic rate interface. More...

#include <reaction_rates.hpp>

Inheritance diagram for viennashe::models::rate_base:

Public Types
typedef double	value_type

Public Member Functions
virtual	~rate_base ()
virtual value_type	value () const =0
virtual rate_base *	clone () const =0
virtual value_type	operator() () const

Detailed Description

The basic rate interface.

Definition at line 27 of file reaction_rates.hpp.

Member Typedef Documentation

value_type

typedef double viennashe::models::rate_base::value_type

Definition at line 29 of file reaction_rates.hpp.

Constructor & Destructor Documentation

~rate_base()

virtual viennashe::models::rate_base::~rate_base ( )

inlinevirtual

Definition at line 31 of file reaction_rates.hpp.

Member Function Documentation

clone()

virtual rate_base * viennashe::models::rate_base::clone ( ) const

pure virtual

Generates a clone of itself (deep copy; uses new). The caller takes ownership

Returns

A pointer to a deep copy of itself

Implemented in viennashe::models::const_rate.

operator()()

virtual value_type viennashe::models::rate_base::operator() ( ) const

inlinevirtual

A wrapper to value()

Returns

The same as the virtual abstract method value()

Definition at line 49 of file reaction_rates.hpp.

value()

virtual value_type viennashe::models::rate_base::value ( ) const

pure virtual

The main functor interface

Returns

The rate in 1/s

Implemented in viennashe::models::const_rate.

---

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

• viennashe/models/markovchain/reaction_rates.hpp