Files
MeanField_SERiF/docs/man/man3/computation_graph.hpp.3

87 lines
2.3 KiB
Groff
Raw Normal View History

.TH "src/include/serif/utils/dependencies/computation_graph.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/computation_graph.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <concepts>\fP
.br
\fR#include <cstddef>\fP
.br
\fR#include <tuple>\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/key_list_operations\&.hpp'\fP
.br
\fR#include 'serif/utils/dependencies/detail/graph\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::utils::dependencies::ComputationGraph< Computations >\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
.ti -1c
.RI "namespace \fBserif::utils::dependencies::detail\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBserif::utils::dependencies::CompatibleComputations\fP"
.br
.RI "A computational graph needs unique producers, valid input ownership, and no cycles\&. "
.ti -1c
.RI "concept \fBserif::utils::dependencies::IsComputationGraph\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename\&.\&.\&. Computations>
.br
requires CompatibleComputations<Computations\&.\&.\&.> && (std::constructible_from<std::remove_cvref_t<Computations>, Computations> && \&.\&.\&.)auto \fBserif::utils::dependencies::make_computation_graph\fP (Computations &&\&.\&.\&. computations)"
.br
.RI "Reject duplicate producers and cyclic computational graphs at the declaration site\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename ComputationT, typename ResultKeysT> constexpr bool \fBserif::utils::dependencies::detail::valid_input_ownership_v\fP"
.br
.RI "Owning nodes can retain computed inputs; context resources remain borrowed\&. "
.ti -1c
.RI "template<typename T> constexpr bool \fBserif::utils::dependencies::is_computation_graph_v\fP = false"
.br
.ti -1c
.RI "template<typename\&.\&.\&. Computations> constexpr bool \fBserif::utils::dependencies::is_computation_graph_v< ComputationGraph< Computations\&.\&.\&. > >\fP = true"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.