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)
71 lines
2.0 KiB
Groff
71 lines
2.0 KiB
Groff
.TH "src/include/serif/utils/dependencies/detail/result.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/utils/dependencies/detail/result.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <concepts>\fP
|
|
.br
|
|
\fR#include <expected>\fP
|
|
.br
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/utils/types/type_list\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::dependencies::detail::Result< T >\fP"
|
|
.br
|
|
.RI "Computations publish owned, movable values, either directly or through std::expected\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::dependencies::detail::Result< std::expected< ValueT, ErrorT > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::dependencies::detail::Invocation< ComputationT, ArgumentsT, typename >\fP"
|
|
.br
|
|
.RI "Ill-formed calls fail the graph concept instead of producing a hard instantiation error\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::dependencies::detail::Invocation< ComputationT, types::TypeList< Arguments\&.\&.\&. >, std::void_t< InvocationResult< ComputationT, Arguments\&.\&.\&. > > >\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 "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename ComputationT, typename TargetT> using \fBserif::utils::dependencies::detail::ComputationArgument\fP = std::conditional_t<ComputationT::owns_inputs, std::shared_ptr<const TargetT>, TargetT>"
|
|
.br
|
|
.RI "Owning computations receive the cache handle; ordinary computations receive the value\&. "
|
|
.ti -1c
|
|
.RI "template<typename ComputationT, typename\&.\&.\&. Arguments> using \fBserif::utils::dependencies::detail::InvocationResult\fP"
|
|
.br
|
|
.RI "Match the const argument access used by the runtime cache without constructing any values\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|