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

80 lines
2.5 KiB
Groff
Raw Permalink Normal View History

.TH "src/include/serif/utils/dependencies/computation_cache.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/computation_cache.hpp
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/utils/error/errors\&.hpp'\fP
.br
\fR#include <array>\fP
.br
\fR#include <concepts>\fP
.br
\fR#include <cstddef>\fP
.br
\fR#include <cstdint>\fP
.br
\fR#include <expected>\fP
.br
\fR#include <memory>\fP
.br
\fR#include <stdexcept>\fP
.br
\fR#include <string>\fP
.br
\fR#include <tuple>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include <utility>\fP
.br
\fR#include 'serif/utils/dependencies/preparation\&.hpp'\fP
.br
\fR#include 'serif/utils/dependencies/observers\&.hpp'\fP
.br
\fR#include 'serif/utils/dependencies/detail/cache_storage\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::utils::dependencies::ComputationCache< GraphT, ContextT, ErrorT, ObserversT >\fP"
.br
.RI "Execute a computational graph on demand, publishing immutable results only after the entire request succeeds\&. "
.in -1c
.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::dependencies\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename ErrorT = std::string, IsComputationGraph GraphT, IsDependencyContext ContextT, typename ObserversT = Observers<>>
.br
requires CanPrepare<GraphT, ContextT, ErrorT> && ObserversFor<ObserversT, GraphT, ContextT> && std::constructible_from<std::remove_cvref_t<GraphT>, GraphT> && std::constructible_from<std::remove_cvref_t<ObserversT>, ObserversT>auto \fBserif::utils::dependencies::make_computation_cache\fP (GraphT &&graph, const ContextT &, ObserversT &&observers=ObserversT{})"
.br
.RI "Fix the graph's source types without retaining the supplied context or evaluating any computations\&. "
.ti -1c
.RI "template<typename ErrorT = std::string, IsDependencyContext ContextT, typename\&.\&.\&. Computations>
.br
requires CompatibleComputations<Computations\&.\&.\&.> && (std::constructible_from<std::remove_cvref_t<Computations>, Computations> && \&.\&.\&.) && CanPrepare<\fBComputationGraph\fP<std::remove_cvref_t<Computations>\&.\&.\&.>, ContextT, ErrorT>auto \fBserif::utils::dependencies::make_computation_cache\fP (const ContextT &context, Computations &&\&.\&.\&. computations)"
.br
.RI "Build a checked graph and an empty cache directly from named computations\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.