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

62 lines
1.3 KiB
Groff
Raw Normal View History

.TH "src/include/serif/utils/projection/radial.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/projection/radial.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <concepts>\fP
.br
\fR#include <expected>\fP
.br
\fR#include <functional>\fP
.br
\fR#include <string>\fP
.br
\fR#include <type_traits>\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::projection\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::projection::detail\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBserif::utils::projection::RadialFunction\fP"
.br
.RI "A radial profile accepts physical radius and returns a value or a numerical rejection\&. "
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "using \fBserif::utils::projection::RadialValue\fP = std::expected<double, std::string>"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<RadialFunction Function> std::function< \fBRadialValue\fP(double)> \fBserif::utils::projection::detail::checked_profile\fP (const Function &function)"
.br
.RI "Borrow a profile for one synchronous projection without requiring it to be copyable\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.