Files
MeanField_SERiF/docs/man/man3/serif_solver_MetricEvaluation.3

49 lines
1.2 KiB
Groff
Raw Normal View History

.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\&.