ISOSPEC_LOGGINGMARGINAL(3)

📦 version 2.3.2, in ubuntu resolute, ubuntu stonking

🌸 NAME 🌸

IsoSpec::LoggingMarginal< T > — bestie, this is a template class, and it lives in the IsoSpec family, and it is the one that keeps receipts (logs) on your marginals 💅

This page is from the Library Functions Manual (section 3), so you know it's a C++ library thing, not a command you type into your shell. Okurrr ✨

🎀 SYNOPSIS 🎀

Inherits IsoSpec::Marginal. Like, that's its whole personality lineage, no cap.

✨ Public Member Functions ✨

  • LoggingMarginal(T &&m)
  • LoggingMarginal(T &&m, int tabSize, int hashSize)
  • LoggingMarginal(const LoggingMarginal &other) = delete
  • LoggingMarginal &operator=(const LoggingMarginal &other) = delete
  • double getModeLProb() const
  • double get_lProb(int idx) const
  • double get_prob(int idx) const
  • double get_mass(int idx) const
  • const double *get_lProbs_ptr() const
  • const Conf &get_conf(int idx) const
  • unsigned int get_no_confs() const
  • bool probeConfigurationIdx(int idx)
  • double get_min_mass() const
  • double get_max_mass() const
  • double getModeMass() const
  • double getLightestConfMass() const
  • double getHeaviestConfMass() const
  • double getMonoisotopicConfMass() const
  • double getAtomAverageMass() const
  • double variance() const
  • double getTheoreticalAverageMass() const
  • double getLogSizeEstimate(double logEllipsoidRadius) const
  • void ensureModeConf()
  • const pod_vector<double> &conf_lprobs() const
  • const pod_vector<double> &conf_masses() const
  • int get_original_position(int idx) const
  • int get_isotopeNo() const
  • const double *get_lProbs() const
  • const double *get_masses() const
  • const double *get_atom_lProbs() const
  • const double *get_atom_masses() const
  • bool extend(double new_threshold, bool do_sort = true)

💜 Public Member Functions inherited from IsoSpec::Marginal 💜

  • Marginal(const double *_masses, const double *_probs, int _isotopeNo, int _atomCnt) — the class constructor, the glow-up origin story.
  • Marginal &operator=(const Marginal &other) = delete
  • Marginal(const Marginal &other) — copy constructor, it's giving duplicate-but-fresh.
  • Marginal(Marginal &&other) — move constructor, the "I'm taking your stuff and you're empty now" moment.
  • virtual ~Marginal() — destructor, clean exit, we love to see it.
  • int get_isotopeNo() const — hands you the number of isotopes of the element under investigation 🔍
  • const double *get_lProbs() const
  • double getLightestConfMass() const — the mass of the lightest subisotopologue, the lil baby of the group.
  • double getHeaviestConfMass() const — the mass of the heaviest subisotopologue, the big one, the main character.
  • double getMonoisotopicConfMass() const — the mass of the monoisotopic subisotopologue.
  • size_t getMonoisotopicAtomIndex() const — the index of the monoisotopic (aka most probable) atom. Iconic.
  • double getModeMass() — the mass of the mode subisotopologue.
  • double getModeLProb() — the log-probability of the mode subisotopologue.
  • double fastGetModeLProb() — same log-probability of the mode subisotopologue, but results are undefined if ensureModeConf() wasn't called before. So like… call it first, bestie, fr fr 😭
  • Conf computeModeConf() const — the probability of the mode subisotopologue.
  • double getSmallestLProb() const — the log-probability of the lightest subisotopologue.
  • double getAtomAverageMass() const — the average mass of a single atom.
  • double getTheoreticalAverageMass() const — the theoretical average mass of the molecule.
  • double variance() const — calculates the variance of the theoretical distribution describing the subisotopologue.
  • double getLogSizeEstimate(double logEllipsoidRadius) const — returns the estimated logarithm of the size of the marginal at a given ellipsoid radius.
  • void ensureModeConf()

🦋 Additional Inherited Members 🦋

Protected Member Functions inherited from IsoSpec::Marginal

  • ISOSPEC_FORCE_INLINE double unnormalized_logProb(Conf conf) const — calculates the log-probability of a given subisotopologue.
  • ISOSPEC_FORCE_INLINE double logProb(Conf conf) const

Protected Attributes inherited from IsoSpec::Marginal

  • const unsigned int isotopeNo
  • const unsigned int atomCnt
  • const double *const atom_lProbs
  • const double *const atom_masses
  • const double loggamma_nominator
  • Conf mode_conf
  • double mode_lprob

💖 DESCRIPTION 💖

Okay so, template time:

template<typename T>
    class IsoSpec::LoggingMarginal< T >"

Definition at line 525 of file marginalTrek++.h. (Yes, the quote mark at the end is right there in the source, we're keeping it, no editing the canon 💅)

✨ Constructor & Destructor Documentation ✨

  • template<typename T> IsoSpec::LoggingMarginal<T>::LoggingMarginal(T &&m) — [inline]. Definition at line 532 of file marginalTrek++.h.
  • template<typename T> IsoSpec::LoggingMarginal<T>::LoggingMarginal(T &&m, int tabSize, int hashSize) — [inline]. Definition at line 533 of file marginalTrek++.h.

🌈 Member Function Documentation 🌈

  • template<typename T> const pod_vector<double> &IsoSpec::LoggingMarginal<T>::conf_lprobs() const — [inline]. Definition at line 563 of file marginalTrek++.h.
  • template<typename T> const pod_vector<double> &IsoSpec::LoggingMarginal<T>::conf_masses() const — [inline]. Definition at line 564 of file marginalTrek++.h.
  • template<typename T> void IsoSpec::LoggingMarginal<T>::ensureModeConf() — [inline]. Definition at line 562 of file marginalTrek++.h.
  • template<typename T> bool IsoSpec::LoggingMarginal<T>::extend(double new_threshold, bool do_sort = true) — [inline]. Definition at line 571 of file marginalTrek++.h.
  • template<typename T> const double *IsoSpec::LoggingMarginal<T>::get_atom_lProbs() const — [inline]. Definition at line 569 of file marginalTrek++.h.
  • template<typename T> const double *IsoSpec::LoggingMarginal<T>::get_atom_masses() const — [inline]. Definition at line 570 of file marginalTrek++.h.
  • template<typename T> const Conf &IsoSpec::LoggingMarginal<T>::get_conf(int idx) const — [inline]. Definition at line 544 of file marginalTrek++.h.
  • template<typename T> int IsoSpec::LoggingMarginal<T>::get_isotopeNo() const — [inline]. Definition at line 566 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::get_lProb(int idx) const — [inline]. Definition at line 540 of file marginalTrek++.h.
  • template<typename T> const double *IsoSpec::LoggingMarginal<T>::get_lProbs() const — [inline]. Definition at line 567 of file marginalTrek++.h.
  • template<typename T> const double *IsoSpec::LoggingMarginal<T>::get_lProbs_ptr() const — [inline]. Definition at line 543 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::get_mass(int idx) const — [inline]. Definition at line 542 of file marginalTrek++.h.
  • template<typename T> const double *IsoSpec::LoggingMarginal<T>::get_masses() const — [inline]. Definition at line 568 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::get_max_mass() const — [inline]. Definition at line 548 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::get_min_mass() const — [inline]. Definition at line 547 of file marginalTrek++.h.
  • template<typename T> unsigned int IsoSpec::LoggingMarginal<T>::get_no_confs() const — [inline]. Definition at line 545 of file marginalTrek++.h.
  • template<typename T> int IsoSpec::LoggingMarginal<T>::get_original_position(int idx) const — [inline]. Definition at line 565 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::get_prob(int idx) const — [inline]. Definition at line 541 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getAtomAverageMass() const — [inline]. Definition at line 553 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getHeaviestConfMass() const — [inline]. Definition at line 551 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getLightestConfMass() const — [inline]. Definition at line 550 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getLogSizeEstimate(double logEllipsoidRadius) const — [inline]. Definition at line 556 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getModeLProb() const — [inline]. Definition at line 539 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getModeMass() const — [inline]. Definition at line 549 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getMonoisotopicConfMass() const — [inline]. Definition at line 552 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::getTheoreticalAverageMass() const — [inline]. Definition at line 555 of file marginalTrek++.h.
  • template<typename T> bool IsoSpec::LoggingMarginal<T>::probeConfigurationIdx(int idx) — [inline]. Definition at line 546 of file marginalTrek++.h.
  • template<typename T> double IsoSpec::LoggingMarginal<T>::variance() const — [inline]. Definition at line 554 of file marginalTrek++.h.

👑 Author 👑

Generated automatically by Doxygen for IsoSpec from the source code. Not me writing it by hand, the robots did that part 🤖✨

And that's the whole page, bestie 🫶 this is IsoSpec, page IsoSpec::L...rginal< T >(3), and yeah the manual header says section 3 and the footer is stamped by IsoSpec — go read the source at marginalTrek++.h if you wanna see the real thing, mwah 💋

📦 where this page comes from