Files
MeanField_SERiF/docs/man/man3/key_list_operations.hpp.3
Emily Boudreaux 6b57738330 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)
2026-11-09 14:09:44 -05:00

66 lines
1.7 KiB
Groff

.TH "src/include/serif/utils/dependencies/key_list_operations.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/key_list_operations.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <cstddef>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include 'serif/utils/dependencies/detail/type_lists\&.hpp'\fP
.br
.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::ContainsKey\fP"
.br
.RI "Test exact key membership, rejecting malformed and duplicate-key lists\&. "
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "template<IsKeyList\&.\&.\&. Lists> using \fBserif::utils::dependencies::CombinedKeyList\fP = \fBdetail::MergeKeyLists\fP<\fBKeyList\fP<>, std::remove_cvref_t<Lists>\&.\&.\&.>::type"
.br
.RI "Combine requirements in first-appearance order, retaining distinct keys with shared targets\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename KeyT, typename KeysT>
.br
requires ContainsKey<KeyT, KeysT>consteval std::size_t \fBserif::utils::dependencies::key_index\fP ()"
.br
.RI "Locate a declared key in its ordered list; absent keys are rejected at compile time\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<IsKeyList KeysT> constexpr std::size_t \fBserif::utils::dependencies::key_count_v\fP = \fBdetail::KeyListSize\fP<std::remove_cvref_t<KeysT>>::value"
.br
.RI "Count distinct declared keys without constructing their associated values\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.