Counter

Counter#

Brief description

How to reference this class#

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`Counter <class-counter>`

[Counter](#class-counter)

Detailed description#

Member Functions: Public#

Complete Member Function Documentation#

begin_count_#

Definition
void Counter::begin_count_(int counter_level, time_point t)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void Counter::begin_count_(int counter_level, time_point t) <counter-public-void-counter-begin-count-underscore-int-counter-level-time-point-t>`

[void Counter::begin_count_(int counter_level, time_point t)](#counter-public-void-counter-begin-count-underscore-int-counter-level-time-point-t)

compute_min_max_avg_sd_#

Definition
std::array<std::array<double, 4>, 4> Counter::compute_min_max_avg_sd_() const
Brief description

update variables : avg_time_per_step_ , min_time_per_step_ , max_time_per_step_ , sd_time_per_step_

Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`std::array<std::array<double, 4>, 4> Counter::compute_min_max_avg_sd_() const <counter-public-std-array-std-array-double-4-4-counter-compute-min-max-avg-sd-underscore-const>`

[std::array<std::array<double, 4>, 4> Counter::compute_min_max_avg_sd_() const](#counter-public-std-array-std-array-double-4-4-counter-compute-min-max-avg-sd-underscore-const)

Counter#

Definition
Counter::Counter(int counter_level, std::string counter_name, std::string counter_family="None", bool is_comm=false, bool is_gpu=false)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`Counter::Counter(int counter_level, std::string counter_name, std::string counter_family="None", bool is_comm=false, bool is_gpu=false) <counter-public-counter-counter-int-counter-level-std-string-counter-name-std-string-counter-family-equal-"none"-bool-is-comm-equal-false-bool-is-gpu-equal-false>`

[Counter::Counter(int counter_level, std::string counter_name, std::string counter_family="None", bool is_comm=false, bool is_gpu=false)](#counter-public-counter-counter-int-counter-level-std-string-counter-name-std-string-counter-family-equal-"none"-bool-is-comm-equal-false-bool-is-gpu-equal-false)

end_count_#

Definition
void Counter::end_count_(int count_increment, long int quantity_increment, time_point t_stop)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void Counter::end_count_(int count_increment, long int quantity_increment, time_point t_stop) <counter-public-void-counter-end-count-underscore-int-count-increment-long-int-quantity-increment-time-point-t-stop>`

[void Counter::end_count_(int count_increment, long int quantity_increment, time_point t_stop)](#counter-public-void-counter-end-count-underscore-int-count-increment-long-int-quantity-increment-time-point-t-stop)

get_time_#

Definition
double Counter::get_time_() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`double Counter::get_time_() const <counter-public-double-counter-get-time-underscore-const>`

[double Counter::get_time_() const](#counter-public-double-counter-get-time-underscore-const)

now#

Definition
time_point Counter::now()
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`time_point Counter::now() <counter-public-time-point-counter-now>`

[time_point Counter::now()](#counter-public-time-point-counter-now)

reset#

Definition
void Counter::reset()
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void Counter::reset() <counter-public-void-counter-reset>`

[void Counter::reset()](#counter-public-void-counter-reset)

running_#

Definition
bool Counter::running_() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`bool Counter::running_() const <counter-public-bool-counter-running-underscore-const>`

[bool Counter::running_() const](#counter-public-bool-counter-running-underscore-const)

set_parent#

Definition
void Counter::set_parent(Counter *parent_counter)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void Counter::set_parent(Counter *parent_counter) <counter-public-void-counter-set-parent-counter-ptr-parent-counter>`

[void Counter::set_parent(Counter *parent_counter)](#counter-public-void-counter-set-parent-counter-ptr-parent-counter)

Attributes Documentation#

avg_time_per_step_ (public)
double Counter::avg_time_per_step_
count_ (public)
int Counter::count_
description_ (public)
const std::string Counter::description_
family_ (public)
const std::string Counter::family_
is_comm_ (public)
const bool Counter::is_comm_
is_gpu_ (public)
const bool Counter::is_gpu_
is_running_ (public)
bool Counter::is_running_
last_open_time_ (public)
time_point Counter::last_open_time_
last_open_time_alone_ (public)
time_point Counter::last_open_time_alone_
level_ (public)
int Counter::level_
max_time_per_step_ (public)
double Counter::max_time_per_step_
min_time_per_step_ (public)
double Counter::min_time_per_step_
open_time_ts_ (public)
time_point Counter::open_time_ts_
parent_ (public)
Counter* Counter::parent_
quantity_ (public)
long int Counter::quantity_
time_alone_ (public)
duration Counter::time_alone_
time_ts_ (public)
duration Counter::time_ts_
total_time_ (public)
duration Counter::total_time_
var_time_per_step_ (public)
double Counter::var_time_per_step_
Contents