Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
51 lines
1.8 KiB
Groff
51 lines
1.8 KiB
Groff
.TH "serif::operators::detail::ContributionChildren< EquationT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::operators::detail::ContributionChildren< EquationT >
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <contributions\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBContributionChildren\fP (std::shared_ptr< const EquationT > equation)"
|
|
.br
|
|
.RI "Evaluate contributions once, retaining either its returned value or its returned reference\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const EquationT > \fBparent\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "decltype(std::declval< const EquationT & >()\&.contributions()) \fBvalues\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename EquationT>
|
|
.br
|
|
struct serif::operators::detail::ContributionChildren< EquationT >"A returned tuple may own generated equations or borrow an equation's existing children\&. Retaining its parent keeps reference tuples valid without copying move-only equations\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<typename EquationT> \fBserif::operators::detail::ContributionChildren\fP< EquationT >::ContributionChildren (std::shared_ptr< const EquationT > equation)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Evaluate contributions once, retaining either its returned value or its returned reference\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename EquationT> std::shared_ptr<const EquationT> \fBserif::operators::detail::ContributionChildren\fP< EquationT >::parent"
|
|
|
|
.SS "template<typename EquationT> decltype(std::declval<const EquationT&>()\&.contributions()) \fBserif::operators::detail::ContributionChildren\fP< EquationT >::values"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|