Files
MeanField_SERiF/docs/man/man3/finite.hpp.3

54 lines
1.5 KiB
Groff
Raw Normal View History

.TH "src/include/serif/utils/misc/finite.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/misc/finite.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <cmath>\fP
.br
\fR#include <stdexcept>\fP
.br
\fR#include <format>\fP
.br
\fR#include 'serif/utils/misc/concepts/numeric\&.hpp'\fP
.br
\fR#include 'serif/utils/misc/concepts/exceptions\&.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::utils\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::misc\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename ExceptionType, \fBerrors::SERiFErrorCode\fP ErrorCode, concepts::IsNumeric Scalar> void \fBserif::utils::misc::validate_finite\fP (const Scalar value)"
.br
.ti -1c
.RI "template<typename ExceptionType, \fBerrors::SERiFErrorCode\fP ErrorCode, concepts::IsComparableToNumeric Scalar> void \fBserif::utils::misc::validate_greater_than\fP (const Scalar value, const Scalar predicate)"
.br
.ti -1c
.RI "template<typename ExceptionType, \fBerrors::SERiFErrorCode\fP ErrorCode, concepts::IsComparableToNumeric Scalar> void \fBserif::utils::misc::validate_less_than\fP (const Scalar value, const Scalar predicate)"
.br
.ti -1c
.RI "template<typename ExceptionType, \fBerrors::SERiFErrorCode\fP ErrorCode, concepts::IsComparableToNumeric Scalar> void \fBserif::utils::misc::validate_nonnegativity\fP (const Scalar value)"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.