geopm  3.1.1.dev272+gdfb40a8d
GEOPM - Global Extensible Open Power Manager
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
geopm::ModelRegion Class Referenceabstract

#include <ModelRegion.hpp>

Inheritance diagram for geopm::ModelRegion:
Inheritance graph
[legend]

Public Member Functions

 ModelRegion (int verbosity)
 
virtual ~ModelRegion ()
 
std::string name (void)
 
double big_o (void)
 
virtual void region (void)
 
virtual void region (uint64_t hint)
 
virtual void region_enter (void)
 
virtual void region_exit (void)
 
virtual void loop_enter (uint64_t iteration)
 
virtual void loop_exit (void)
 
virtual void big_o (double big_o_in)=0
 
virtual void run (void)=0
 

Static Public Member Functions

static std::unique_ptr< ModelRegionmodel_region (const std::string &name, double big_o, int verbosity)
 

Protected Member Functions

virtual void num_progress_updates (double big_o_in)
 

Static Protected Member Functions

static bool name_check (const std::string &name, const std::string &key)
 

Protected Attributes

std::string m_name
 
double m_big_o
 
int m_verbosity
 
uint64_t m_region_id
 
bool m_do_imbalance
 
bool m_do_progress
 
bool m_do_unmarked
 
uint64_t m_num_progress_updates
 
double m_norm
 

Constructor & Destructor Documentation

◆ ModelRegion()

geopm::ModelRegion::ModelRegion ( int  verbosity)

◆ ~ModelRegion()

geopm::ModelRegion::~ModelRegion ( )
virtual

Member Function Documentation

◆ big_o() [1/2]

virtual void geopm::ModelRegion::big_o ( double  big_o_in)
pure virtual

◆ big_o() [2/2]

double geopm::ModelRegion::big_o ( void  )

◆ loop_enter()

void geopm::ModelRegion::loop_enter ( uint64_t  iteration)
virtual

◆ loop_exit()

void geopm::ModelRegion::loop_exit ( void  )
virtual

◆ model_region()

std::unique_ptr< ModelRegion > geopm::ModelRegion::model_region ( const std::string &  name,
double  big_o,
int  verbosity 
)
static

◆ name()

std::string geopm::ModelRegion::name ( void  )

◆ name_check()

bool geopm::ModelRegion::name_check ( const std::string &  name,
const std::string &  key 
)
staticprotected

◆ num_progress_updates()

void geopm::ModelRegion::num_progress_updates ( double  big_o_in)
protectedvirtual

◆ region() [1/2]

void geopm::ModelRegion::region ( uint64_t  hint)
virtual

◆ region() [2/2]

void geopm::ModelRegion::region ( void  )
virtual

◆ region_enter()

void geopm::ModelRegion::region_enter ( void  )
virtual

◆ region_exit()

void geopm::ModelRegion::region_exit ( void  )
virtual

◆ run()

virtual void geopm::ModelRegion::run ( void  )
pure virtual

Member Data Documentation

◆ m_big_o

double geopm::ModelRegion::m_big_o
protected

◆ m_do_imbalance

bool geopm::ModelRegion::m_do_imbalance
protected

◆ m_do_progress

bool geopm::ModelRegion::m_do_progress
protected

◆ m_do_unmarked

bool geopm::ModelRegion::m_do_unmarked
protected

◆ m_name

std::string geopm::ModelRegion::m_name
protected

◆ m_norm

double geopm::ModelRegion::m_norm
protected

◆ m_num_progress_updates

uint64_t geopm::ModelRegion::m_num_progress_updates
protected

◆ m_region_id

uint64_t geopm::ModelRegion::m_region_id
protected

◆ m_verbosity

int geopm::ModelRegion::m_verbosity
protected

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