Representation of a benchmark request. More...
#include <ompl/tools/benchmark/Benchmark.h>
Public Member Functions | |
Request (double maxTime=5.0, double maxMem=4096.0, unsigned int runCount=100, double timeBetweenUpdates=0.05, bool displayProgress=true, bool saveConsoleOutput=true, bool simplify=true) | |
Constructor that provides default values for all members. More... | |
Public Attributes | |
double | maxTime |
the maximum amount of time a planner is allowed to run (seconds); 5.0 by default More... | |
double | maxMem |
the maximum amount of memory a planner is allowed to use (MB); 4096.0 by default More... | |
unsigned int | runCount |
the number of times to run each planner; 100 by default If set to 0, then run each planner as many times as possible with maxTime total time limit More... | |
double | timeBetweenUpdates |
When collecting time-varying data from a planner during its execution, the planner's progress will be queried every timeBetweenUpdates seconds. More... | |
bool | displayProgress |
flag indicating whether progress is to be displayed or not; true by default More... | |
bool | saveConsoleOutput |
flag indicating whether console output is saved (in an automatically generated filename); true by default More... | |
bool | simplify |
flag indicating whether simplification should be applied to path; true by default More... | |
Detailed Description
Representation of a benchmark request.
Definition at line 156 of file Benchmark.h.
Constructor & Destructor Documentation
◆ Request()
|
inline |
Constructor that provides default values for all members.
Definition at line 159 of file Benchmark.h.
Member Data Documentation
◆ displayProgress
bool ompl::tools::Benchmark::Request::displayProgress |
flag indicating whether progress is to be displayed or not; true by default
Definition at line 187 of file Benchmark.h.
◆ maxMem
double ompl::tools::Benchmark::Request::maxMem |
the maximum amount of memory a planner is allowed to use (MB); 4096.0 by default
Definition at line 176 of file Benchmark.h.
◆ maxTime
double ompl::tools::Benchmark::Request::maxTime |
the maximum amount of time a planner is allowed to run (seconds); 5.0 by default
Definition at line 173 of file Benchmark.h.
◆ runCount
unsigned int ompl::tools::Benchmark::Request::runCount |
the number of times to run each planner; 100 by default If set to 0, then run each planner as many times as possible with maxTime total time limit
Definition at line 180 of file Benchmark.h.
◆ saveConsoleOutput
bool ompl::tools::Benchmark::Request::saveConsoleOutput |
flag indicating whether console output is saved (in an automatically generated filename); true by default
Definition at line 191 of file Benchmark.h.
◆ simplify
bool ompl::tools::Benchmark::Request::simplify |
flag indicating whether simplification should be applied to path; true by default
Definition at line 194 of file Benchmark.h.
◆ timeBetweenUpdates
double ompl::tools::Benchmark::Request::timeBetweenUpdates |
When collecting time-varying data from a planner during its execution, the planner's progress will be queried every timeBetweenUpdates
seconds.
Definition at line 184 of file Benchmark.h.
The documentation for this struct was generated from the following file:
- ompl/tools/benchmark/Benchmark.h