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)
77 lines
3.1 KiB
Groff
77 lines
3.1 KiB
Groff
.TH "serif::utils::dependencies::PreparationReport< ResultsT, SourcesT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::utils::dependencies::PreparationReport< ResultsT, SourcesT >
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <preparation\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename KeyT>
|
|
.br
|
|
requires \fBdetail::contains_key_v\fP<KeyT, ResultsT>\fBPreparationStatus\fP \fBstatus\fP () const"
|
|
.br
|
|
.RI "Inspect a computation by its result key rather than an implementation index\&. "
|
|
.ti -1c
|
|
.RI "template<typename KeyT>
|
|
.br
|
|
requires \fBdetail::contains_key_v\fP<KeyT, SourcesT>bool \fBsource_changed\fP () const"
|
|
.br
|
|
.RI "An unused source is reported unchanged because it was not inspected by this request\&. "
|
|
.ti -1c
|
|
.RI "std::size_t \fBcomputed_count\fP () const"
|
|
.br
|
|
.RI "Count only computations evaluated during this successful preparation\&. "
|
|
.ti -1c
|
|
.RI "std::size_t \fBreused_count\fP () const"
|
|
.br
|
|
.RI "Count requested computations served from the accepted cache\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::array< \fBPreparationStatus\fP, \fBdetail::KeyListSize\fP< ResultsT >::value > \fBstatuses\fP {}"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::array< bool, \fBdetail::KeyListSize\fP< SourcesT >::value > \fBchanged_sources\fP {}"
|
|
.br
|
|
.in -1c
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<IsKeyList ResultsT, IsKeyList SourcesT> std::size_t \fBserif::utils::dependencies::PreparationReport\fP< ResultsT, SourcesT >::computed_count () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Count only computations evaluated during this successful preparation\&.
|
|
.SS "template<IsKeyList ResultsT, IsKeyList SourcesT> std::size_t \fBserif::utils::dependencies::PreparationReport\fP< ResultsT, SourcesT >::reused_count () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Count requested computations served from the accepted cache\&.
|
|
.SS "template<IsKeyList ResultsT, IsKeyList SourcesT> template<typename KeyT>
|
|
.br
|
|
requires \fBdetail::contains_key_v\fP<KeyT, SourcesT>bool \fBserif::utils::dependencies::PreparationReport\fP< ResultsT, SourcesT >::source_changed () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
An unused source is reported unchanged because it was not inspected by this request\&.
|
|
.SS "template<IsKeyList ResultsT, IsKeyList SourcesT> template<typename KeyT>
|
|
.br
|
|
requires \fBdetail::contains_key_v\fP<KeyT, ResultsT>\fBPreparationStatus\fP \fBserif::utils::dependencies::PreparationReport\fP< ResultsT, SourcesT >::status () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Inspect a computation by its result key rather than an implementation index\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<IsKeyList ResultsT, IsKeyList SourcesT> std::array<bool, \fBdetail::KeyListSize\fP<SourcesT>::value> \fBserif::utils::dependencies::PreparationReport\fP< ResultsT, SourcesT >::changed_sources {}"
|
|
|
|
.SS "template<IsKeyList ResultsT, IsKeyList SourcesT> std::array<\fBPreparationStatus\fP, \fBdetail::KeyListSize\fP<ResultsT>::value> \fBserif::utils::dependencies::PreparationReport\fP< ResultsT, SourcesT >::statuses {}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|