Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
ReactionList Class Reference

A type used as a collection of reactions. More...

#include <ReactionList.hpp>

Public Types

using value_type = Reaction
 The type of the value stored in a ReactionList (for STL compatibility reasons).
 

Public Member Functions

 ReactionList ()
 Construct a default ReactionList object.
 
 ReactionList (std::initializer_list< Reaction > reactions)
 Construct an ReactionList object with given reactions.
 
 ReactionList (const Vec< Reaction > &reactions)
 Construct an ReactionList object with given reactions.
 
auto append (const Reaction &reaction) -> void
 Append a new reaction to the list of reaction.
 
auto data () const -> const Vec< Reaction > &
 Return the internal collection of Reaction objects.
 
auto empty () const -> bool
 Return true if there are no reactions in the collection.
 
auto size () const -> Index
 Return the number of reactions in the collection.
 
auto operator[] (Index i) const -> const Reaction &
 Return the Reaction object with given index.
 
auto operator[] (Index i) -> Reaction &
 Return the Reaction object with given index.
 
auto find (const String &name) const -> Index
 Return the index of the reaction with given unique name or the number of reactions if not found.
 
auto findWithName (const String &name) const -> Index
 Return the index of the reaction with given unique name or the number of reactions if not found.
 
auto index (const String &name) const -> Index
 Return the index of the reaction with given unique name or throw a runtime error if not found.
 
auto indexWithName (const String &name) const -> Index
 Return the index of the reaction with given unique name or throw a runtime error if not found.
 
auto get (const String &name) const -> const Reaction &
 Return the reaction with a given name.
 
auto getWithName (const String &name) const -> const Reaction &
 Return the reaction with a given name.
 
auto withNames (const StringList &names) const -> ReactionList
 Return all reactions with given names.
 
 operator Vec< Reaction > & ()
 Convert this ReactionList object into its Vec<Reaction>.
 
 operator Vec< Reaction >const & () const
 Convert this ReactionList object into its Vec<Reaction>.
 
template<typename InputIterator >
 ReactionList (InputIterator begin, InputIterator end)
 Construct an ReactionList object with given begin and end iterators.
 
auto begin () const
 Return begin const iterator of this ReactionList instance (for STL compatibility reasons).
 
auto begin ()
 Return begin iterator of this ReactionList instance (for STL compatibility reasons).
 
auto end () const
 Return end const iterator of this ReactionList instance (for STL compatibility reasons).
 
auto end ()
 Return end iterator of this ReactionList instance (for STL compatibility reasons).
 
auto push_back (const Reaction &species) -> void
 Append a new Reaction at the back of the container (for STL compatibility reasons).
 
template<typename Iterator , typename InputIterator >
auto insert (Iterator pos, InputIterator begin, InputIterator end) -> void
 Insert a container of Reaction objects into this ReactionList instance (for STL compatibility reasons).
 

Detailed Description

A type used as a collection of reactions.


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