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)
42 lines
1.2 KiB
Groff
42 lines
1.2 KiB
Groff
.TH "serif::discretization::forms::IsOperand" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::forms::IsOperand \- Concept to validate a valid operand\&. An operand is valid if the following conditions are satisfied\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <operands\&.hpp>\fP
|
|
.SH "Concept definition"
|
|
.PP
|
|
|
|
.nf
|
|
template<typename OperandCandidate>
|
|
concept serif::discretization::forms::IsOperand = requires {
|
|
typename std::remove_cvref_t<OperandCandidate>::term_type;
|
|
typename std::remove_cvref_t<OperandCandidate>::operation_type; } &&
|
|
blocks::Term<typename std::remove_cvref_t<OperandCandidate>::term_type> &&
|
|
IsOperation<typename std::remove_cvref_t<OperandCandidate>::operation_type>
|
|
.PP
|
|
.fi
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Concept to validate a valid operand\&. An operand is valid if the following conditions are satisfied\&.
|
|
|
|
|
|
.IP "\(bu" 2
|
|
it has a member term_type
|
|
.IP "\(bu" 2
|
|
it has a member operation_type
|
|
.IP "\(bu" 2
|
|
term_type satisfies the \fBTerm\fP concept (e\&.g\&. is a valid term)
|
|
.IP "\(bu" 2
|
|
operation_type satisfies the \fBIsOperation\fP concept (e\&.\&.g is a valid operation)
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|