40 lines
1023 B
Groff
40 lines
1023 B
Groff
|
|
.TH "serif::equations::Equation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::equations::Equation \- A concept that defines the requirements for a valid SERiF equation\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <concepts\&.hpp>\fP
|
||
|
|
.SH "Concept definition"
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.nf
|
||
|
|
template<typename T>
|
||
|
|
concept serif::equations::Equation = requires {
|
||
|
|
typename T::Test;
|
||
|
|
{ T::name } \-> std::convertible_to<std::string_view>;
|
||
|
|
} && ValidContributions<typename T::Test, ContributionsOf<T>>::value
|
||
|
|
.PP
|
||
|
|
.fi
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
A concept that defines the requirements for a valid SERiF equation\&.
|
||
|
|
|
||
|
|
Requirements
|
||
|
|
.PD 0
|
||
|
|
.IP "\(bu" 2
|
||
|
|
The equation must have a test type (::Test) and a name (::name)\&.
|
||
|
|
.IP "\(bu" 2
|
||
|
|
The name must be convertible to a std::string_view\&.
|
||
|
|
.IP "\(bu" 2
|
||
|
|
The contributions of the equation must be valid for the test type, as defined by the ValidContributions struct\&.
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|