docs(docs): built docs

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)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,89 @@
.TH "src/include/serif/utils/dependencies/computation_store.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/computation_store.hpp
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/utils/error/errors\&.hpp'\fP
.br
\fR#include <concepts>\fP
.br
\fR#include <cstddef>\fP
.br
\fR#include <memory>\fP
.br
\fR#include <stdexcept>\fP
.br
\fR#include <tuple>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include <utility>\fP
.br
\fR#include 'serif/utils/dependencies/binding\&.hpp'\fP
.br
\fR#include 'serif/utils/dependencies/detail/type_lists\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::utils::dependencies::OwnedComputation< KeyT, ComputationT >\fP"
.br
.ti -1c
.RI "class \fBserif::utils::dependencies::ComputationStore< EntryTs >\fP"
.br
.RI "Own independent computation caches under compile-time role keys; this store does not connect their graphs\&. "
.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::IsOwnedComputation\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename KeyT, typename ComputationT>
.br
requires std::constructible_from<std::remove_cvref_t<ComputationT>, ComputationT>auto \fBserif::utils::dependencies::own_computation\fP (ComputationT &&computation)"
.br
.RI "Name an owned computation; rvalues transfer ownership and copyable lvalues are copied\&. "
.ti -1c
.RI "template<typename\&.\&.\&. EntryTs>
.br
requires (IsOwnedComputation<EntryTs> && \&.\&.\&.) && \fBmisc::traits::all_unique_types_v\fP<typename std::remove_cvref_t<EntryTs>::Key\&.\&.\&.> && (std::constructible_from<std::remove_cvref_t<EntryTs>, EntryTs> && \&.\&.\&.)auto \fBserif::utils::dependencies::make_computation_store\fP (EntryTs &&\&.\&.\&. entries)"
.br
.RI "Construct the model's computation owner, rejecting duplicate role keys before execution\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename T> constexpr bool \fBserif::utils::dependencies::is_owned_computation_v\fP = false"
.br
.ti -1c
.RI "template<typename KeyT, typename ComputationT> constexpr bool \fBserif::utils::dependencies::is_owned_computation_v< OwnedComputation< KeyT, ComputationT > >\fP = true"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.