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)
66 lines
2.5 KiB
Groff
66 lines
2.5 KiB
Groff
.TH "serif::utils::dependencies::ProjectedSnapshot< FunctionT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::utils::dependencies::ProjectedSnapshot< FunctionT >
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <snapshot\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBProjectedSnapshot\fP (FunctionT function)"
|
|
.br
|
|
.RI "Own the policy callable so its configuration travels with the source\&. "
|
|
.ti -1c
|
|
.RI "template<typename T>
|
|
.br
|
|
requires std::invocable<const FunctionT&, const T&>auto \fBcapture\fP (const T &value) const"
|
|
.br
|
|
.RI "Capture a comparable value such as a resource revision or a tuple of revisions\&. "
|
|
.ti -1c
|
|
.RI "template<typename CapturedT, typename T>
|
|
.br
|
|
requires requires(const CapturedT& captured, const \fBProjectedSnapshot\fP& policy, const T& value) { { captured == policy\&.capture(value) } \-> std::convertible_to<bool>; }bool \fBmatches\fP (const CapturedT &captured, const T &value) const"
|
|
.br
|
|
.RI "Recompute the tracking value without copying the resource itself\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "FunctionT \fBm_function\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<typename FunctionT> \fBserif::utils::dependencies::ProjectedSnapshot\fP< FunctionT >::ProjectedSnapshot (FunctionT function)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Own the policy callable so its configuration travels with the source\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<typename FunctionT> template<typename T>
|
|
.br
|
|
requires std::invocable<const FunctionT&, const T&>auto \fBserif::utils::dependencies::ProjectedSnapshot\fP< FunctionT >::capture (const T & value) const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Capture a comparable value such as a resource revision or a tuple of revisions\&.
|
|
.SS "template<typename FunctionT> template<typename CapturedT, typename T>
|
|
.br
|
|
requires requires(const CapturedT& captured, const \fBProjectedSnapshot\fP& policy, const T& value) { { captured == policy\&.capture(value) } \-> std::convertible_to<bool>; }bool \fBserif::utils::dependencies::ProjectedSnapshot\fP< FunctionT >::matches (const CapturedT & captured, const T & value) const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Recompute the tracking value without copying the resource itself\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename FunctionT> FunctionT \fBserif::utils::dependencies::ProjectedSnapshot\fP< FunctionT >::m_function\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|