Files
MeanField_SERiF/docs/man/man3/serif_utils_dependencies_Computation.3

84 lines
3.3 KiB
Groff
Raw Normal View History

.TH "serif::utils::dependencies::Computation< KeyT, InputsT, FunctionT, OwnsInputs >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::dependencies::Computation< KeyT, InputsT, FunctionT, OwnsInputs >
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <computation\&.hpp>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBKey\fP = KeyT"
.br
.ti -1c
.RI "using \fBInputs\fP = std::remove_cvref_t<InputsT>"
.br
.ti -1c
.RI "using \fBFunction\fP = FunctionT"
.br
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBComputation\fP (FunctionT function)"
.br
.RI "Own the callable; result-affecting mutable state belongs in the declared inputs\&. "
.ti -1c
.RI "template<typename\&.\&.\&. Arguments>
.br
requires std::invocable<const FunctionT&, const Arguments&\&.\&.\&.>decltype(auto) \fBevaluate\fP (const Arguments &\&.\&.\&. arguments) const"
.br
.RI "Supply inputs in declaration order and infer the result from the callable\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr bool \fBowns_inputs\fP = OwnsInputs"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "FunctionT \fBm_function\fP"
.br
.in -1c
.SH "Member Typedef Documentation"
.PP
.SS "template<typename KeyT, IsKeyList InputsT, typename FunctionT, bool OwnsInputs = false> using \fBserif::utils::dependencies::Computation\fP< KeyT, InputsT, FunctionT, OwnsInputs >::Function = FunctionT"
.SS "template<typename KeyT, IsKeyList InputsT, typename FunctionT, bool OwnsInputs = false> using \fBserif::utils::dependencies::Computation\fP< KeyT, InputsT, FunctionT, OwnsInputs >::Inputs = std::remove_cvref_t<InputsT>"
.SS "template<typename KeyT, IsKeyList InputsT, typename FunctionT, bool OwnsInputs = false> using \fBserif::utils::dependencies::Computation\fP< KeyT, InputsT, FunctionT, OwnsInputs >::Key = KeyT"
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<typename KeyT, IsKeyList InputsT, typename FunctionT, bool OwnsInputs = false> \fBserif::utils::dependencies::Computation\fP< KeyT, InputsT, FunctionT, OwnsInputs >::Computation (FunctionT function)\fR [inline]\fP, \fR [explicit]\fP"
.PP
Own the callable; result-affecting mutable state belongs in the declared inputs\&.
.SH "Member Function Documentation"
.PP
.SS "template<typename KeyT, IsKeyList InputsT, typename FunctionT, bool OwnsInputs = false> template<typename\&.\&.\&. Arguments>
.br
requires std::invocable<const FunctionT&, const Arguments&\&.\&.\&.>decltype(auto) \fBserif::utils::dependencies::Computation\fP< KeyT, InputsT, FunctionT, OwnsInputs >::evaluate (const Arguments &\&.\&.\&. arguments) const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Supply inputs in declaration order and infer the result from the callable\&.
.SH "Member Data Documentation"
.PP
.SS "template<typename KeyT, IsKeyList InputsT, typename FunctionT, bool OwnsInputs = false> FunctionT \fBserif::utils::dependencies::Computation\fP< KeyT, InputsT, FunctionT, OwnsInputs >::m_function\fR [private]\fP"
.SS "template<typename KeyT, IsKeyList InputsT, typename FunctionT, bool OwnsInputs = false> bool \fBserif::utils::dependencies::Computation\fP< KeyT, InputsT, FunctionT, OwnsInputs >::owns_inputs = OwnsInputs\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.