Statistiques

Statistiques#

#include <Statistiques.h>

How to cite this class in this doc#

RST

:ref:`Statistiques <class-statistiques>`

Markdown

[Statistiques](#class-statistiques)

Detailed description#

List of Public Static Methods#

get_time_now

List of Protected Methods#

begin_count_
end_count_

Complete Member Function Documentation#

allocate_communication_tracking_times

int Statistiques::allocate_communication_tracking_times()

Create the table of communication stats after the declaration of all of the counters.

begin_communication_tracking

void Statistiques::begin_communication_tracking(int cid)

Start communication tracking.

Counters stats are saved in the table communication_tracking_info Update the entire table communication_tracking_info : the total time of communication for all communication counter and the communication time per domain j for each counter /!reset the counter associated with cid comm_domaines_on becomes true

begin_count

void Statistiques::begin_count(const Stat_Counter_Id &counter_id, bool track_comm=true)

Start the count of a counter.

compute_avg_min_max_var_per_step

void Statistiques::compute_avg_min_max_var_per_step(int tstep)

Compute the average, minimum, maximum and variance of the elapsed time on an iteration for each counter

cumulate_stats

void Statistiques::cumulate_stats(int counter_id, Stat_Results &result)

Aggregate stats of the counter associated with counter ID to the stats in a Stat_Results type object.

delete_communication_tracking_times

int Statistiques::delete_communication_tracking_times()

Delete the table of communication stats at the end of the calculation.

dump

void Statistiques::dump(const char *message_info, int mode_append)

Function that create the file CASE_NAME_log_perf.csv.

This function construct a .csv file in which counter stats are printed. This function prints the global and detailed performance log, depending on the debug_level. It has to be called on every processor simultaneously During this function, all counters are stop and then restart

end_communication_tracking

void Statistiques::end_communication_tracking(int cid)

Update communications info regarding counter cid and stop the count.

Update the variable communication_tracking_info[i][cid + 1] with the communication tracking associated with counter cid. comm_domaines_on become flase

end_count

void Statistiques::end_count(const Stat_Counter_Id &counter_id, trustIdType quantity=0, int count=1, bool track_comm=true)

End the count of a counter and update values in the Stat_Internals object of the Statistiques object.

Arret du compteur counter_id. On ajoute quantity a la somme des ‘quantity’ (par defaut 0) stockees pour ce compteur et on ajoute ‘count’ (par defaut 1) au compteur d’appels a end_count pour ce compteur (quantity sert a sommer par exemple la taille des donnees traitees pendant ce comptage et count sert a compter combien de fois on a appele ce compteur)

get_communication_tracking_info

Stat_Results Statistiques::get_communication_tracking_info(int i, int j) const

get_counter_family

const char * Statistiques::get_counter_family(int id)

get_counter_id_from_description

int Statistiques::get_counter_id_from_description(const char *desc) const

get_counter_id_from_index_in_comm_tracking_info

int Statistiques::get_counter_id_from_index_in_comm_tracking_info(int index) const

get_index_in_comm_tracking_info_from_counter_id

int Statistiques::get_index_in_comm_tracking_info_from_counter_id(int id) const

get_nb_comm_counters

int Statistiques::get_nb_comm_counters() const

get_stats

void Statistiques::get_stats(const Stat_Counter_Id &counter_id, Stat_Results &result)

Get back the stats of a counter and store them in a Stat_Resluts type object.

get_stats_familly

void Statistiques::get_stats_familly(const char *familly, Stat_Results &result)

Get back and agregate the stats of a set of counters and store them in a Stat_Resluts type object.

get_total_time

double Statistiques::get_total_time()

Get the protected variable total_time of a Statistics type object.

last_time

double Statistiques::last_time(const Stat_Counter_Id &counter_id)

Give the last interval of time the counter has been used.

If the counter is still running, return the time since the last begin_count If the counter is stopped, return the interval of time of the last count

new_counter

Stat_Counter_Id Statistiques::new_counter(int level, const char *const description, const char *const familly=0, int comm=0)

Create a new counter in the Statistiques object.

This function has to be called simultaneously on every processor

print_communciation_tracking_details

void Statistiques::print_communciation_tracking_details(const char *message, int mode_append)

Print communication stats For each declared communication domain/function, print the average time spend for each type of communication on each processor And for each time of communication, print the average time spend on each domain/function on each processor

reset_counter

void Statistiques::reset_counter(int counter_id)

Reset the counter related to the counter_id.

Some variables are kept even after the reset : counters_avg_min_max_var_per_step and communication_tracking_info

reset_counters

void Statistiques::reset_counters()

Reset all counters.

Some variables are kept even after the reset : counters_avg_min_max_var_per_step and communication_tracking_info

restart_counters

void Statistiques::restart_counters()

set_debug_level

void Statistiques::set_debug_level(int level)

Function that change the debug level.

This function have to be called simultanely on each processor

set_three_first_steps_elapsed

void Statistiques::set_three_first_steps_elapsed(bool b)

Statistiques

Statistiques::Statistiques()

stop_counters

void Statistiques::stop_counters()

~Statistiques

Statistiques::~Statistiques()

get_time_now

double Statistiques::get_time_now()

Return the clock time.

Cette methode renvoie un temps en secondes depuis une origine qui depend de la methode de mesure de la classe Time. Precision, de l’ordre de 1ms maximum.

begin_count_

void Statistiques::begin_count_(const int id_)

end_count_

void Statistiques::end_count_(const int id_, trustIdType quantity, int count)

Attributes Documentation#

debug_level_ (protected)

int Statistiques::debug_level_

stat_internals (protected)

Stat_Internals* Statistiques::stat_internals

three_first_steps_elapsed_ (protected)

bool Statistiques::three_first_steps_elapsed_

If TRUE, the 3 first time steps are elapsed.

total_time_ (protected)

double Statistiques::total_time_

Statistiques

Contents

Statistiques#

How to cite this class in this doc#

Detailed description#

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

Attributes Documentation#