Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
70 lines
1.9 KiB
Groff
70 lines
1.9 KiB
Groff
.TH "src/include/serif/utils/dependencies/incremental_computation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/utils/dependencies/incremental_computation.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <concepts>\fP
|
|
.br
|
|
\fR#include <functional>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/utils/dependencies/computation\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/dependencies/detail/result\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/dependencies/detail/type_lists\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::dependencies::ComputationUpdate< InputsT, ValueT >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "class \fBserif::utils::dependencies::IncrementalComputation< KeyT, ValueT, InputsT, FunctionT >\fP"
|
|
.br
|
|
.RI "A calculation may reuse unchanged pieces of its previous immutable result\&. "
|
|
.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 KeyT, typename ValueT, IsKeyList InputsT, typename FunctionT>
|
|
.br
|
|
requires std::is_object_v<ValueT> && std::move_constructible<ValueT> && std::constructible_from<std::decay_t<FunctionT>, FunctionT>auto \fBserif::utils::dependencies::make_incremental_computation\fP (FunctionT &&function)"
|
|
.br
|
|
.RI "Declare the result type explicitly so an incremental callable can inspect its previous value\&. "
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename KeyT, typename ValueT, typename InputsT, typename FunctionT> constexpr bool \fBserif::utils::dependencies::is_computation_v< IncrementalComputation< KeyT, ValueT, InputsT, FunctionT > >\fP = true"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|