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)
53 lines
1.5 KiB
Groff
53 lines
1.5 KiB
Groff
.TH "src/lib/serif/solver/normalization/validation.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/solver/normalization/validation.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/solver/normalization/detail/validation\&.hpp'\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <vector>\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
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::normalization::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::expected< void, std::string > \fBserif::solver::normalization::detail::validate_factors\fP (std::span< const double > factors)"
|
|
.br
|
|
.RI "Require finite positive factors before accepting custom or packed normalization\&. "
|
|
.ti -1c
|
|
.RI "std::expected< std::size_t, std::string > \fBserif::solver::normalization::detail::validate_coordinate_size\fP (std::size_t size, bool global_scalar)"
|
|
.br
|
|
.RI "Check representable coordinate storage and the fixed arity of global scalar terms\&. "
|
|
.ti -1c
|
|
.RI "std::expected< void, std::string > \fBserif::solver::normalization::detail::check_coordinate_size\fP (std::size_t expected, std::size_t received)"
|
|
.br
|
|
.RI "Compare metric or factor size with the independently declared coordinate layout\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|