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.5 KiB
Groff
51 lines
1.5 KiB
Groff
.TH "serif::equations::ValidContributions< RowT, TupleT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::equations::ValidContributions< RowT, TupleT > \- A compile-time check to ensure that a tuple of contributions is valid for a given residual row type\&. This is the default false specialization\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <concepts\&.hpp>\fP
|
|
.PP
|
|
Inherits std::false_type\&.
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename RowT, typename TupleT>
|
|
.br
|
|
struct serif::equations::ValidContributions< RowT, TupleT >"A compile-time check to ensure that a tuple of contributions is valid for a given residual row type\&. This is the default false specialization\&.
|
|
|
|
A compile-time check to ensure that a tuple of contributions is valid for a given residual row type\&. This is the specialization for a non-empty tuple of contributions\&.
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIRowT\fP The type of the residual row that the contributions must share\&.
|
|
.br
|
|
\fITupleT\fP A tuple of contributions to validate\&.
|
|
.br
|
|
\fIRowT\fP The type of the residual row that the contributions must share\&.
|
|
.br
|
|
\fIC\fP The first contribution type in the tuple\&.
|
|
.br
|
|
\fIRestCs\fP The remaining contribution types in the tuple\&.
|
|
.RE
|
|
.PP
|
|
Compile Time True Type If
|
|
.PD 0
|
|
.IP "\(bu" 2
|
|
The size of C (contributions) is not zero
|
|
.IP "\(bu" 2
|
|
Each contribution satisfies the \fBPointEquation\fP concept
|
|
.IP "\(bu" 2
|
|
Each contribution's test type is the same as RowT
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|