OPTK  0.1.2
Toolkit for global optimisation algorithms
Public Member Functions | Private Attributes | List of all members
optk::benchmarks Class Reference

#include <benchmark.hpp>

Public Member Functions

 ~benchmarks ()
 
void register_benchmark (benchmark_set *b)
 
optk::bench_list * collection ()
 

Private Attributes

bench_list m_arr
 

Detailed Description

This represents a collection of benchmarks; either all those known to OPTK, or a subset of those such as those selected by a user from command line arguments.

Constructor & Destructor Documentation

◆ ~benchmarks()

optk::benchmarks::~benchmarks ( )

This destructor will free the memory for any registered benchmark sets.

Member Function Documentation

◆ collection()

optk::bench_list * optk::benchmarks::collection ( )
Returns
The collection of benchmarks held by this class

◆ register_benchmark()

void optk::benchmarks::register_benchmark ( optk::benchmark_set b)

The reigster function allows you to tell the main runner about the existence of a benchmark.

Parameters
bThe benchmark to register

Member Data Documentation

◆ m_arr

bench_list optk::benchmarks::m_arr
private

The array of benchmarks in this collection


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