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)
76 lines
1.9 KiB
Groff
76 lines
1.9 KiB
Groff
.TH "src/include/serif/utils/dependencies/computation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/utils/dependencies/computation.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\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/key_list\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::utils::dependencies::Computation< KeyT, InputsT, FunctionT, OwnsInputs >\fP"
|
|
.br
|
|
.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 "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBserif::utils::dependencies::IsComputation\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename KeyT, IsKeyList InputsT, typename FunctionT>
|
|
.br
|
|
requires std::constructible_from<std::decay_t<FunctionT>, FunctionT>auto \fBserif::utils::dependencies::make_computation\fP (FunctionT &&function)"
|
|
.br
|
|
.RI "Attach an output key and ordered input keys to a lambda, function, or other callable\&. "
|
|
.ti -1c
|
|
.RI "template<typename KeyT, IsKeyList InputsT, typename FunctionT>
|
|
.br
|
|
requires std::constructible_from<std::decay_t<FunctionT>, FunctionT>auto \fBserif::utils::dependencies::make_owning_computation\fP (FunctionT &&function)"
|
|
.br
|
|
.RI "Supply immutable shared handles to computed prerequisites so results can retain them without copying\&. "
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename T> constexpr bool \fBserif::utils::dependencies::is_computation_v\fP = false"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename KeyT, typename InputsT, typename FunctionT, bool OwnsInputs> constexpr bool \fBserif::utils::dependencies::is_computation_v< Computation< KeyT, InputsT, FunctionT, OwnsInputs > >\fP = true"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|