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

49 lines
1.2 KiB
Groff

.TH "serif::solver::MetricEvaluation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::MetricEvaluation \- Separate the convergence norm from the line-search merit for custom metrics\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <options\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "bool \fBvalid\fP () const noexcept"
.br
.RI "A metric must give finite, nonnegative values to drive solver decisions\&. "
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "double \fBresidual_norm\fP {0\&.0}"
.br
.ti -1c
.RI "double \fBmerit\fP {0\&.0}"
.br
.in -1c
.SH "Detailed Description"
.PP
Separate the convergence norm from the line-search merit for custom metrics\&.
.SH "Member Function Documentation"
.PP
.SS "bool serif::solver::MetricEvaluation::valid () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
A metric must give finite, nonnegative values to drive solver decisions\&.
.SH "Member Data Documentation"
.PP
.SS "double serif::solver::MetricEvaluation::merit {0\&.0}"
.SS "double serif::solver::MetricEvaluation::residual_norm {0\&.0}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.