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

97 lines
2.5 KiB
Groff
Raw Normal View History

.TH "src/include/serif/utils/dependencies/timing.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/dependencies/timing.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <algorithm>\fP
.br
\fR#include <chrono>\fP
.br
\fR#include <cstddef>\fP
.br
\fR#include <cstdint>\fP
.br
\fR#include <memory>\fP
.br
\fR#include <string>\fP
.br
\fR#include <vector>\fP
.br
\fR#include 'nameof\&.hpp'\fP
.br
\fR#include 'serif/utils/dependencies/observers\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::utils::dependencies::NodeTiming\fP"
.br
.RI "Wall time for attempted node work, independently of later cache or Newton acceptance\&. "
.ti -1c
.RI "struct \fBserif::utils::dependencies::GraphTimingRun\fP"
.br
.RI "One graph binding's declaration-ordered catalog, including nodes which never execute\&. "
.ti -1c
.RI "class \fBserif::utils::dependencies::GraphTiming\fP"
.br
.RI "Collect independent graph bindings without mixing timers into numerical restart history\&. "
.ti -1c
.RI "struct \fBserif::utils::dependencies::SteadyNodeClock\fP"
.br
.RI "Read monotonic elapsed wall time without changing physical computations\&. "
.ti -1c
.RI "struct \fBserif::utils::dependencies::GraphTimingFactory< Clock >\fP"
.br
.RI "Bind one generic timing observer after the model's complete graph type is known\&. "
.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::NodeTimingClock\fP"
.br
.RI "Restrict injected clocks to ordinary arithmetic chrono values safe in a closing callback\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<NodeTimingClock Clock = SteadyNodeClock> auto \fBserif::utils::dependencies::time_graph_nodes\fP (\fBGraphTiming\fP &timing, Clock clock={})"
.br
.RI "Opt into node timings; a custom clock supports deterministic accounting tests without sleeps\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename TimePoint> constexpr bool \fBserif::utils::dependencies::detail::node_time_point_v\fP = false"
.br
.ti -1c
.RI "template<typename Clock, typename Duration> constexpr bool \fBserif::utils::dependencies::detail::node_time_point_v< std::chrono::time_point< Clock, Duration > >\fP = std::is_arithmetic_v<typename Duration::rep>"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.