NAME

       IsoSpec::MarginalTrek - The marginal distribution class (a subisotopologue).

SYNOPSIS

       #include <marginalTrek++.h>

       Inherits IsoSpec::Marginal.

   Public Member Functions
       MarginalTrek (Marginal &&m, int tabSize=1000, int hashSize=1000)
           Move constructor: specializes the Marginal class.
       MarginalTrek (const MarginalTrek &other)=delete
       MarginalTrek & operator= (const MarginalTrek &other)=delete
       bool probeConfigurationIdx (int idx)
           Check if the table of computed subisotopologues does not have to be extended.
       double getModeLProb () const
           Get the log-probability of the mode subisotopologue.
       const pod_vector< double > & conf_lprobs () const
       const pod_vector< double > & conf_masses () const
       const pod_vector< Conf > & confs () const

   Additional Inherited Members

Detailed Description

       The marginal distribution class (a subisotopologue).

       Definition at line 175 of file marginalTrek++.h.

Constructor & Destructor Documentation

   IsoSpec::MarginalTrek::MarginalTrek (Marginal && m, int tabSize = 1000, int hashSize = 1000)
       Move constructor: specializes the Marginal class.

       Parameters
           tabSize The size of the table used to store configurations in the allocator.
           hashSize The size of the hash table used to store visited subisotopologues.

       Definition at line 323 of file marginalTrek++.cpp.

Member Function Documentation

   double IsoSpec::MarginalTrek::getModeLProb () const [inline]
       Get the log-probability of the mode subisotopologue.

       Returns
           The log-probability of a/the most probable subisotopologue.

       Definition at line 223 of file marginalTrek++.h.

   bool IsoSpec::MarginalTrek::probeConfigurationIdx (int idx) [inline]
       Check if the table of computed subisotopologues does not have to be extended. This
       function checks if the idx-th most probable subisotopologue was memoized and if not,
       computes it and memoizes it.

       Parameters
           idx The number of the idx-th most probable subisotopologue.

       Returns
           Returns false if it the provided idx exceeds the total number of subisotopologues.

       Definition at line 211 of file marginalTrek++.h.

Author

       Generated automatically by Doxygen for IsoSpec from the source code.