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,82 @@
.TH "src/include/serif/utils/dependencies/key_list.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/key_list.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <type_traits>\fP
.br
\fR#include 'serif/utils/dependencies/binding\&.hpp'\fP
.br
\fR#include 'serif/utils/misc/traits/type_uniqueness\&.hpp'\fP
.br
\fR#include 'serif/utils/types/type_list\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::utils::dependencies::KeyList< KeyTs >\fP"
.br
.RI "An ordered collection of role keys, independent of their associated value types\&. "
.ti -1c
.RI "struct \fBserif::utils::dependencies::KeyListBindings< BindingsT, KeyList< KeyTs\&.\&.\&. > >\fP"
.br
.ti -1c
.RI "struct \fBserif::utils::dependencies::ResolveKeys< BindingsT, KeyList< KeyTs\&.\&.\&. > >\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::IsKeyList\fP"
.br
.ti -1c
.RI "concept \fBserif::utils::dependencies::SatisfiesKeyList\fP"
.br
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "template<typename\&.\&.\&. KeyTs> using \fBserif::utils::dependencies::InputList\fP = \fBKeyList\fP<KeyTs\&.\&.\&.>"
.br
.RI "\fBComputation\fP arguments are supplied in this key order\&. "
.ti -1c
.RI "template<typename\&.\&.\&. KeyTs> using \fBserif::utils::dependencies::RequestedResults\fP = \fBKeyList\fP<KeyTs\&.\&.\&.>"
.br
.RI "Preparing these results also prepares their required intermediate computations\&. "
.ti -1c
.RI "template<typename BindingsT, typename KeysT> using \fBserif::utils::dependencies::ResolvedTargets\fP = \fBResolveKeys\fP<BindingsT, std::remove_cvref_t<KeysT>>::type"
.br
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename T> constexpr bool \fBserif::utils::dependencies::is_key_list_v\fP = false"
.br
.ti -1c
.RI "template<typename\&.\&.\&. KeyTs> constexpr bool \fBserif::utils::dependencies::is_key_list_v< KeyList< KeyTs\&.\&.\&. > >\fP = \fBmisc::traits::all_unique_types_v\fP<KeyTs\&.\&.\&.>"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.