Files
MeanField_SERiF/docs/man/man3/serif_utils_dependencies_NodeTiming.3

79 lines
2.0 KiB
Groff
Raw Permalink Normal View History

.TH "serif::utils::dependencies::NodeTiming" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::dependencies::NodeTiming \- Wall time for attempted node work, independently of later cache or Newton acceptance\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <timing\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBfinish\fP (double duration, \fBNodeOutcome\fP outcome) noexcept"
.br
.RI "Closing a node must neither allocate nor fail during stack unwinding\&. "
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "std::size_t \fBindex\fP {}"
.br
.ti -1c
.RI "std::string \fBkey_name\fP"
.br
.ti -1c
.RI "std::uint64_t \fBcalls\fP {}"
.br
.ti -1c
.RI "std::uint64_t \fBcompleted\fP {}"
.br
.ti -1c
.RI "std::uint64_t \fBrejected\fP {}"
.br
.ti -1c
.RI "std::uint64_t \fBexceptions\fP {}"
.br
.ti -1c
.RI "double \fBseconds\fP {}"
.br
.ti -1c
.RI "double \fBmaximum_seconds\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP
Wall time for attempted node work, independently of later cache or Newton acceptance\&.
.SH "Member Function Documentation"
.PP
.SS "void serif::utils::dependencies::NodeTiming::finish (double duration, \fBNodeOutcome\fP outcome)\fR [inline]\fP, \fR [noexcept]\fP"
.PP
Closing a node must neither allocate nor fail during stack unwinding\&.
.SH "Member Data Documentation"
.PP
.SS "std::uint64_t serif::utils::dependencies::NodeTiming::calls {}"
.SS "std::uint64_t serif::utils::dependencies::NodeTiming::completed {}"
.SS "std::uint64_t serif::utils::dependencies::NodeTiming::exceptions {}"
.SS "std::size_t serif::utils::dependencies::NodeTiming::index {}"
.SS "std::string serif::utils::dependencies::NodeTiming::key_name"
.SS "double serif::utils::dependencies::NodeTiming::maximum_seconds {}"
.SS "std::uint64_t serif::utils::dependencies::NodeTiming::rejected {}"
.SS "double serif::utils::dependencies::NodeTiming::seconds {}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.