Loading...
Searching...
No Matches
ompl::ParameterExponentialDecay Class Reference

ParameterExponentialDecay represents a smooth interpolation between two parameter values using an exponential decay as interpolation. This decay depends on a paramter lambda, which can be tuned to either converge slow or fast to valueTarget. More...

#include <ompl/multilevel/datastructures/ParameterExponentialDecay.h>

Inheritance diagram for ompl::ParameterExponentialDecay:

Public Member Functions

 ParameterExponentialDecay (double lambda)
 
 ParameterExponentialDecay (double lambda, double valueInit)
 
 ParameterExponentialDecay (double lambda, double valueInit, double valueTarget)
 
void setLambda (double lambda)
 Set lambda decay parameter (default: 0.1)
 
double operator() (void)
 Evaluate exponential decay at counter.
 
- Public Member Functions inherited from ompl::Parameter
 Parameter (double valueInit)
 
 Parameter (double valueInit, double valueTarget)
 
void setValueInit (double valueInit)
 Set initial value (default: 0.0)
 
void setValueTarget (double valueTarget)
 Set target value (default: 1.0)
 
void setCounterInit (unsigned long long counterInit)
 Set counter init value (default: 0)
 
void setCounterTarget (unsigned long long counterTarget)
 Set counter target value (default: 100)
 
double getValueInit ()
 Get init value.
 
double getValueTarget ()
 Get target value.
 
unsigned long long getCounterInit ()
 Get counter init value.
 
unsigned long long getCounterTarget ()
 Get counter target value.
 
double operator() (void)
 Call parameter and increase counter.
 
void reset ()
 Reset counter to init counter.
 
unsigned long long getCounter ()
 Get current counter.
 
void incrementCounter ()
 Increment counter.
 

Detailed Description

ParameterExponentialDecay represents a smooth interpolation between two parameter values using an exponential decay as interpolation. This decay depends on a paramter lambda, which can be tuned to either converge slow or fast to valueTarget.

Definition at line 51 of file ParameterExponentialDecay.h.

Constructor & Destructor Documentation

◆ ParameterExponentialDecay() [1/3]

ompl::ParameterExponentialDecay::ParameterExponentialDecay ( double lambda)
inline

Definition at line 56 of file ParameterExponentialDecay.h.

◆ ParameterExponentialDecay() [2/3]

ompl::ParameterExponentialDecay::ParameterExponentialDecay ( double lambda,
double valueInit )
inline

Definition at line 61 of file ParameterExponentialDecay.h.

◆ ParameterExponentialDecay() [3/3]

ompl::ParameterExponentialDecay::ParameterExponentialDecay ( double lambda,
double valueInit,
double valueTarget )
inline

Definition at line 66 of file ParameterExponentialDecay.h.

Member Function Documentation

◆ operator()()

double ompl::ParameterExponentialDecay::operator() ( void )
inline

Evaluate exponential decay at counter.

Definition at line 86 of file ParameterExponentialDecay.h.

◆ setLambda()

void ompl::ParameterExponentialDecay::setLambda ( double lambda)
inline

Set lambda decay parameter (default: 0.1)

Definition at line 73 of file ParameterExponentialDecay.h.


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