.TH "IsoSpec::IsoStochasticGenerator" 3 "Thu Oct 15 2020" "Version 2.1.3" "IsoSpec" \" -*- nroff -*-
.ad l
.nh
.SH NAME
IsoSpec::IsoStochasticGenerator
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBIsoSpec::IsoGenerator\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBIsoStochasticGenerator\fP (\fBIso\fP &&iso, size_t no_molecules, double precision=0\&.9999, double beta_bias=5\&.0)"
.br
.ti -1c
.RI "ISOSPEC_FORCE_INLINE size_t \fBcount\fP () const"
.br
.ti -1c
.RI "ISOSPEC_FORCE_INLINE double \fBmass\fP () const override final"
.br
.RI "Get the mass of the current isotopologue\&. "
.ti -1c
.RI "ISOSPEC_FORCE_INLINE double \fBprob\fP () const override final"
.br
.RI "Get the probability of the current isotopologue\&. "
.ti -1c
.RI "ISOSPEC_FORCE_INLINE double \fBlprob\fP () const override final"
.br
.RI "Get the log-probability of the current isotopologue\&. "
.ti -1c
.RI "ISOSPEC_FORCE_INLINE void \fBget_conf_signature\fP (int *space) const override final"
.br
.RI "Write the signature of configuration into target memory location\&. It must be large enough to accomodate it\&. "
.ti -1c
.RI "ISOSPEC_FORCE_INLINE bool \fBadvanceToNextConfiguration\fP () override final"
.br
.RI "Advance to the next, not yet visited, most probable isotopologue\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
Definition at line 542 of file isoSpec++\&.h\&.
.SH "Member Function Documentation"
.PP 
.SS "ISOSPEC_FORCE_INLINE bool IsoSpec::IsoStochasticGenerator::advanceToNextConfiguration ()\fC [inline]\fP, \fC [final]\fP, \fC [override]\fP, \fC [virtual]\fP"

.PP
Advance to the next, not yet visited, most probable isotopologue\&. 
.PP
\fBReturns\fP
.RS 4
Return false if it is not possible to advance\&. 
.RE
.PP

.PP
Implements \fBIsoSpec::IsoGenerator\fP\&.
.PP
Definition at line 565 of file isoSpec++\&.h\&.
.SS "ISOSPEC_FORCE_INLINE double IsoSpec::IsoStochasticGenerator::lprob () const\fC [inline]\fP, \fC [final]\fP, \fC [override]\fP, \fC [virtual]\fP"

.PP
Get the log-probability of the current isotopologue\&. 
.PP
\fBReturns\fP
.RS 4
The log-probability of the current isotopologue\&. 
.RE
.PP

.PP
Reimplemented from \fBIsoSpec::IsoGenerator\fP\&.
.PP
Definition at line 561 of file isoSpec++\&.h\&.
.SS "ISOSPEC_FORCE_INLINE double IsoSpec::IsoStochasticGenerator::mass () const\fC [inline]\fP, \fC [final]\fP, \fC [override]\fP, \fC [virtual]\fP"

.PP
Get the mass of the current isotopologue\&. 
.PP
\fBReturns\fP
.RS 4
The mass of the current isotopologue\&. 
.RE
.PP

.PP
Reimplemented from \fBIsoSpec::IsoGenerator\fP\&.
.PP
Definition at line 557 of file isoSpec++\&.h\&.
.SS "ISOSPEC_FORCE_INLINE double IsoSpec::IsoStochasticGenerator::prob () const\fC [inline]\fP, \fC [final]\fP, \fC [override]\fP, \fC [virtual]\fP"

.PP
Get the probability of the current isotopologue\&. 
.PP
\fBReturns\fP
.RS 4
The probability of the current isotopologue\&. 
.RE
.PP

.PP
Reimplemented from \fBIsoSpec::IsoGenerator\fP\&.
.PP
Definition at line 559 of file isoSpec++\&.h\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for IsoSpec from the source code\&.