IsoSpec(3)

๐Ÿ“ฆ
version 2.3.2 ยท 4 versions
, in ubuntu resolute, ubuntu stonking

IsoSpec(3) โ€” Library Functions Manual, but make it group chat. Okay so bestie, you asked for the IsoSpec(3) manual page and I am literally so obsessed. This is part 1, so buckle up. ๐Ÿ’–


โœจ NAME โœจ

IsoSpec โ€” that's it. That's the name. Iconic. ๐Ÿ‘‘


๐ŸŒˆ SYNOPSIS ๐ŸŒˆ

Here's the whole API vibe at a glance, no cap. ๐Ÿ‘€

๐Ÿงธ Classes ๐Ÿงธ

  • class Allocator โ€” allocator class, no extra note in the original, so it stays lowkey mysterious. ๐Ÿ•ถ๏ธ
  • struct ProbAndConfPtr โ€” a struct named ProbAndConfPtr. No description here, bestie. โœจ
  • class DirtyAllocator โ€” the DirtyAllocator class. It's giving we don't talk about what's inside. ๐Ÿ™ˆ
  • class FixedEnvelope โ€” FixedEnvelope class, no description in the source. Keep it cute. ๐ŸŽ€
  • class Iso โ€” the Iso class for the calculation of the isotopic distribution. Main character energy, fr fr. ๐Ÿ‘‘
  • class IsoGenerator โ€” the generator of isotopologues. Slay. โœจ
  • class IsoOrderedGeneratorTemplate โ€” the generator of isotopologues sorted by their probability of occurrence. Probability order, periodt. ๐Ÿ”ฅ
  • class IsoThresholdGenerator โ€” the generator of isotopologues above a given threshold value. Only the ones that clear the bar, bestie. ๐Ÿ’…
  • class IsoLayeredGeneratorTemplate โ€” no description in the original. Layered generator template, living its truth. ๐Ÿง…
  • class IsoStochasticGeneratorTemplate โ€” no description. Stochastic generator template, random but make it fashion. ๐ŸŽฒ
  • class Marginal โ€” the marginal distribution class (a subisotopologue). It's giving subisotopologue realness. ๐ŸŒธ
  • class MarginalTrek โ€” the marginal distribution class (a subisotopologue). Same energy, different class. ๐Ÿ––
  • class PrecalculatedMarginal โ€” Precalculated Marginal class. Already did the math, no cap. ๐Ÿงฎ
  • class LayeredMarginal โ€” LayeredMarginal class. Layers on layers. ๐Ÿง…
  • class SingleAtomMarginal โ€” no description. Single atom marginal, doing its thing. โš›๏ธ
  • class LoggingMarginal โ€” no description in the original, so we just say the name. ๐Ÿ“
  • class KeyHasher โ€” no description. Key hasher class. ๐Ÿ”‘
  • class ConfEqual โ€” no description. Conf equal class. โœจ
  • class ConfOrder โ€” no description. Conf order class. ๐Ÿ“
  • class ConfOrderMarginal โ€” no description. Conf order marginal class. ๐Ÿ’ซ
  • class ConfOrderMarginalDescending โ€” no description. Conf order marginal descending class. โฌ‡๏ธ
  • class ReverseOrder โ€” no description. Reverse order class. ๐Ÿ”„
  • class TableOrder โ€” no description. Table order class. ๐Ÿ“Š
  • class OrderMarginalsBySizeDecresing โ€” no description. (Yes, Decresing is spelled exactly like that in the original. We do not fix it. ๐Ÿ™…โ€โ™€๏ธ)
  • class SSummator โ€” no description. S summator class. โž•
  • class Summator โ€” no description. Summator class. โž•
  • class TSummator โ€” no description. T summator class. โž•

๐Ÿท๏ธ Typedefs ๐Ÿท๏ธ

  • typedef double RealType โ€” RealType is a double. Yes bestie, that's the whole thing. ๐Ÿ’…
  • typedef int64_t IntType โ€” IntType is int64_t. Big integer energy. ๐Ÿ”ข
  • typedef int * Conf โ€” Conf is a pointer to int. Periodt. ๐ŸŽฏ
  • using IsoOrderedGenerator = IsoOrderedGeneratorTemplate<MarginalTrek> โ€” yes, exactly that alias. โœจ
  • using IsoLayeredGenerator = IsoLayeredGeneratorTemplate<LayeredMarginal> โ€” alias slay. ๐ŸŒˆ
  • using IsoStochasticGenerator = IsoStochasticGeneratorTemplate<IsoLayeredGenerator> โ€” alias, but make it stochastic. ๐ŸŽฒ

โš™๏ธ Functions โš™๏ธ

  • copyConf โ€” template<typename T> void copyConf (const T *source, T *destination, int dim) โ€” no description given, bestie. ๐Ÿ“‹
  • btrd โ€” IntType btrd (IntType _t, RealType p, IntType m, std::mt19937 &urng=random_gen) โ€” no description. ๐ŸŽฒ
  • invert โ€” IntType invert (IntType t, RealType p, std::mt19937 &urng=random_gen) โ€” no description. ๐Ÿ”„
  • boost_binomial_distribution_variate โ€” IntType boost_binomial_distribution_variate (IntType t_arg, RealType p_arg, std::mt19937 &urng=random_gen) โ€” no description. ๐Ÿ“ˆ
  • parse_fasta โ€” void parse_fasta (const char *fasta, int atomCounts[6]) โ€” Count elemental composition of an unmodificed sequence of amino acids, resulting in CHNOSSe counts. (Note: "unmodificed" is exactly as written in the original. We keep it. ๐Ÿ’…)
  • parse_fasta_full โ€” void parse_fasta_full (const char *fasta, int atomCounts[6]) โ€” Turn an input FASTA aminoacid sequence into atom counts, in CHNOSSe order. ๐Ÿงฌ
  • reorder_array โ€” template<typename T> void reorder_array (T *arr, size_t *order, size_t size, bool can_destroy=false) โ€” no description. ๐Ÿ”€
  • AbyssalWassersteinDistanceGrad โ€” double AbyssalWassersteinDistanceGrad (FixedEnvelope *const *envelopes, const double *scales, double *ret_gradient, size_t N, double abyss_depth_exp, double abyss_depth_the) โ€” no description. ๐ŸŒŠ
  • release_g_lfact_table โ€” void release_g_lfact_table () โ€” no description. ๐Ÿงน
  • alloc_lfact_table โ€” double * alloc_lfact_table () โ€” no description. ๐Ÿงฎ
  • RationalApproximation โ€” double RationalApproximation (double t) โ€” no description. ๐Ÿง 
  • NormalCDFInverse โ€” double NormalCDFInverse (double p) โ€” no description. ๐Ÿ“Š
  • NormalCDFInverse โ€” double NormalCDFInverse (double p, double mean, double stdev) โ€” no description. ๐Ÿ“Š
  • NormalCDF โ€” double NormalCDF (double x, double mean, double stdev) โ€” no description. ๐Ÿ“ˆ
  • NormalPDF โ€” double NormalPDF (double x, double mean, double stdev) โ€” no description. ๐Ÿ“‰
  • LowerIncompleteGamma2 โ€” double LowerIncompleteGamma2 (int a, double x) โ€” no description. ๐Ÿงฎ
  • InverseLowerIncompleteGamma2 โ€” double InverseLowerIncompleteGamma2 (int a, double x) โ€” no description. ๐Ÿ”ข
  • random_gen โ€” std::mt19937 random_gen (std::random_device{}()) โ€” no description. ๐ŸŽฒ
  • stdunif โ€” std::uniform_real_distribution< double > stdunif (0.0, 1.0) โ€” no description. ๐ŸŽฏ
  • rdvariate_binom โ€” size_t rdvariate_binom (size_t tries, double succ_prob, std::mt19937 &rgen) โ€” no description. ๐ŸŽฒ
  • InverseChiSquareCDF2 โ€” double InverseChiSquareCDF2 (int k, double x) โ€” no description. ๐Ÿ“Š
  • rdvariate_beta_1_b โ€” double rdvariate_beta_1_b (double b, std::mt19937 &rgen=random_gen) โ€” no description. ๐ŸŽฒ
  • parse_formula โ€” unsigned int parse_formula (const char *formula, std::vector< double > &isotope_masses, std::vector< double > &isotope_probabilities, int **isotopeNumbers, int **atomCounts, unsigned int *confSize, bool use_nominal_masses) โ€” no description. ๐Ÿงช
  • writeInitialConfiguration โ€” void writeInitialConfiguration (const int atomCnt, const int isotopeNo, const double *lprobs, int *res) โ€” Find one of the most probable subisotopologues. ๐Ÿ†
  • getMLogProbs โ€” double * getMLogProbs (const double *probs, int isoNo) โ€” no description. ๐Ÿ“
  • get_loggamma_nominator โ€” double get_loggamma_nominator (int x) โ€” no description. ๐Ÿงฎ
  • verify_atom_cnt โ€” int verify_atom_cnt (int atomCnt) โ€” no description. โœ…
  • quickselect โ€” void * quickselect (void **array, size_t n, size_t start, size_t end) โ€” no description. โšก
  • combinedSum โ€” double combinedSum (const int *conf, const std::vector< double > **valuesContainer, int dimNumber) โ€” no description. โž•
  • combinedSum โ€” double combinedSum (const int *conf, const pod_vector< double > **valuesContainer, int dimNumber) โ€” no description. โž•
  • getConf โ€” int * getConf (void *conf) โ€” no description. ๐ŸŽฏ
  • getLProb โ€” double getLProb (void *conf) โ€” no description. ๐ŸŽฒ
  • unnormalized_logProb โ€” double unnormalized_logProb (const int *conf, const double *logProbs, int dim) โ€” no description. ๐Ÿ“‰
  • calc_mass โ€” double calc_mass (const int *conf, const double *masses, int dim) โ€” no description. โš–๏ธ
  • printArray โ€” template<typename T> void printArray (const T *array, size_t size, const char *prefix='') โ€” no description. ๐Ÿ–จ๏ธ
  • printVector โ€” template<typename T> void printVector (const std::vector< T > &vec) โ€” no description. ๐Ÿ–จ๏ธ
  • printVector โ€” template<typename T> void printVector (const pod_vector< T > &vec) โ€” no description. ๐Ÿ–จ๏ธ
  • printOffsets โ€” template<typename T> void printOffsets (const T **array, size_t size, const T *offset, const char *prefix='') โ€” no description. ๐Ÿ–จ๏ธ
  • printNestedArray โ€” template<typename T> void printNestedArray (const T **array, const int *shape, size_t size) โ€” no description. ๐Ÿ–จ๏ธ
  • quickselect โ€” void * quickselect (const void **array, size_t n, size_t start, size_t end) โ€” Quickly select the n'th positional statistic, including the weights. โšก
  • dealloc_table โ€” template<typename T> void dealloc_table (T *tbl, int dim) โ€” no description. ๐Ÿงน
  • realloc_append โ€” template<typename T> void realloc_append (T **array, T what, size_t old_array_size) โ€” no description. ๐Ÿ“Ž
  • get_order โ€” template<typename T> size_t * get_order (T *order_array, size_t N) โ€” no description. ๐Ÿ“
  • get_inverse_order โ€” template<typename T> size_t * get_inverse_order (T *order_array, size_t N) โ€” no description. ๐Ÿ”„
  • impose_order โ€” template<typename TA, typename TB> void impose_order (size_t *O, size_t N, TA *A, TB *B) โ€” no description. ๐Ÿ‘‘

๐Ÿ“ฆ Variables ๐Ÿ“ฆ

  • const ::size_t isospec_number_of_isotopic_entries = ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES โ€” yep, that's the count. โœจ
  • const int elem_table_ID [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” element table ID array. ๐Ÿ†”
  • const int elem_table_atomicNo [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” atomic number table. โš›๏ธ
  • const double elem_table_mass [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” mass table. โš–๏ธ
  • const double elem_table_massNo [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” mass number table. ๐Ÿ”ข
  • const int elem_table_extraNeutrons [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” extra neutrons table. ๐Ÿงช
  • const char * elem_table_element [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” element names. ๐Ÿงฌ
  • const char * elem_table_symbol [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” element symbols. ๐Ÿ”ค
  • const bool elem_table_Radioactive [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” radioactive flags. โ˜ข๏ธ
  • const double elem_table_probability [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” probability table. ๐ŸŽฒ
  • const double elem_table_log_probability [ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES] โ€” log probability table. ๐Ÿ“‰
  • const int aa_isotope_numbers [6] = {2, 2, 2, 3, 4, 6} โ€” amino acid isotope numbers. ๐Ÿงฌ
  • const double aa_elem_masses [19] โ€” amino acid element masses. โš–๏ธ
  • const double aa_elem_nominal_masses [19] โ€” nominal masses. ๐Ÿ”ข
  • const double aa_elem_probabilities [19] โ€” probabilities. ๐ŸŽฒ
  • const int aa_symbol_to_elem_counts [256 *6] โ€” symbol to element counts. ๐Ÿ”ค
  • double * g_lfact_table = alloc_lfact_table() โ€” global log-factorial table pointer. ๐Ÿงฎ
  • const double sqrt_pi = 1.772453850905516027298167483341145182798 โ€” square root of pi, digits and all. ๐Ÿฅง
  • const double pi = 3.14159265358979323846264338328 โ€” pi. Yes bestie, pi. ๐Ÿฅง
  • const double logpi = 1.144729885849400174143427351353058711647294812915311571513623071472137769884826079783623270275489708 โ€” that's a lot of digits. We keep them all. ๐Ÿ”ข
  • std::mt19937 random_gen โ€” the random generator variable. ๐ŸŽฒ
  • std::uniform_real_distribution< double > stdunif โ€” the uniform real distribution variable. ๐ŸŽฏ

๐Ÿ’– Detailed Description ๐Ÿ’–

Okay so legal stuff, but make it cute. Copyright (C) 2015-2020 Mateusz ลฤ…cki and Michaล‚ Startek.

This file is part of IsoSpec.

IsoSpec is free software: you can redistribute it and/or modify it under the terms of the Simplified ("2-clause") BSD licence.

IsoSpec is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should have received a copy of the Simplified BSD Licence along with IsoSpec. If not, see https://opensource.org/licenses/BSD-2-Clause.

๐Ÿ“š Typedef Documentation ๐Ÿ“š

typedef int* IsoSpec::Conf

Definition at line 22 of file conf.h. That's where it lives, bestie. ๐Ÿ’…

typedef int64_t IsoSpec::IntType

Definition at line 28 of file btrd.h.

using IsoSpec::IsoLayeredGenerator = IsoLayeredGeneratorTemplate<LayeredMarginal>

Definition at line 583 of file isoSpec++.h.

using IsoSpec::IsoOrderedGenerator = IsoOrderedGeneratorTemplate<MarginalTrek>

Definition at line 307 of file isoSpec++.h.

using IsoSpec::IsoStochasticGenerator = IsoStochasticGeneratorTemplate<IsoLayeredGenerator>

Definition at line 691 of file isoSpec++.h.

typedef double IsoSpec::RealType

Definition at line 27 of file btrd.h. ๐Ÿ’…

โœจ FUNCTION DOCUMENTATION โœจ

IsoSpec::alloc_lfact_table ๐Ÿ’–

double * IsoSpec::alloc_lfact_table ()
Definition at line 32 of file isoMath.cpp.

Okay bestie, it returns a double *, no cap. Slay. ๐Ÿ’…

IsoSpec::boost_binomial_distribution_variate ๐ŸŽ€

IntType IsoSpec::boost_binomial_distribution_variate (IntType t_arg,
    RealType p_arg, std::mt19937 & urng = random_gen)
Definition at line 189 of file btrd.h.

IsoSpec::btrd ๐Ÿฆ‹

IntType IsoSpec::btrd (IntType _t, RealType p, IntType m, std::mt19937 &
    urng = random_gen)
Definition at line 77 of file btrd.h.

IsoSpec::calc_mass ๐ŸŒธ

double IsoSpec::calc_mass (const int * conf, const double * masses, int dim)

[inline] โ€” inline, periodt.

Definition at line 71 of file misc.h.

IsoSpec::combinedSum (the pod_vector one) ๐Ÿ’œ

double IsoSpec::combinedSum (const int * conf, const pod_vector< double > **
    valuesContainer, int dimNumber)

[inline] โ€” inline, we love that for us.

Definition at line 38 of file misc.h.

IsoSpec::combinedSum (the std::vector one) ๐Ÿ’œ

double IsoSpec::combinedSum (const int * conf, const std::vector< double >
    ** valuesContainer, int dimNumber)

[inline] โ€” inline again, iconic.

Definition at line 29 of file misc.h.

IsoSpec::copyConf ๐Ÿงš

template<typename T> void IsoSpec::copyConf (const T * source, T *
    destination, int dim)

[inline] โ€” inline, slay.

Definition at line 26 of file allocator.h.

IsoSpec::dealloc_table ๐Ÿ“

template<typename T> void IsoSpec::dealloc_table (T * tbl, int dim)
Definition at line 138 of file misc.h.

IsoSpec::get_inverse_order ๐ŸŒˆ

template<typename T> size_t * IsoSpec::get_inverse_order (T * order_array,
    size_t N)
Definition at line 167 of file misc.h.

IsoSpec::get_loggamma_nominator โญ

double IsoSpec::get_loggamma_nominator (int x)
Definition at line 149 of file marginalTrek++.cpp.

IsoSpec::get_order ๐ŸŒˆ

template<typename T> size_t * IsoSpec::get_order (T * order_array, size_t N)
Definition at line 156 of file misc.h.

IsoSpec::getConf ๐Ÿ‘‘

int * IsoSpec::getConf (void * conf)

[inline] โ€” inline, bestie.

Definition at line 47 of file misc.h.

IsoSpec::getLProb ๐Ÿ‘‘

double IsoSpec::getLProb (void * conf)

[inline] โ€” inline.

Definition at line 54 of file misc.h.

IsoSpec::getMLogProbs ๐Ÿ’€

double * IsoSpec::getMLogProbs (const double * probs, int isoNo)

Here we order the processor to round the numbers up rather than down. Rounding down could result in the algorithm falling in an infinite loop because of the numerical instability of summing. So yeah, round up or risk the loop of doom. ๐Ÿ’€

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

IsoSpec::impose_order ๐Ÿ”ฅ

template<typename TA, typename TB> void IsoSpec::impose_order (size_t * O,
    size_t N, TA * A, TB * B)
Definition at line 178 of file misc.h.

IsoSpec::InverseChiSquareCDF2 ๐ŸŒธ

double IsoSpec::InverseChiSquareCDF2 (int k, double x)

[inline] โ€” inline, iconic.

Definition at line 68 of file isoMath.h.

IsoSpec::InverseLowerIncompleteGamma2 ๐Ÿฆ‹

double IsoSpec::InverseLowerIncompleteGamma2 (int a, double x)
Definition at line 131 of file isoMath.cpp.

IsoSpec::invert ๐Ÿ’–

IntType IsoSpec::invert (IntType t, RealType p, std::mt19937 & urng =
    random_gen)
Definition at line 160 of file btrd.h.

IsoSpec::LowerIncompleteGamma2 ๐ŸŽ€

double IsoSpec::LowerIncompleteGamma2 (int a, double x)
Definition at line 104 of file isoMath.cpp.

IsoSpec::NormalCDF โœจ

double IsoSpec::NormalCDF (double x, double mean, double stdev)
Definition at line 70 of file isoMath.cpp.

IsoSpec::NormalCDFInverse (one-arg version) ๐ŸŒŸ

double IsoSpec::NormalCDFInverse (double p)
Definition at line 57 of file isoMath.cpp.

IsoSpec::NormalCDFInverse (three-arg version) ๐ŸŒŸ

double IsoSpec::NormalCDFInverse (double p, double mean, double stdev)
Definition at line 65 of file isoMath.cpp.

IsoSpec::NormalPDF ๐ŸŒธ

double IsoSpec::NormalPDF (double x, double mean, double stdev)
Definition at line 95 of file isoMath.cpp.

IsoSpec::parse_fasta ๐Ÿšจ

void IsoSpec::parse_fasta (const char * fasta, int atomCounts[6])

[inline] โ€” inline.

Count elemental composition of an unmodificed sequence of amino acids, resulting in CHNOSSe counts. WARNING!!! ๐Ÿšจ This function does not add the terminating H and OH groups, resulting in a residue backbone skeleton formula. If you don't know what that means, you should probably be using parse_fasta_full function. Periodt.

Definition at line 38 of file fasta.h.

IsoSpec::parse_fasta_full ๐Ÿ’…

void IsoSpec::parse_fasta_full (const char * fasta, int atomCounts[6])

[inline] โ€” inline.

Turn an input FASTA aminoacid sequence into atom counts, in CHNOSSe order. Unlike parse_fasta, this function includes the H and OH groups at the N- and C- termini of the skeleton, resulting in a formula of a full (inert) molecule. So you get the whole molecule, not just the skeleton. Iconic. ๐Ÿ’…

Definition at line 54 of file fasta.h.

IsoSpec::parse_formula ๐Ÿงช

unsigned int IsoSpec::parse_formula (const char * formula, std::vector<
    double > & isotope_masses, std::vector< double > &
    isotope_probabilities, int ** isotopeNumbers, int ** atomCounts,
    unsigned int * confSize, bool use_nominal_masses)
Definition at line 355 of file isoSpec++.cpp.

IsoSpec::printArray ๐Ÿ–จ๏ธ

template<typename T> void IsoSpec::printArray (const T * array, size_t size,
    const char * prefix = '')
Definition at line 85 of file misc.h.

IsoSpec::printNestedArray ๐Ÿ–จ๏ธ

template<typename T> void IsoSpec::printNestedArray (const T ** array, const
    int * shape, size_t size)
Definition at line 113 of file misc.h.

IsoSpec::printOffsets ๐Ÿ–จ๏ธ

template<typename T> void IsoSpec::printOffsets (const T ** array, size_t
    size, const T * offset, const char * prefix = '')
Definition at line 104 of file misc.h.

IsoSpec::printVector (the pod_vector one) ๐Ÿ–จ๏ธ

template<typename T> void IsoSpec::printVector (const pod_vector< T > & vec)
Definition at line 99 of file misc.h.

IsoSpec::printVector (the std::vector one) ๐Ÿ–จ๏ธ

template<typename T> void IsoSpec::printVector (const std::vector< T > &
    vec)
Definition at line 94 of file misc.h.

IsoSpec::quickselect โšก

void * IsoSpec::quickselect (void ** array, size_t n, size_t start, size_t
    end)
Definition at line 28 of file misc.cpp.

IsoSpec::RationalApproximation ๐Ÿงฎ

double IsoSpec::RationalApproximation (double t)
Definition at line 47 of file isoMath.cpp.

IsoSpec::rdvariate_beta_1_b ๐ŸŽฒ

double IsoSpec::rdvariate_beta_1_b (double b, std::mt19937 & rgen =
    random_gen)

[inline] โ€” inline, bestie.

Definition at line 76 of file isoMath.h.

IsoSpec::rdvariate_binom ๐ŸŽฒ

size_t IsoSpec::rdvariate_binom (size_t tries, double succ_prob,
    std::mt19937 & rgen)
Definition at line 152 of file isoMath.cpp.

IsoSpec::realloc_append ๐Ÿ“Ž

template<typename T> void IsoSpec::realloc_append (T ** array, T what,
    size_t old_array_size)
Definition at line 147 of file misc.h.

IsoSpec::release_g_lfact_table ๐Ÿงน

void IsoSpec::release_g_lfact_table ()
Definition at line 23 of file isoMath.cpp.

IsoSpec::reorder_array ๐Ÿ”„

template<typename T> void IsoSpec::reorder_array (T * arr, size_t * order,
    size_t size, bool can_destroy = false)
Definition at line 135 of file fixedEnvelopes.cpp.

IsoSpec::unnormalized_logProb ๐Ÿ“‰

double IsoSpec::unnormalized_logProb (const int * conf, const double *
    logProbs, int dim)

[inline] โ€” inline, periodt.

Definition at line 61 of file misc.h.

IsoSpec::verify_atom_cnt โœ…

int IsoSpec::verify_atom_cnt (int atomCnt)
Definition at line 156 of file marginalTrek++.cpp.

IsoSpec::writeInitialConfiguration ๐Ÿ‘‘

void IsoSpec::writeInitialConfiguration (const int atomCnt, const int isotopeNo, const double * lprobs, int * res)

Find one of the most probable subisotopologues. The algorithm uses the hill-climbing algorithm. It starts from a subisotopologue close to the mean of the underlying multinomial distribution. There might be more than one modes, in case of which this function will return only one of them, close to the mean.

Parameters

  • atomCnt

Here we perform hill climbing to the mode of the marginal distribution (the subisotopologue distribution). We start from the point close to the mean of the underlying multinomial distribution.

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

โœจ VARIABLE DOCUMENTATION โœจ

const double IsoSpec::aa_elem_masses ๐Ÿงฌ

Initial value:

= {
    elem_table_mass[9], elem_table_mass[10],
    elem_table_mass[0], elem_table_mass[1],
    elem_table_mass[11], elem_table_mass[12],
    elem_table_mass[13], elem_table_mass[14], elem_table_mass[15],
    elem_table_mass[29], elem_table_mass[30], elem_table_mass[31], elem_table_mass[32],
    elem_table_mass[85], elem_table_mass[86], elem_table_mass[87], elem_table_mass[88], elem_table_mass[89], elem_table_mass[90]
}
Definition at line 27 of file fasta.cpp.

const double IsoSpec::aa_elem_nominal_masses ๐Ÿงฌ

Initial value:

= {
    elem_table_massNo[9], elem_table_massNo[10],
    elem_table_massNo[0], elem_table_massNo[1],
    elem_table_massNo[11], elem_table_massNo[12],
    elem_table_massNo[13], elem_table_massNo[14], elem_table_massNo[15],
    elem_table_massNo[29], elem_table_massNo[30], elem_table_massNo[31], elem_table_massNo[32],
    elem_table_massNo[85], elem_table_massNo[86], elem_table_massNo[87], elem_table_massNo[88], elem_table_massNo[89], elem_table_massNo[90]
}
Definition at line 37 of file fasta.cpp.

const double IsoSpec::aa_elem_probabilities ๐Ÿงฌ

Initial value:

= {
    elem_table_probability[9], elem_table_probability[10],
    elem_table_probability[0], elem_table_probability[1],
    elem_table_probability[11], elem_table_probability[12],
    elem_table_probability[13], elem_table_probability[14], elem_table_probability[15],
    elem_table_probability[29], elem_table_probability[30], elem_table_probability[31], elem_table_probability[32],
    elem_table_probability[85], elem_table_probability[86], elem_table_probability[87], elem_table_probability[88], elem_table_probability[89], elem_table_probability[90]
}
Definition at line 47 of file fasta.cpp.

const int IsoSpec::aa_isotope_numbers ๐Ÿงฌ

const int IsoSpec::aa_isotope_numbers = {2, 2, 2, 3, 4, 6}
Definition at line 25 of file fasta.cpp.

const int IsoSpec::aa_symbol_to_elem_counts ๐Ÿงฌ

const int IsoSpec::aa_symbol_to_elem_counts
Definition at line 57 of file fasta.cpp.

ISOSPEC_C_API const int IsoSpec::elem_table_atomicNo โš›๏ธ

ISOSPEC_C_API const int IsoSpec::elem_table_atomicNo
Definition at line 325 of file element_tables.cpp.

ISOSPEC_C_API const char * IsoSpec::elem_table_element โš›๏ธ

ISOSPEC_C_API const char * IsoSpec::elem_table_element
Definition at line 1509 of file element_tables.cpp.

ISOSPEC_C_API const int IsoSpec::elem_table_extraNeutrons โš›๏ธ

ISOSPEC_C_API const int IsoSpec::elem_table_extraNeutrons
Definition at line 1213 of file element_tables.cpp.

ISOSPEC_C_API const int IsoSpec::elem_table_ID โš›๏ธ

ISOSPEC_C_API const int IsoSpec::elem_table_ID
Definition at line 28 of file element_tables.cpp.

ISOSPEC_C_API const double IsoSpec::elem_table_log_probability โš›๏ธ

ISOSPEC_C_API const double IsoSpec::elem_table_log_probability
Definition at line 2693 of file element_tables.cpp.

ISOSPEC_C_API const double IsoSpec::elem_table_mass โš›๏ธ

ISOSPEC_C_API const double IsoSpec::elem_table_mass
Definition at line 621 of file element_tables.cpp.

ISOSPEC_C_API const double IsoSpec::elem_table_massNo โš›๏ธ

ISOSPEC_C_API const double IsoSpec::elem_table_massNo
Definition at line 917 of file element_tables.cpp.

ISOSPEC_C_API const double IsoSpec::elem_table_probability โš›๏ธ

ISOSPEC_C_API const double IsoSpec::elem_table_probability
Definition at line 2397 of file element_tables.cpp.

ISOSPEC_C_API const bool IsoSpec::elem_table_Radioactive โ˜ข๏ธ

ISOSPEC_C_API const bool IsoSpec::elem_table_Radioactive
Definition at line 2101 of file element_tables.cpp.

ISOSPEC_C_API const char * IsoSpec::elem_table_symbol โš›๏ธ

ISOSPEC_C_API const char * IsoSpec::elem_table_symbol
Definition at line 1805 of file element_tables.cpp.

double * IsoSpec::g_lfact_table ๐Ÿ“Š

double * IsoSpec::g_lfact_table = alloc_lfact_table()
Definition at line 44 of file isoMath.cpp.

ISOSPEC_C_API const size_t IsoSpec::isospec_number_of_isotopic_entries ๐Ÿ”ข

ISOSPEC_C_API const size_t IsoSpec::isospec_number_of_isotopic_entries =
    ISOSPEC_NUMBER_OF_ISOTOPIC_ENTRIES
Definition at line 26 of file element_tables.cpp.

const double IsoSpec::logpi ๐Ÿฅง

const double IsoSpec::logpi =
    1.144729885849400174143427351353058711647294812915311571513623071472137769884826079783623270275489708
Definition at line 54 of file isoMath.h.

const double IsoSpec::pi ๐Ÿฅง

const double IsoSpec::pi = 3.14159265358979323846264338328
Definition at line 53 of file isoMath.h.

const double IsoSpec::sqrt_pi ๐Ÿฅง

const double IsoSpec::sqrt_pi = 1.772453850905516027298167483341145182798
Definition at line 102 of file isoMath.cpp.

๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

Generated automatically by Doxygen for IsoSpec from the source code.

Okay bestie, this whole thing was auto-generated by Doxygen for IsoSpec from the source code. Robot magic, no cap. ๐Ÿค–โœจ


Shoutout to the footer: source/version is IsoSpec / IsoSpec(3). The date didn't show up on this page, but that's the footer vibe. Stay iconic, bestie. ๐Ÿ’–๐Ÿฆ‹

๐Ÿ“ฆ where this page comes from