Robowflex  v0.1
Making MoveIt Easy
robowflex::PlanDataSet Class Reference

Detailed statistics about a benchmark of multiple queries. More...

#include <benchmarking.h>

Public Attributes

Timing
double time
 Total computation time for entire dataset. More...
 
boost::posix_time::ptime start
 Start time of dataset computation. More...
 
boost::posix_time::ptime finish
 End time for dataset computation. More...
 
Experiment Parameters
double allowed_time
 Allowed planning time used per query. More...
 
std::size_t trials
 Requested trials for each query. More...
 
bool enforced_single_thread
 If true, all planners were asked to run in single-threaded mode. More...
 
bool run_till_timeout
 
std::size_t threads
 Threads used for dataset computation. More...
 
Query Information
std::string name
 Name of this dataset. More...
 
std::vector< std::stringquery_names
 All unique names used by planning queries. More...
 
std::vector< PlanningQueryqueries
 

Data

std::map< std::string, std::vector< PlanDataPtr > > data
 Map of query name to collected data. More...
 
void addDataPoint (const std::string &query_name, const PlanDataPtr &run)
 Add a computed plan data under a query as a data point. More...
 
std::vector< PlanDataPtrgetFlatData () const
 Get the full data set as a flat vector. More...
 

Detailed Description

Detailed statistics about a benchmark of multiple queries.

Definition at line 140 of file benchmarking.h.

Member Function Documentation

◆ addDataPoint()

void PlanDataSet::addDataPoint ( const std::string query_name,
const PlanDataPtr run 
)

Add a computed plan data under a query as a data point.

Parameters
[in]query_nameName of query to store point under.
[in]runRun data to add to query.

PlanDataSet

Definition at line 115 of file benchmarking.cpp.

116 {
117  auto it = data.find(query_name);
118  if (it == data.end())
119  data.emplace(query_name, std::vector<PlanDataPtr>{run});
120  else
121  it->second.emplace_back(run);
122 }
std::map< std::string, std::vector< PlanDataPtr > > data
Map of query name to collected data.
Definition: benchmarking.h:177

◆ getFlatData()

std::vector< PlanDataPtr > PlanDataSet::getFlatData ( ) const

Get the full data set as a flat vector.

Returns
All plan data as a vector.

Definition at line 124 of file benchmarking.cpp.

125 {
127  for (const auto &query : data)
128  r.insert(r.end(), query.second.begin(), query.second.end());
129 
130  return r;
131 }
T end(T... args)
T insert(T... args)

Member Data Documentation

◆ allowed_time

double robowflex::PlanDataSet::allowed_time

Allowed planning time used per query.

Definition at line 155 of file benchmarking.h.

◆ data

std::map<std::string, std::vector<PlanDataPtr> > robowflex::PlanDataSet::data

Map of query name to collected data.

Definition at line 177 of file benchmarking.h.

◆ enforced_single_thread

bool robowflex::PlanDataSet::enforced_single_thread

If true, all planners were asked to run in single-threaded mode.

Definition at line 157 of file benchmarking.h.

◆ finish

boost::posix_time::ptime robowflex::PlanDataSet::finish

End time for dataset computation.

Definition at line 148 of file benchmarking.h.

◆ name

std::string robowflex::PlanDataSet::name

Name of this dataset.

Definition at line 167 of file benchmarking.h.

◆ queries

std::vector<PlanningQuery> robowflex::PlanDataSet::queries

All planning queries. Note that planning queries can share the same name.

Definition at line 169 of file benchmarking.h.

◆ query_names

std::vector<std::string> robowflex::PlanDataSet::query_names

All unique names used by planning queries.

Definition at line 168 of file benchmarking.h.

◆ run_till_timeout

bool robowflex::PlanDataSet::run_till_timeout

If true, planners were run to solve the problem as many times as possible until time ran out.

Definition at line 158 of file benchmarking.h.

◆ start

boost::posix_time::ptime robowflex::PlanDataSet::start

Start time of dataset computation.

Definition at line 147 of file benchmarking.h.

◆ threads

std::size_t robowflex::PlanDataSet::threads

Threads used for dataset computation.

Definition at line 160 of file benchmarking.h.

◆ time

double robowflex::PlanDataSet::time

Total computation time for entire dataset.

Definition at line 146 of file benchmarking.h.

◆ trials

std::size_t robowflex::PlanDataSet::trials

Requested trials for each query.

Definition at line 156 of file benchmarking.h.


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