Files
MeanField_SERiF/docs/man/man3/relation_list.hpp.3
Emily Boudreaux 6b57738330 docs(docs): built docs
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)
2026-11-09 14:09:44 -05:00

66 lines
1.6 KiB
Groff

.TH "src/include/serif/discretization/domain/relation/lists/relation_list.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/discretization/domain/relation/lists/relation_list.hpp \- Compile-time list of relations, used to group relations together for operations and forms\&.
.SH SYNOPSIS
.br
.PP
\fR#include <cstddef>\fP
.br
\fR#include 'serif/discretization/domain/relation/concepts\&.hpp'\fP
.br
\fR#include 'serif/utils/misc/std_helper/variadic_cleaning\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::discretization::domain::relation::lists::RelationList< RelationTs >\fP"
.br
.RI "Compile-time list of relations, used to group relations together for operations and forms\&. This struct is a variadic template that takes a list of relation types as template parameters\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::discretization\fP"
.br
.ti -1c
.RI "namespace \fBserif::discretization::domain\fP"
.br
.ti -1c
.RI "namespace \fBserif::discretization::domain::relation\fP"
.br
.ti -1c
.RI "namespace \fBserif::discretization::domain::relation::lists\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename\&.\&.\&. Ts> consteval std::size_t \fBserif::discretization::domain::relation::lists::CountVariadicArguments\fP () noexcept"
.br
.in -1c
.SH "Detailed Description"
.PP
Compile-time list of relations, used to group relations together for operations and forms\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.