Function evaluate_active

Function evaluate_active_counters

hpx::evaluate_active_counters — Evaluate and output all active performance counters, optionally naming the point in code marked by this function.

Synopsis

// In header: <hpx/hpx_fwd.hpp>


void evaluate_active_counters(bool reset = false, 
                              char const * description = 0, 
                              error_code & ec = throws);

Description

Note

	Note
As long as ec is not pre-initialized to hpx::throws this function doesn't throw but returns the result code using the parameter ec. Otherwise it throws an instance of `hpx::exception`. The output generated by this function is redirected to the destination specified by the corresponding command line options (see --hpx:print-counter-destination). The active counters are those which have been specified on the command line while executing the application (see command line option --hpx:print-counter)

As long as ec is not pre-initialized to hpx::throws this function doesn't throw but returns the result code using the parameter ec. Otherwise it throws an instance of hpx::exception.

The output generated by this function is redirected to the destination specified by the corresponding command line options (see --hpx:print-counter-destination).

The active counters are those which have been specified on the command line while executing the application (see command line option --hpx:print-counter)

Parameters:

`description`	[in] this is an optional value naming the point in the code marked by the call to this function.
`ec`	[in,out] this represents the error status on exit, if this is pre-initialized to hpx::throws the function will throw on error instead.
`reset`	[in] this is an optional flag allowing to reset the counter value after it has been evaluated.