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

67 lines
2.7 KiB
Groff
Raw Normal View History

.TH "serif::utils::dependencies::Observers< Registrations >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::dependencies::Observers< Registrations > \- Own registrations; execution state lasts for one invocation and is never part of the numerical cache\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <observers\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBObservers\fP (Registrations\&.\&.\&. observers)"
.br
.RI "Copy or move callbacks into this bundle without running them\&. "
.ti -1c
.RI "template<typename KeyT, std::size_t Position = 0, typename FunctionT> auto \fBevaluate\fP (FunctionT &&function)"
.br
.RI "Nest matching node hooks so before runs in registration order and after in reverse order\&. "
.ti -1c
.RI "template<typename InputT, typename ConsumerT, typename ValueT> void \fBedge\fP (const ValueT &value)"
.br
.RI "The cache visits inputs in declaration order; each edge's callbacks follow registration order\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "std::tuple< Registrations\&.\&.\&. > \fBm_observers\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename\&.\&.\&. Registrations>
.br
requires (\fBdetail::is_observer_v\fP<Registrations> && \&.\&.\&.)
.br
class serif::utils::dependencies::Observers< Registrations >"Own registrations; execution state lasts for one invocation and is never part of the numerical cache\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<typename\&.\&.\&. Registrations> \fBserif::utils::dependencies::Observers\fP< Registrations >::Observers (Registrations\&.\&.\&. observers)\fR [inline]\fP, \fR [explicit]\fP"
.PP
Copy or move callbacks into this bundle without running them\&.
.SH "Member Function Documentation"
.PP
.SS "template<typename\&.\&.\&. Registrations> template<typename InputT, typename ConsumerT, typename ValueT> void \fBserif::utils::dependencies::Observers\fP< Registrations >::edge (const ValueT & value)\fR [inline]\fP"
.PP
The cache visits inputs in declaration order; each edge's callbacks follow registration order\&.
.SS "template<typename\&.\&.\&. Registrations> template<typename KeyT, std::size_t Position = 0, typename FunctionT> auto \fBserif::utils::dependencies::Observers\fP< Registrations >::evaluate (FunctionT && function)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Nest matching node hooks so before runs in registration order and after in reverse order\&.
.SH "Member Data Documentation"
.PP
.SS "template<typename\&.\&.\&. Registrations> std::tuple<Registrations\&.\&.\&.> \fBserif::utils::dependencies::Observers\fP< Registrations >::m_observers\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.