Parasol Planning Library (PPL)
Public Member Functions
DynamicRegionsPRM::ExpansionRegion Struct Reference

Representation of an expansion region. More...

#include <DynamicRegionsPRM.h>

Public Member Functions

 ExpansionRegion (const SkeletonEdgeIterator &_eit, const VID _representative)
 
void TrackSuccess (const size_t _success, const size_t _attempts)
 Track the success rate of extending into this region. More...
 
double GetWeight () const noexcept
 Compute the weight for this region (i.e. success rate). More...
 
const Vector3d & GetCenter () const noexcept
 Get the center of this region. More...
 
bool LastPoint () const noexcept
 Check if this region is at the last point on its skeleton edge. More...
 
void Advance () noexcept
 Advance this region to the next skeleton edge point. More...
 
LocalComponentDescriptor GetLocalComponentDescriptor () const noexcept
 Get the descriptor for the local component this region is expanding. More...
 

Data Fields

Internal State
const SkeletonEdgeIterator edgeIterator
 Iterator to region's edge. More...
 
VID representative {INVALID_VID}
 Representative roadmap vertex. More...
 
size_t edgeIndex {0}
 Which edge point are we at? More...
 
double attempts {1}
 Number of attempts to extend into this region. More...
 
double successes {0}
 Number of successful attempts. More...
 

Detailed Description

Representation of an expansion region.

Constructor & Destructor Documentation

◆ ExpansionRegion()

DynamicRegionsPRM::ExpansionRegion::ExpansionRegion ( const SkeletonEdgeIterator _eit,
const VID  _representative 
)
inline

Member Function Documentation

◆ Advance()

void DynamicRegionsPRM::ExpansionRegion::Advance ( )
inlinenoexcept

Advance this region to the next skeleton edge point.

◆ GetCenter()

const Vector3d& DynamicRegionsPRM::ExpansionRegion::GetCenter ( ) const
inlinenoexcept

Get the center of this region.

◆ GetLocalComponentDescriptor()

LocalComponentDescriptor DynamicRegionsPRM::ExpansionRegion::GetLocalComponentDescriptor ( ) const
inlinenoexcept

Get the descriptor for the local component this region is expanding.

◆ GetWeight()

double DynamicRegionsPRM::ExpansionRegion::GetWeight ( ) const
inlinenoexcept

Compute the weight for this region (i.e. success rate).

◆ LastPoint()

bool DynamicRegionsPRM::ExpansionRegion::LastPoint ( ) const
inlinenoexcept

Check if this region is at the last point on its skeleton edge.

◆ TrackSuccess()

void DynamicRegionsPRM::ExpansionRegion::TrackSuccess ( const size_t  _success,
const size_t  _attempts 
)
inline

Track the success rate of extending into this region.

Field Documentation

◆ attempts

double DynamicRegionsPRM::ExpansionRegion::attempts {1}

Number of attempts to extend into this region.

◆ edgeIndex

size_t DynamicRegionsPRM::ExpansionRegion::edgeIndex {0}

Which edge point are we at?

◆ edgeIterator

const SkeletonEdgeIterator DynamicRegionsPRM::ExpansionRegion::edgeIterator

Iterator to region's edge.

◆ representative

VID DynamicRegionsPRM::ExpansionRegion::representative {INVALID_VID}

Representative roadmap vertex.

◆ successes

double DynamicRegionsPRM::ExpansionRegion::successes {0}

Number of successful attempts.


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