dune-pdelab  2.7-git
Public Member Functions | List of all members
Dune::PDELab::BenchmarkHelper< TimeSource > Struct Template Reference

#include <dune/pdelab/common/benchmarkhelper.hh>

Public Member Functions

 BenchmarkHelper (std::string name, std::size_t max_runs=1, TimeSource timeSource=TimeSource())
 
void start_run ()
 
void start_run (std::ostream &s)
 
void end_run ()
 
void end_run (std::ostream &s)
 
void start (std::string task)
 
void start (std::string task, std::ostream &s)
 
void end (std::string task)
 
void end (std::string task, std::ostream &s)
 
void update_entry (BenchmarkEntry &entry)
 
void update_statistics ()
 
void print_entry (std::ostream &s, std::string name, const BenchmarkEntry &entry, bool summary_only=false) const
 
void print (std::ostream &s, bool summary_only=false)
 

Constructor & Destructor Documentation

◆ BenchmarkHelper()

template<typename TimeSource = DefaultTimeSource>
Dune::PDELab::BenchmarkHelper< TimeSource >::BenchmarkHelper ( std::string  name,
std::size_t  max_runs = 1,
TimeSource  timeSource = TimeSource() 
)
inline

Member Function Documentation

◆ end() [1/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::end ( std::string  task)
inline

◆ end() [2/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::end ( std::string  task,
std::ostream &  s 
)
inline

◆ end_run() [1/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::end_run ( )
inline

◆ end_run() [2/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::end_run ( std::ostream &  s)
inline

◆ print()

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::print ( std::ostream &  s,
bool  summary_only = false 
)
inline

◆ print_entry()

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::print_entry ( std::ostream &  s,
std::string  name,
const BenchmarkEntry entry,
bool  summary_only = false 
) const
inline

◆ start() [1/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::start ( std::string  task)
inline

◆ start() [2/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::start ( std::string  task,
std::ostream &  s 
)
inline

◆ start_run() [1/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::start_run ( )
inline

◆ start_run() [2/2]

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::start_run ( std::ostream &  s)
inline

◆ update_entry()

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::update_entry ( BenchmarkEntry entry)
inline

◆ update_statistics()

template<typename TimeSource = DefaultTimeSource>
void Dune::PDELab::BenchmarkHelper< TimeSource >::update_statistics ( )
inline

The documentation for this struct was generated from the following file: