ParameterExponentialDecay.h
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2020,
5  * Max Planck Institute for Intelligent Systems (MPI-IS).
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of the MPI-IS nor the names
19  * of its contributors may be used to endorse or promote products
20  * derived from this software without specific prior written
21  * permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *********************************************************************/
36 
37 /* Author: Andreas Orthey */
38 
39 #ifndef OMPL_MULTILEVEL_PLANNERS_BUNDLESPACE_DATASTRUCTURES_EXPONENTIAL_DECAY__
40 #define OMPL_MULTILEVEL_PLANNERS_BUNDLESPACE_DATASTRUCTURES_EXPONENTIAL_DECAY__
41 
42 #include <ompl/util/Exception.h>
43 #include <ompl/multilevel/datastructures/Parameter.h>
44 
45 namespace ompl
46 {
51  class ParameterExponentialDecay : public Parameter
52  {
53  public:
54  ParameterExponentialDecay() = default;
55 
56  ParameterExponentialDecay(double lambda) : Parameter(), lambda_(lambda)
57  {
58  setLambda(lambda);
59  };
60 
61  ParameterExponentialDecay(double lambda, double valueInit) : Parameter(valueInit), lambda_(lambda)
62  {
63  setLambda(lambda);
64  };
65 
66  ParameterExponentialDecay(double lambda, double valueInit, double valueTarget)
67  : Parameter(valueInit, valueTarget), lambda_(lambda)
68  {
69  setLambda(lambda);
70  };
71 
73  void setLambda(double lambda)
74  {
75  if (lambda < 0)
76  {
77  throw ompl::Exception("ExponentialDecay requires non-negative lambda");
78  }
79  else
80  {
81  lambda_ = lambda;
82  }
83  }
84 
86  double operator()(void)
87  {
88  double value = (getValueInit() - getValueTarget()) * exp(-lambda_ * getCounter()) + getValueTarget();
90  return value;
91  }
92 
93  private:
95  double lambda_{0.1};
96  };
97 }
98 #endif
unsigned long long getCounter()
Get current counter.
Definition: Parameter.h:191
void incrementCounter()
Increment counter.
Definition: Parameter.h:196
double operator()(void)
Evaluate exponential decay at counter.
double getValueTarget()
Get target value.
Definition: Parameter.h:155
void setLambda(double lambda)
Set lambda decay parameter (default: 0.1)
The exception type for ompl.
Definition: Exception.h:78
Main namespace. Contains everything in this library.
Definition: AppBase.h:21
double getValueInit()
Get init value.
Definition: Parameter.h:150