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)
48 lines
1.4 KiB
Groff
48 lines
1.4 KiB
Groff
.TH "src/lib/serif/solver/normalization/riesz_factors.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/solver/normalization/riesz_factors.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/solver/normalization/point_rows\&.hpp'\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include 'serif/solver/normalization/diagonal\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::normalization\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::expected< double, std::string > \fBserif::solver::normalization::make_riesz_factor\fP (Kind kind, double metric, double physical_scale)"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::expected< std::vector< double >, std::string > \fBserif::solver::normalization::make_riesz_factors\fP (Kind kind, std::span< const double > metric, double physical_scale)"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::expected< std::vector< double >, std::string > \fBserif::solver::normalization::make_point_replaced_residual_factors\fP (std::span< const double > volume_metric, double volume_scale, std::span< const int > selected_rows, double point_scale)"
|
|
.br
|
|
.RI "Measure volume and replacement point residuals in their independently specified physical units\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|