#include <benchmark.hpp>

Inheritance diagram for optk::benchmark_set:

Public Member Functions
	benchmark_set (const std::string &n)

virtual	~benchmark_set ()

virtual void	run (optk::optimisers opts, optk::ctx_t ctx)=0

std::string	get_name ()

Private Attributes
std::string	m_name

Detailed Description

A benchmark set contains a collection of one or more optk::benckmark and a single evaluation function (run), which runs the entire benchmark set. This captures the idea that different benchmarks need to be run in different ways or with different configurations.

Constructor & Destructor Documentation

◆ benchmark_set()

optk::benchmark_set::benchmark_set ( const std::string & n )

inline

The constructor for a benchmark set

Parameters

n	The name should capture the commonalities between the benchmarks in this set.

◆ ~benchmark_set()

optk::benchmark_set::~benchmark_set ( )

virtual

Virtual destructor allows derived classes to be deleted correctly.

Member Function Documentation

◆ run()

virtual void optk::benchmark_set::run	(	optk::optimisers *	opts,
		optk::ctx_t *	ctx
	)

pure virtual

This is used to run all the optimisers in the set on the benchmarks.

Parameters

The	optimiser(s) to run on each benchmark.

Todo:: should this simply be a vector of optk::optimiser?

Implemented in syn::synthetic_benchmark.

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

includes/optk/benchmark.hpp
src/benchmark.cpp