Parasol Planning Library (PPL)
Syclop::RegionData Struct Reference

Holds all external data related to a specific workspace region. More...

#include <Syclop.h>

Collaboration diagram for Syclop::RegionData:
Collaboration graph
[legend]

Public Member Functions

Update Functions
void AddCell (size_t _index)
 Add a cell to this region's cell indexes and update alpha/weight. More...
 
void UpdateAlpha ()
 
void UpdateWeight ()
 

Internal State

double weight
 Relative probability of selecting this region from a lead. More...
 
double alpha
 The edge-weight coefficient for this region. More...
 
double freeVolume
 The estimated free state-space volume of this region. More...
 
size_t numTimesSelected {0}
 The number of times this region has been selected. More...
 
VertexSet vertices
 The VID's of the configurations in this region. More...
 
std::set< size_t > cells
 
size_t Coverage () const
 

Detailed Description

Holds all external data related to a specific workspace region.

Member Function Documentation

◆ AddCell()

void Syclop::RegionData::AddCell ( size_t  _index)
inline

Add a cell to this region's cell indexes and update alpha/weight.

◆ Coverage()

size_t Syclop::RegionData::Coverage ( ) const
inline

◆ UpdateAlpha()

void Syclop::RegionData::UpdateAlpha ( )
inline

◆ UpdateWeight()

void Syclop::RegionData::UpdateWeight ( )
inline

Field Documentation

◆ alpha

double Syclop::RegionData::alpha

The edge-weight coefficient for this region.

◆ cells

std::set<size_t> Syclop::RegionData::cells

The set of coverage cells in the target that were reached from the source.

◆ freeVolume

double Syclop::RegionData::freeVolume

The estimated free state-space volume of this region.

◆ numTimesSelected

size_t Syclop::RegionData::numTimesSelected {0}

The number of times this region has been selected.

◆ vertices

VertexSet Syclop::RegionData::vertices

The VID's of the configurations in this region.

◆ weight

double Syclop::RegionData::weight

Relative probability of selecting this region from a lead.


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