NAME

       IsoSpec::LayeredMarginal - LayeredMarginal class.

SYNOPSIS

       #include <marginalTrek++.h>

       Inherits IsoSpec::Marginal.

   Public Member Functions
       LayeredMarginal (Marginal &&m, int tabSize=1000, int hashSize=1000)
           Move constructor: specializes the Marginal class.
       LayeredMarginal (const LayeredMarginal &other)=delete
       LayeredMarginal & operator= (const LayeredMarginal &other)=delete
       bool extend (double new_threshold, bool do_sort=true)
           Extend the set of computed subisotopologues to those above the new threshold.
       double get_lProb (int idx) const
           get the log-probability of the idx-th subisotopologue, see details in
           PrecalculatedMarginal::get_lProb.
       double get_prob (int idx) const
           get the probability of the idx-th subisotopologue, see details in
           PrecalculatedMarginal::get_eProb.
       double get_mass (int idx) const
           get the mass of the idx-th subisotopologue, see details in
           PrecalculatedMarginal::get_mass.
       const double * get_lProbs_ptr () const
           get the pointer to lProbs array. Accessing index -1 is legal and returns a guardian of
           -inf. Warning: The pointer gets invalidated on calls to extend()
       const Conf & get_conf (int idx) const
           get the counts of isotopes that define the subisotopologue, see details in
           PrecalculatedMarginal::get_conf.
       unsigned int get_no_confs () const
           Get the number of precomputed subisotopologues, see details in
           PrecalculatedMarginal::get_no_confs.
       double get_min_mass () const
           Get the minimal mass in current layer.
       double get_max_mass () const
           Get the maximal mass in current layer.
       double getModeLProb () const
           Get the log-probability of the mode subisotopologue.

   Additional Inherited Members

Detailed Description

       LayeredMarginal class.

       An extendable version of the PrecalculatedMarginal, where you can extend the threshold at
       will.

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

Constructor & Destructor Documentation

   IsoSpec::LayeredMarginal::LayeredMarginal (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 518 of file marginalTrek++.cpp.

Member Function Documentation

   bool IsoSpec::LayeredMarginal::extend (double new_threshold, bool do_sort = true)
       Extend the set of computed subisotopologues to those above the new threshold.

       Parameters
           new_threshold The new log-probability limiting the subisotopologues from below.

       Returns
           Returns false, if there are no fringe-subisotopologues (subisotopologues that were
           neighbours of the previously calculated subisotopologues, with log-probability below
           the previous threshold).

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

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

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

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

Author

       Generated automatically by Doxygen for IsoSpec from the source code.