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)
69 lines
2.0 KiB
Groff
69 lines
2.0 KiB
Groff
.TH "serif::discretization::blocks::TermDescriptor" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::TermDescriptor \- Runtime descriptor for a term, containing its associated field and name\&. Two TermDescriptors are equal if they have identical fields and names\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <runtime\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBFieldDescriptor\fP \fBfield\fP"
|
|
.br
|
|
.RI "Each term belongs to a field, and this descriptor identifies that field\&. "
|
|
.ti -1c
|
|
.RI "std::string_view \fBname\fP"
|
|
.br
|
|
.RI "The name of the term, used for runtime identification\&. "
|
|
.in -1c
|
|
.SS "Friends"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "constexpr bool \fBoperator==\fP (const \fBTermDescriptor\fP &, const \fBTermDescriptor\fP &) noexcept=default"
|
|
.br
|
|
.RI "Compare two TermDescriptors for equality based on their fields and names\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Runtime descriptor for a term, containing its associated field and name\&. Two TermDescriptors are equal if they have identical fields and names\&.
|
|
.SH "Friends And Related Symbol Documentation"
|
|
.PP
|
|
.SS "bool operator== (const \fBTermDescriptor\fP & , const \fBTermDescriptor\fP & )\fR [friend]\fP"
|
|
|
|
.PP
|
|
Compare two TermDescriptors for equality based on their fields and names\&.
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIlhs\fP The left-hand side \fBTermDescriptor\fP\&.
|
|
.br
|
|
\fIrhs\fP The right-hand side \fBTermDescriptor\fP\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
True if both the fields and names of the TermDescriptors are equal, false otherwise\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBFieldDescriptor\fP serif::discretization::blocks::TermDescriptor::field"
|
|
|
|
.PP
|
|
Each term belongs to a field, and this descriptor identifies that field\&.
|
|
.SS "std::string_view serif::discretization::blocks::TermDescriptor::name"
|
|
|
|
.PP
|
|
The name of the term, used for runtime identification\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|