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)
45 lines
1.2 KiB
Groff
45 lines
1.2 KiB
Groff
.TH "serif::equations::ContributionTuple< TupleT, typename >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::ContributionTuple< TupleT, typename > \- Type representing the contributions of an equation\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <contributions\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBtype\fP = void"
|
|
.br
|
|
.RI "The default type is void, indicating that the contributions are not valid\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename TupleT, typename = void>
|
|
.br
|
|
struct serif::equations::ContributionTuple< TupleT, typename >"Type representing the contributions of an equation\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fITupleT\fP Some tuple (e\&.g\&. from \fBContributions::type\fP)\&. In this default specialization we always let the type be void
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename TupleT, typename = void> using \fBserif::equations::ContributionTuple\fP< TupleT, typename >::type = void"
|
|
|
|
.PP
|
|
The default type is void, indicating that the contributions are not valid\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|