Files
MeanField_SERiF/docs/man/man3/contributions.hpp.3

68 lines
1.9 KiB
Groff
Raw Normal View History

.TH "src/include/serif/operators/contributions.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/operators/contributions.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <cstddef>\fP
.br
\fR#include <memory>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include <utility>\fP
.br
\fR#include <tuple>\fP
.br
\fR#include 'serif/equations/concepts\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::operators::ContributionBinding< EquationT >\fP"
.br
.RI "Retain one leaf equation and the constant coefficient of its arithmetic expression\&. "
.ti -1c
.RI "struct \fBserif::operators::detail::ContributionChildren< EquationT >\fP"
.br
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators::detail\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename EquationT> auto \fBserif::operators::detail::bind_contributions\fP (std::shared_ptr< const EquationT > equation, double coefficient)"
.br
.RI "Flatten equation arithmetic while preserving every generated tuple and borrowed parent\&. "
.ti -1c
.RI "template<typename EquationT, typename FunctionT> void \fBserif::operators::detail::visit_contributions\fP (const EquationT &equation, FunctionT &function, std::size_t &index, double coefficient)"
.br
.RI "Visit arithmetic leaves without retaining them beyond the supplied callback\&. "
.ti -1c
.RI "template<equations::Equation EquationT> auto \fBserif::operators::bind_contributions\fP (std::shared_ptr< const EquationT > equation)"
.br
.RI "Give each retained leaf a compile-time tuple position for independently cached contribution results\&. "
.ti -1c
.RI "template<equations::Equation EquationT, typename FunctionT> void \fBserif::operators::for_each_contribution\fP (const EquationT &equation, FunctionT &&function)"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.