#include <source/toolbox/timers/Statistician.h>
Public Member Functions | |
| virtual Pointer< Statistic > | getStatistic (const string &name, const string &stat_type) |
| virtual bool | checkStatisticExists (Pointer< Statistic > &stat, const string &name) const |
| virtual int | getNumberProcessorStats () const |
| virtual int | getNumberPatchStats () const |
| virtual void | resetProcessorStatistics () |
| virtual void | resetPatchStatistics () |
| virtual void | resetStatistics () |
| virtual int | getProcStatId (const string &name) const |
| virtual int | getGlobalProcStatSequenceLength (int proc_stat_id) |
| virtual double | getGlobalProcStatValue (int proc_stat_id, int seq_num, int proc_num) |
| virtual double | getGlobalProcStatSum (int proc_stat_id, int seq_num) |
| virtual double | getGlobalProcStatMax (int proc_stat_id, int seq_num) |
| virtual int | getGlobalProcStatMaxProcessorId (int proc_stat_id, int seq_num) |
| virtual double | getGlobalProcStatMin (int proc_stat_id, int seq_num) |
| virtual int | getGlobalProcStatMinProcessorId (int proc_stat_id, int seq_num) |
| virtual void | printGlobalProcStatData (int proc_stat_id, ostream &os, int precision=12) |
| virtual void | printGlobalProcStatDataFormatted (int proc_stat_id, ostream &os, int precision=12) |
| virtual void | printGlobalProcStatDataFormatted (int proc_stat_id, int proc_id, ostream &os, int precision=12) |
| virtual int | getPatchStatId (const string &name) const |
| virtual int | getGlobalPatchStatSequenceLength (int patch_stat_id) |
| virtual int | getGlobalPatchStatNumberPatches (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatPatchMapping (int patch_stat_id, int seq_num, int patch_num) |
| virtual double | getGlobalPatchStatValue (int patch_stat_id, int seq_num, int patch_num) |
| virtual double | getGlobalPatchStatSum (int patch_stat_id, int seq_num) |
| virtual double | getGlobalPatchStatMax (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatMaxPatchId (int patch_stat_id, int seq_num) |
| virtual double | getGlobalPatchStatMin (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatMinPatchId (int patch_stat_id, int seq_num) |
| virtual double | getGlobalPatchStatProcessorSum (int patch_stat_id, int processor_id, int seq_num) |
| virtual double | getGlobalPatchStatProcessorSumMax (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatProcessorSumMaxId (int patch_stat_id, int seq_num) |
| virtual double | getGlobalPatchStatProcessorSumMin (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatProcessorSumMinId (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatNumberPatchesOnProc (int patch_stat_id, int seq_num, int proc_id) |
| virtual int | getGlobalPatchStatMaxPatchesPerProc (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatMaxPatchesPerProcId (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatMinPatchesPerProc (int patch_stat_id, int seq_num) |
| virtual int | getGlobalPatchStatMinPatchesPerProcId (int patch_stat_id, int seq_num) |
| virtual void | printGlobalPatchStatData (int patch_stat_id, ostream &os, int precision=12) |
| virtual void | printGlobalPatchStatDataFormatted (int patch_stat_id, ostream &os, int precision=12) |
| virtual void | finalize () |
| virtual void | printLocalStatData (ostream &os, int precision=12) const |
| virtual void | printAllGlobalStatData (ostream &os, int precision=12) |
| virtual void | printAllSummedGlobalStatData (ostream &os, int precision=12) |
| virtual void | printAllSummedGlobalStatData (const string &filename, int precision=12) |
| virtual void | printSpreadSheetOutput (const string &dirname=string(), int precision=12) |
| virtual void | printSpreadSheetOutputForProcessor (const int proc_id, const string &dirname=string(), int precision=12) |
Static Public Member Functions | |
| static Statistician * | createStatistician (bool register_for_restart=true, bool read_from_restart=true) |
| static Statistician * | getStatistician () |
| static void | freeStatistician () |
Protected Member Functions | |
| Statistician () | |
| virtual | ~Statistician () |
| void | registerSingletonSubclassInstance (Statistician *subclass_instance) |
| virtual void | checkStatsForConsistency (Array< int > &total_patches) |
| virtual bool | checkProcStatExists (Pointer< Statistic > &stat, const string &name) const |
| virtual bool | checkPatchStatExists (Pointer< Statistic > &stat, const string &name) const |
Friends | |
| class | StatisticRestartDatabase |
Statistic objects can be to the database or accessed in code as follows:
Pointer<Statistic> stat = Statistician::getStatistician-> getStatistic("name", "PROC_STAT");
Here `name' is the name string identifier for the statistic object and `PROC_STAT' is the type of statistic. See discussion for the getStatistic() method below for more information.
The statistic state is saved to restart files when restart file generation is active. This allows users to continue to accumulate timing information when restarting a run. If desired, all statistics can be reset when restarting by calling the function resetAllStatistics().
A variety of print options exist to dump statistics data. Notably, the printSpreadSheetOutput("print_dir") will write statistics data in a tab-separated format to files in the supplied directory name. The naming convention for statistics data is "<name>-<type>.txt" where <name> is the name of the statistic and <type> is either proc or patch stat. The files may be read in to a spreadsheet program such as MS Excel.
For more information about data that can be recorded with statistics, consult the header file for the Statistic class.
|
|
The constructor for Statistician is protected. Consistent with the definition of a Singleton class, only a statistician object can have access to the constructor for the class. |
|
|
Statistician is a Singleton class; its destructor is protected. |
|
||||||||||||
|
Create the singleton instance of the statistic manager and return a pointer to it. This function is provided so that so that users can control whether statistic information will be written to/read from restart files. The statistic restart database object is also resistered for writing subsequent restart files when the first boolean argument is true. Whether the statistic database will write statistics to restart files during program execution is determined by this argument (true by default). Regardless of the value of this argument, statistics that exist in the restart file will be read from restart when a run is restarted and the second argument is true. Generally, this routine should only be called once during program execution. If the statistician has been previously created (e.g., by an earlier call to this routine) this routine will do nothing other than return the pointer to the existing singleton instance. |
|
|
Return a pointer to the singleton statistician instance. All access to the Statistician object is through the getStatistician() function. For example, to add a statistic object with the name "my_stat" to the statistician, use the following call: Statistician::getStatistician()->addStatistic("my_stat"). |
|
|
Deallocate the Statistician instance. Note that it is not necessary to call freeStatistician() at program termination, since it is automatically called by the ShutdownRegistry class. |
|
||||||||||||
|
Return pointer to statistic object with the given name string. If a statistics with the given name already exists in the database of statistics, the statistic with that name will be returned. Otherwise, a new statistic will be created with that name. The stat_type string identifier is only used when a new statistic object must be created. The two avaible options are processor statistics and patch statistics which are indicated by the strings "PROC_STAT" and "PATCH_STAT", respectively. When assertion checking is active, an assertion will result if wither string is empty. |
|
||||||||||||
|
Return true if a statistic whose name matches the argument string exists in the database of statistics controlled by the statistician. If a match is found, the statistic pointer in the argument list is set to that statistic. Otherwise, return false and return a null pointer. If the name string is empty, a null pointer is returned. |
|
|
Return integer number of local processor statistics maintained by statistician. |
|
|
Return integer number of local patch statistics maintained by statistician. |
|
|
Reset all processor statistics to contain no information. The primary intent of this function is to avoid using restarted statistic values when performing a restarted run. However, it can be called anytime. |
|
|
Reset all patch statistics to contain no information. The primary intent of this function is to avoid using restarted statistic values when performing a restarted run. However, it can be called anytime. |
|
|
Reset all patch and processor statistics to contain no information. |
|
|
Return integer instance identifier for processor statistic with given name. If this statistician object maintains no processor statistic with that name, then a warning message results and the return value will be the invalid instance identifier "-1". |
|
|
Return number of sequence entries for processor statistic with given integer identifier. For convenience, the routine getProcStatId() is provided to map the statistic string name to the proper integer identifier. When assertion checking is active, the identifier must be valid or an assertion will result. |
|
||||||||||||||||
|
Return statistic data value for processor statistic with given integer identifier, sequence number, and processor number. For convenience, the routine getProcStatId() is provided to map the statistic string name to the proper integer identifier. The function getGlobalProcStatSequenceLength() provides the sequence length for a given processor statistic. When assertion checking is active, the identifier, sequence number, and processor number must be valid or an assertion will result. |
|
||||||||||||
|
Return global sum of processor statistic with given integer identifier and sequence number. To identify the correct integer identifier and valid sequence numbers, the method getProcStatId() maps the statistic string name to its integer identifier and the method getGlobalProcStatSequenceLength() returns the maximum sequence length for the processor statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Return global max of processor statistic with given integer identifier and sequence number. To identify the correct integer identifier and valid sequence numbers, the method getProcStatId() maps the statistic string name to its integer identifier and the method getGlobalProcStatSequenceLength() returns the maximum sequence length for the processor statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns rank of processor holding global max for the processor statistic specified by the given integer identifyer and sequence number. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Return global min of processor statistic with given integer identifier and sequence number. To identify the correct integer identifier and valid sequence numbers, the method getProcStatId() maps the statistic string name to its integer identifier and the method getGlobalProcStatSequenceLength() returns the maximum sequence length for the processor statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns rank of processor holding global max for the processor statistic specified by the given integer identifyer and sequence number. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||||||
|
Print global processor statistic data for a particular statistic to given output stream. Floating point precision may be specified (default is 12). Note that this method generates a general dump of the data but does NOT generate it in tabulated form. To generate tabulated data, see the printGlobalProcStatDataFormatted() method. |
|
||||||||||||||||
|
Print processor stat data in formatted output to given output stream. Floating point precision may be specified (default is 12). |
|
||||||||||||||||||||
|
Print stat data for specified processor in formatted output to given output stream. Floating point precision may be specified (default is 12). |
|
|
Return integer instance identifier for patch statistic with given name. If this statistician object maintains no patch statistic with that name, then a warning message results and the return value will be the invalid instance identifier "-1". |
|
|
Return number of sequence entries for patch statistic with given integer identifier. For convenience, the routine getPatchStatId() is provided to map the statistic string name to the proper integer identifier. When assertion checking is active, the identifier must be valid or an assertion will result. |
|
||||||||||||
|
Return number of patch entries for patch statistic with given integer identifier, and sequence number. For convenience, the routine getPatchStatId() is provided to map the statistic string name to the proper integer identifier. The function getGlobalPatchStatSequenceLength() provides the sequence length for a given patch statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||||||
|
Return global processor mapping for patch statistic with given integer identifier, sequence number, and patch number. For convenience, the routine getPatchStatId() is provided to map the statistic string name to the proper integer identifier. The function getGlobalPatchStatSequenceLength() provides the sequence length for a given patch statistic. The function getGlobalPatchStatNumberPatches() gives the number of patches associated with a patch statistic and sequence number. When assertion checking is active, the identifier, sequence number, and patch number must be valid or an assertion will result. |
|
||||||||||||||||
|
Return statistic data value for patch statistic with given integer identifier, sequence number, and patch number. For convenience, the routine getPatchStatId() is provided to map the statistic string name to the proper integer identifier. The function getGlobalPatchStatSequenceLength() provides the sequence length for a given patch statistic. The function getGlobalPatchStatNumberPatches() gives the number of patches associated with a patch statistic and sequence number. When assertion checking is active, the identifier, sequence number, and patch number must be valid or an assertion will result. |
|
||||||||||||
|
Return global sum of patch statistic with given integer identifier and sequence number. To identify the correct integer identifier and valid sequence numbers, the method getPatchStatId() maps the statistic string name to its integer identifier and the method getGlobalPatchStatSequenceLength() returns the maximum sequence length for the processor statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Return global max of patch statistic with given integer identifier and sequence number. To identify the correct integer identifier and valid sequence numbers, the method getPatchStatId() maps the statistic string name to its integer identifier and the method getGlobalPatchStatSequenceLength() returns the maximum sequence length for the processor statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns ID of patch holding global max for the patch statistic specified by the given integer identifyer and sequence number. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Return global min of patch statistic with given integer identifier and sequence number. To identify the correct integer identifier and valid sequence numbers, the method getPatchStatId() maps the statistic string name to its integer identifier and the method getGlobalPatchStatSequenceLength() returns the maximum sequence length for the processor statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns patch ID of patch holding global min for the patch statistic specified by the given integer identifyer and sequence number. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||||||
|
Returns the sum of patch statistic information for a particular processor. The patch statistic is specified by its integer identifyer and sequence number. When assertion checking is active, the identifier, processor id, and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the maximum value of the patch statistic data summed on each processor. That is, patch statistic information is summed on each processor, and this method returns the maximum value, across all processors, of this summed data. The patch statistic is specified by its integer identifyer and sequence number. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the processor ID which holds the maximum value of summed patch statistic information across processors. See the discussion for the method getGlobalPatchStatProcessorSumMax() for more information on the summed patch statistic information on processors. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the minimum value of the patch statistic data summed on each processor. That is, patch statistic information is summed on each processor, and this method returns the minimum value, across all processors, of this summed data. The patch statistic is specified by its integer identifyer and sequence number. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the processor ID which holds the minimum value of summed patch statistic information across processors. See the discussion for the method getGlobalPatchStatProcessorSumMin() for more information on the summed patch statistic information on processors. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||||||
|
Return number of patches on the specified processor number for patch statistic with given identifier, and sequence number. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the maximum number of patches per processor for the specified patch statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the processor ID holding the maximum number of patches per processor for the specified patch statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the minimum number of patches per processor for the specified patch statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||
|
Returns the processor ID holding the minimum number of patches per processor for the specified patch statistic. When assertion checking is active, the identifier and sequence number must be valid or an assertion will result. |
|
||||||||||||||||
|
Print global processor statistic data for a particular statistic to given output stream. Floating point precision may be specified (default is 12). Note that this method generates a general dump of the data but does NOT generate it in tabulated form. To generate tabulated data, see the printGlobalPatchStatDataFormatted() method. |
|
||||||||||||||||
|
Print patch stat data in formatted output to given output stream. Floating point precision may be specified (default is 12). |
|
|
Gather all statistic information to the statistician object on processor zero. Typically, this routine is called after a calculation has completed so that statistic data can be retrieved, analized, printed to a file, etc. It is not essential that this routine be called, however, as each "get" and "print" routine checks to see if statistic data has been finalized before it peforms its function. |
|
||||||||||||
|
Print data to given output stream for local statistics managed by this statistician object. Note that no fancy formatting is done. Floating point precision can be specified (default is 12). |
|
||||||||||||
|
Print global statistic data information to given output stream. The data will NOT be in tabulated form. Floating point precision can be specified (default is 12). |
|
||||||||||||
|
Print sums of all global statistic data information to given output stream. Floating point precision can be specified (default is 12). |
|
||||||||||||
|
Print sums of all global statistic data information to specified filename. Floating point precision can be specified (default is 12). |
|
||||||||||||
|
Write all statistics data in tab-separated format to files in the supplied directory name. The naming convention used is "<name>-<type>.txt" where <name> is the name of the statistic and <type> is either proc or patch stat. Floating point precision may be specified (default is 12). The files may be read in to a spreadsheet program such as MS Excel. If no directory name is supplied, the files will be written to the directory where the application is run. |
|
||||||||||||||||
|
Write tab-separated statistics data for specified processor. This method is identical to "printSpreadSheetOutput()" (above), but only prints data for a single processor. This may be useful for information that is the same across all processors. This method will only print processor stats. Any patch stats will be ignored. |
|
|
Initialize Singleton instance with instance of subclass. This function is used to make the singleton object unique when inheriting from this base class. |
|
|
During finalize() check statistic information on all processors for consistency before generating arrays of data. |
|
||||||||||||
|
Return true if a processor statistic whose name matches the argument string exists in the database of statistics controlled by the statistician. If a match is found, the statistic pointer in the argument list is set to that statistic. Otherwise, return false and return a null pointer. |
|
||||||||||||
|
Return true if a patch statistic whose name matches the argument string exists in the database of statistics controlled by the statistician. If a match is found, the statistic pointer in the argument list is set to that statistic. Otherwise, return false and return a null pointer. |
|
|
|
1.4.2