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

58 lines
2.0 KiB
Groff

.TH "serif::utils::serialize::RecipeSerializer< T >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::serialize::RecipeSerializer< T > \- Preserve the selected equation/unknown identities in every composed inverse\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <numerics\&.hpp>\fP
.PP
Inherits \fBserif::utils::serialize::StructSerializer< T >\fP\&.
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static \fBNode\fP \fBsave\fP (const T &value)"
.br
.RI "A recipe names physical coordinates independently of its nested numerical controls\&. "
.ti -1c
.RI "static \fBResult\fP< T > \fBload\fP (const \fBNode\fP &node)"
.br
.RI "Reject recipes selecting different physical blocks even when their controls agree\&. "
.in -1c
Static Public Member Functions inherited from \fBserif::utils::serialize::StructSerializer< T >\fP
.in +1c
.ti -1c
.RI "static \fBNode\fP \fBsave\fP (const T &value)"
.br
.RI "Delegate each named field to its own serializer\&. "
.ti -1c
.RI "static \fBResult\fP< T > \fBload\fP (const \fBNode\fP &node)"
.br
.RI "Reconstruct only after every named field has decoded successfully\&. "
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename T>
.br
struct serif::utils::serialize::RecipeSerializer< T >"Preserve the selected equation/unknown identities in every composed inverse\&.
.SH "Member Function Documentation"
.PP
.SS "template<typename T> static \fBResult\fP< T > \fBserif::utils::serialize::RecipeSerializer\fP< T >::load (const \fBNode\fP & node)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP"
.PP
Reject recipes selecting different physical blocks even when their controls agree\&.
.SS "template<typename T> static \fBNode\fP \fBserif::utils::serialize::RecipeSerializer\fP< T >::save (const T & value)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP"
.PP
A recipe names physical coordinates independently of its nested numerical controls\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.