Class clsparseTimer

src/include/clsparseTimer.hpp:46–120

* \brief Counter that provides a fairly accurate timing mechanism for both * windows and linux. This timer is used extensively in all the samples. */

 * windows and linux. This timer is used extensively in all the samples.
 */
class clsparseTimer
{
protected:

    /*!
     * \brief Destructor for StatisticalTimer that cleans up the class
     */
    virtual ~clsparseTimer( )
    {
    };

public:
    /*!
     * \brief Start a timing sample
     */
    virtual void Start( size_t id ) = 0;

    /*!
     * \brief Stop a timing sample
     */
    virtual void Stop( size_t id ) = 0;

    /*!
     * \brief Clear all internal data structures, deallocate all memory
     */
    virtual void Clear( ) = 0;

    /*!
    * \brief Clear all internal data structures, freeing all memory, then reallocate
    * the same amount of memory requested with Reserve
    */
    virtual void Reset( ) = 0;

    /*!
     * \brief The implementation of the timing class may contains data structures
     * that need to grow as more samples are collected.
     * \details This function allows the client to specify to the timing class an
     * estimate for the amount of memory required for the duration of the benchmark
     * \param[in] nEvents  An event is an independent timing location of benchmark interest, such as 
     * two different functions
     * \param[in] nSamples  The number of samples that associated with an event, often a loop-count
     */
    virtual void Reserve( size_t nEvents, size_t nSamples ) = 0;

    /*!
    * \brief Provide a mapping from a 'friendly' human readable text string to an index 
    * into internal data structures
    * \param[in] label  Human readable string to textually identify the event
    * \param[in] groupID  A number paired with the string to differentiate identical strings
    */
    virtual size_t getUniqueID( const std::string& label, cl_uint groupID ) = 0;

    /*!
    * \brief Request that the timer divides total samples collected by sample frequency,
    * converting tick counts into seconds
    * \param[in] norm  True value will divide return result by frequency
    */
    virtual void setNormalize( bool norm ) = 0;