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)
61 lines
2.1 KiB
Groff
61 lines
2.1 KiB
Groff
.TH "serif::utils::dependencies::GraphTiming" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::utils::dependencies::GraphTiming \- Collect independent graph bindings without mixing timers into numerical restart history\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <timing\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "const std::vector< std::shared_ptr< const \fBGraphTimingRun\fP > > & \fBruns\fP () const noexcept"
|
|
.br
|
|
.RI "Inspect completed and active measurements without changing their catalog or indices\&. "
|
|
.ti -1c
|
|
.RI "template<typename GraphT> std::shared_ptr< \fBGraphTimingRun\fP > \fBstart_run\fP (std::type_identity< GraphT >)"
|
|
.br
|
|
.RI "Allocate names and counters once, before any measured node begins\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::vector< std::shared_ptr< const \fBGraphTimingRun\fP > > \fBm_runs\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Collect independent graph bindings without mixing timers into numerical restart history\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
One cache executes its nodes serially, although each node may contain parallel kernels\&. Concurrent caches require separate collectors\&. Returned observers own their run; the collector need only outlive factory invocation\&. Formatting and sorting belong outside timed execution\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "const std::vector< std::shared_ptr< const \fBGraphTimingRun\fP > > & serif::utils::dependencies::GraphTiming::runs () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Inspect completed and active measurements without changing their catalog or indices\&.
|
|
.SS "template<typename GraphT> std::shared_ptr< \fBGraphTimingRun\fP > serif::utils::dependencies::GraphTiming::start_run (std::type_identity< GraphT > )\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Allocate names and counters once, before any measured node begins\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::vector<std::shared_ptr<const \fBGraphTimingRun\fP> > serif::utils::dependencies::GraphTiming::m_runs\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|