Files
MeanField_SERiF/docs/man/man3/serif_discretization_blocks_value_block.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

53 lines
1.5 KiB
Groff

.TH "serif::discretization::blocks::value_block< index_value >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::blocks::value_block< index_value > \- Final class for value blocks with a fixed index, derived from \fBvalue_block_base\fP\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <base\&.hpp>\fP
.PP
Inherits \fBserif::discretization::blocks::value_block_base\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "constexpr \fBoperator int\fP () const noexcept"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr int \fBindex\fP = index_value"
.br
.in -1c
Static Public Attributes inherited from \fBserif::discretization::blocks::value_block_base\fP
.in +1c
.ti -1c
.RI "static constexpr int \fBstatic_block_size\fP = \fBDYNAMIC_BLOCK_SIZE\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<int index_value>
.br
struct serif::discretization::blocks::value_block< index_value >"Final class for value blocks with a fixed index, derived from \fBvalue_block_base\fP\&.
.SH "Member Function Documentation"
.PP
.SS "template<int index_value> \fBserif::discretization::blocks::value_block\fP< index_value >::operator int () const\fR [inline]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
.SH "Member Data Documentation"
.PP
.SS "template<int index_value> int \fBserif::discretization::blocks::value_block\fP< index_value >::index = index_value\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.