Loading...
Searching...
No Matches
ompl::tools::Benchmark::CompleteExperiment Struct Reference

This structure holds experimental data for a set of planners. More...

#include <ompl/tools/benchmark/Benchmark.h>

Public Attributes

std::string name
 The name of the experiment.
 
std::vector< PlannerExperimentplanners
 The collected experimental data; each element of the array (an experiment) corresponds to a planner.
 
double maxTime
 The maximum allowed time for planner computation during the experiment (seconds)
 
double maxMem
 The maximum allowed memory for planner computation during the experiment (MB)
 
unsigned int runCount
 The number of runs to execute for each planner.
 
time::point startTime
 The point in time when the experiment was started.
 
double totalDuration
 The amount of time spent to collect the information in this structure (seconds)
 
std::string setupInfo
 The output of SimpleSetup::print() before the experiment was started.
 
std::uint_fast32_t seed
 The random seed that was used at the start of the benchmark program.
 
std::string host
 Hostname that identifies the machine the benchmark ran on.
 
std::string cpuInfo
 Information about the CPU of the machine the benchmark ran on.
 
std::map< std::string, std::string > parameters
 Additional, experiment specific parameters. This is optional.
 

Detailed Description

This structure holds experimental data for a set of planners.

Definition at line 116 of file Benchmark.h.

Member Data Documentation

◆ cpuInfo

std::string ompl::tools::Benchmark::CompleteExperiment::cpuInfo

Information about the CPU of the machine the benchmark ran on.

Definition at line 149 of file Benchmark.h.

◆ host

std::string ompl::tools::Benchmark::CompleteExperiment::host

Hostname that identifies the machine the benchmark ran on.

Definition at line 146 of file Benchmark.h.

◆ maxMem

double ompl::tools::Benchmark::CompleteExperiment::maxMem

The maximum allowed memory for planner computation during the experiment (MB)

Definition at line 128 of file Benchmark.h.

◆ maxTime

double ompl::tools::Benchmark::CompleteExperiment::maxTime

The maximum allowed time for planner computation during the experiment (seconds)

Definition at line 125 of file Benchmark.h.

◆ name

std::string ompl::tools::Benchmark::CompleteExperiment::name

The name of the experiment.

Definition at line 119 of file Benchmark.h.

◆ parameters

std::map<std::string, std::string> ompl::tools::Benchmark::CompleteExperiment::parameters

Additional, experiment specific parameters. This is optional.

Definition at line 152 of file Benchmark.h.

◆ planners

std::vector<PlannerExperiment> ompl::tools::Benchmark::CompleteExperiment::planners

The collected experimental data; each element of the array (an experiment) corresponds to a planner.

Definition at line 122 of file Benchmark.h.

◆ runCount

unsigned int ompl::tools::Benchmark::CompleteExperiment::runCount

The number of runs to execute for each planner.

Definition at line 131 of file Benchmark.h.

◆ seed

std::uint_fast32_t ompl::tools::Benchmark::CompleteExperiment::seed

The random seed that was used at the start of the benchmark program.

Definition at line 143 of file Benchmark.h.

◆ setupInfo

std::string ompl::tools::Benchmark::CompleteExperiment::setupInfo

The output of SimpleSetup::print() before the experiment was started.

Definition at line 140 of file Benchmark.h.

◆ startTime

time::point ompl::tools::Benchmark::CompleteExperiment::startTime

The point in time when the experiment was started.

Definition at line 134 of file Benchmark.h.

◆ totalDuration

double ompl::tools::Benchmark::CompleteExperiment::totalDuration

The amount of time spent to collect the information in this structure (seconds)

Definition at line 137 of file Benchmark.h.


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