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

105 lines
3.9 KiB
Groff
Raw Permalink Normal View History

.TH "serif::utils::dependencies::Plan< Computations >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::dependencies::Plan< Computations >
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <plan\&.hpp>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBResults\fP = \fBDeclaration\fP<typename Computations::Key\&.\&.\&.>"
.br
.ti -1c
.RI "using \fBInputs\fP = \fBCombinedDeclaration\fP<typename Computations::Inputs\&.\&.\&.>"
.br
.ti -1c
.RI "using \fBGraph\fP = \fBdetail::Graph\fP<Computations\&.\&.\&.>"
.br
.ti -1c
.RI "template<std::size_t Index> using \fBComputationAt\fP = std::tuple_element_t<Index, std::tuple<Computations\&.\&.\&.>>"
.br
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBPlan\fP (Computations\&.\&.\&. computations)"
.br
.RI "Accept computations in any order; the graph determines their evaluation order\&. "
.ti -1c
.RI "template<std::size_t Index>
.br
requires (Index < \fBsize\fP)const auto & \fBcomputation\fP () const"
.br
.RI "Read a callable without permitting its stored configuration to change between preparations\&. "
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "template<typename KeyT>
.br
requires \fBdetail::contains_key_v\fP<KeyT, \fBResults\fP>static consteval std::size_t \fBindex\fP ()"
.br
.RI "Convert a known result key to its stable position in the plan\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::size_t \fBsize\fP = sizeof\&.\&.\&.(Computations)"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "std::tuple< Computations\&.\&.\&. > \fBm_computations\fP"
.br
.in -1c
.SH "Member Typedef Documentation"
.PP
.SS "template<IsComputation\&.\&.\&. Computations> template<std::size_t Index> using \fBserif::utils::dependencies::Plan\fP< Computations >::ComputationAt = std::tuple_element_t<Index, std::tuple<Computations\&.\&.\&.>>"
.SS "template<IsComputation\&.\&.\&. Computations> using \fBserif::utils::dependencies::Plan\fP< Computations >::Graph = \fBdetail::Graph\fP<Computations\&.\&.\&.>"
.SS "template<IsComputation\&.\&.\&. Computations> using \fBserif::utils::dependencies::Plan\fP< Computations >::Inputs = \fBCombinedDeclaration\fP<typename Computations::Inputs\&.\&.\&.>"
.SS "template<IsComputation\&.\&.\&. Computations> using \fBserif::utils::dependencies::Plan\fP< Computations >::Results = \fBDeclaration\fP<typename Computations::Key\&.\&.\&.>"
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<IsComputation\&.\&.\&. Computations> \fBserif::utils::dependencies::Plan\fP< Computations >::Plan (Computations\&.\&.\&. computations)\fR [inline]\fP, \fR [explicit]\fP"
.PP
Accept computations in any order; the graph determines their evaluation order\&.
.SH "Member Function Documentation"
.PP
.SS "template<IsComputation\&.\&.\&. Computations> template<std::size_t Index>
.br
requires (Index < \fBsize\fP)const auto & \fBserif::utils::dependencies::Plan\fP< Computations >::computation () const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Read a callable without permitting its stored configuration to change between preparations\&.
.SS "template<IsComputation\&.\&.\&. Computations> template<typename KeyT>
.br
requires \fBdetail::contains_key_v\fP<KeyT, \fBResults\fP>static consteval std::size_t \fBserif::utils::dependencies::Plan\fP< Computations >::index ()\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [consteval]\fP"
.PP
Convert a known result key to its stable position in the plan\&.
.SH "Member Data Documentation"
.PP
.SS "template<IsComputation\&.\&.\&. Computations> std::tuple<Computations\&.\&.\&.> \fBserif::utils::dependencies::Plan\fP< Computations >::m_computations\fR [private]\fP"
.SS "template<IsComputation\&.\&.\&. Computations> std::size_t \fBserif::utils::dependencies::Plan\fP< Computations >::size = sizeof\&.\&.\&.(Computations)\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.