RejectionInfSampler.h
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2014, University of Toronto
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the University of Toronto nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 /* Authors: Jonathan Gammell */
36 
37 #ifndef OMPL_BASE_SAMPLERS_INFORMED_GENERAL_REJECTION_INFORMED_SAMPLER_
38 #define OMPL_BASE_SAMPLERS_INFORMED_GENERAL_REJECTION_INFORMED_SAMPLER_
39 
40 // We inherit from InformedStateSampler
41 #include "ompl/base/samplers/InformedStateSampler.h"
42 
43 namespace ompl
44 {
45  namespace base
46  {
53  class RejectionInfSampler : public InformedSampler
54  {
55  public:
58  RejectionInfSampler(const ProblemDefinitionPtr &probDefn, unsigned int maxNumberCalls);
59  ~RejectionInfSampler() override = default;
60 
64  bool sampleUniform(State *statePtr, const Cost &maxCost) override;
65 
69  bool sampleUniform(State *statePtr, const Cost &minCost, const Cost &maxCost) override;
70 
72  bool hasInformedMeasure() const override;
73 
77  double getInformedMeasure(const Cost & /*currentCost*/) const override;
78 
82  double getInformedMeasure(const Cost & /*minCost*/, const Cost & /*maxCost*/) const override;
83 
84  private:
85  // Variables
87  StateSamplerPtr baseSampler_;
88 
91  bool sampleUniform(State *statePtr, const Cost &maxCost, unsigned int *iterPtr);
92  };
93  }
94 }
95 
96 #endif // OMPL_BASE_SAMPLERS_INFORMED_REJECTION_INFORMED_SAMPLER_
bool sampleUniform(State *statePtr, const Cost &maxCost) override
Sample uniformly in the subset of the state space whose heuristic solution estimates are less than th...
A shared pointer wrapper for ompl::base::ProblemDefinition.
RejectionInfSampler(const ProblemDefinitionPtr &probDefn, unsigned int maxNumberCalls)
Construct a rejection sampler that only generates states with a heuristic solution estimate that is l...
A shared pointer wrapper for ompl::base::StateSampler.
double getInformedMeasure(const Cost &) const override
The measure of the subset of the state space defined by the current solution cost that is being searc...
Main namespace. Contains everything in this library.
bool hasInformedMeasure() const override
Whether the sampler can provide a measure of the informed subset.