53 lines
1.4 KiB
Groff
53 lines
1.4 KiB
Groff
|
.TH "src/include/serif/solver/normalization/detail/validation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/solver/normalization/detail/validation.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <cstddef>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <expected>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <span>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <string>\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\&.
|