Files
MeanField_SERiF/docs/man/man3/serif_utils_CompensatedSum.3

51 lines
1.2 KiB
Groff
Raw Normal View History

.TH "serif::utils::CompensatedSum" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::CompensatedSum \- Neumaier summation retains small terms when a scalar reduction contains cancellation\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <compensated_sum\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBadd\fP (const double \fBvalue\fP)"
.br
.ti -1c
.RI "double \fBvalue\fP () const"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "double \fBm_sum\fP {0\&.0}"
.br
.ti -1c
.RI "double \fBm_correction\fP {0\&.0}"
.br
.in -1c
.SH "Detailed Description"
.PP
Neumaier summation retains small terms when a scalar reduction contains cancellation\&.
.SH "Member Function Documentation"
.PP
.SS "void serif::utils::CompensatedSum::add (const double value)\fR [inline]\fP"
.SS "double serif::utils::CompensatedSum::value () const\fR [inline]\fP, \fR [nodiscard]\fP"
.SH "Member Data Documentation"
.PP
.SS "double serif::utils::CompensatedSum::m_correction {0\&.0}\fR [private]\fP"
.SS "double serif::utils::CompensatedSum::m_sum {0\&.0}\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.