papi_hl_output_writer.Sum_Counters(3)

NAME
papi_hl_output_writer.Sum_Counters - Sum_Counters class defintion.

SYNOPSIS

Inherits object.

  Public Member Functions
__init__ (self)
Sum_Counters class initializer.
add_region (self, rank_id, thread_id, events=OrderedDict())
Method defintion for add_region.
get_json (self)
Method definition for get_json.

  Data Fields
regions
regions_last_rank_id
regions_rank_num
regions_last_thread_id
regions_thread_num
clean_regions
sum_counters

Detailed Description

Gathers summary output for a region (e.g. computation) and accompanying measurements for a recorded event (e.g. PAPI_TOT_INS).

Member Function Documentation

  papi_hl_output_writer.Sum_Counters.add_region ( self, rank_id, thread_id, events = OrderedDict())
Adds the region (e.g. computation) and accompanying measurements for a recorded event (e.g. PAPI_TOT_INS) to summary output.

Parameters
    rank_id MPI rank, if no MPI rank is present this value will be random.
    thread_id Thread identifier containing performance events. E.g. 0.
    events An ordered dictionary containing measurements for recorded events obtained through PAPI HL function calls. E.g. PAPI_TOT_INS.

  papi_hl_output_writer.Sum_Counters.get_json ( self)
Calculates the min, max, median, or sum for a set of measurements for a recorded event. E.g. PAPI_TOT_INS.

Returns
    An ordered dictionary containing summary measurements for recorded events. E.g. PAPI_TOT_INS.

Author

Generated automatically by Doxygen for PAPI from the source code.