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)
38 lines
1.7 KiB
Groff
38 lines
1.7 KiB
Groff
.TH "serif::operators::OperandValues< OperandsT, OutputT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::operators::OperandValues< OperandsT, OutputT > \- A helper struct to store the values of operands\&. There is some convention here, specifically if OutputT is void then this struct represents the values of the operands, otherwise it represents the local derivatives of the operands with respect to OutputT\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <point\&.hpp>\fP
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename OperandsT, typename OutputT = void>
|
|
.br
|
|
struct serif::operators::OperandValues< OperandsT, OutputT >"A helper struct to store the values of operands\&. There is some convention here, specifically if OutputT is void then this struct represents the values of the operands, otherwise it represents the local derivatives of the operands with respect to OutputT\&.
|
|
|
|
A specialization of the \fBOperandValues\fP struct for a non-empty list of operands\&. This struct stores the values of the operands or their local derivatives with respect to OutputT\&.
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOperandsT\fP The list of operands to store values for, which must be a TypeList of valid operands\&.
|
|
.br
|
|
\fIOutputT\fP The type of the output with respect to which local derivatives are computed\&. If void, this struct stores operand values\&.
|
|
.br
|
|
\fIOutputT\fP The type of the output with respect to which local derivatives are computed\&. If void, this struct stores operand values\&.
|
|
.br
|
|
\fIOperands\fP The list of operands to store values for, which must be a non-empty pack of valid operands\&.
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|