geopm  3.1.1.dev214+gba4f9f6d
GEOPM - Global Extensible Open Power Manager
Public Member Functions | List of all members
geopm::EditDistPeriodicityDetector Class Reference

#include <EditDistPeriodicityDetector.hpp>

Public Member Functions

 EditDistPeriodicityDetector (int history_buffer_size)
 Default constructor for String Edit Distance based periodicity detector used in EditDistEpochRecordFilter. More...
 
virtual ~EditDistPeriodicityDetector ()=default
 
void update (const record_s &record)
 Update detector with a new record from the application. More...
 
int get_period (void) const
 Return the best estimate of the period length in number of records, based on the data inserted through update(). Until a stable period is determined, returns -1. More...
 
int get_score (void) const
 Return the metric that will be maximized to determine the period. Until a stable period is determined, returns -1. More...
 
int num_records (void) const
 Return the number of records that this object has received so far via update(). More...
 

Constructor & Destructor Documentation

◆ EditDistPeriodicityDetector()

geopm::EditDistPeriodicityDetector::EditDistPeriodicityDetector ( int  history_buffer_size)

Default constructor for String Edit Distance based periodicity detector used in EditDistEpochRecordFilter.

Parameters
[in]history_buffer_sizeNumber of region entry events stored in order to determine an epoch.

◆ ~EditDistPeriodicityDetector()

virtual geopm::EditDistPeriodicityDetector::~EditDistPeriodicityDetector ( )
virtualdefault

Member Function Documentation

◆ get_period()

int geopm::EditDistPeriodicityDetector::get_period ( void  ) const

Return the best estimate of the period length in number of records, based on the data inserted through update(). Until a stable period is determined, returns -1.

◆ get_score()

int geopm::EditDistPeriodicityDetector::get_score ( void  ) const

Return the metric that will be maximized to determine the period. Until a stable period is determined, returns -1.

◆ num_records()

int geopm::EditDistPeriodicityDetector::num_records ( void  ) const

Return the number of records that this object has received so far via update().

◆ update()

void geopm::EditDistPeriodicityDetector::update ( const record_s record)

Update detector with a new record from the application.


The documentation for this class was generated from the following files: