Program Listing for File StateSampler.h

↰ Return to documentation for file (src/ompl/base/StateSampler.h)

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2010, Rice University
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the Rice University nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *********************************************************************/

/* Author: Ioan Sucan */

#ifndef OMPL_BASE_STATE_SAMPLER_
#define OMPL_BASE_STATE_SAMPLER_

#include "ompl/base/State.h"
#include "ompl/util/RandomNumbers.h"
#include "ompl/util/ClassForward.h"
#include <vector>
#include <string>
#include <functional>

namespace ompl
{
    namespace base
    {
        OMPL_CLASS_FORWARD(StateSpace);


        OMPL_CLASS_FORWARD(StateSampler);

        class StateSampler
        {
        public:
            // non-copyable
            StateSampler(const StateSampler &) = delete;
            StateSampler &operator=(const StateSampler &) = delete;

            StateSampler(const StateSpace *space) : space_(space)
            {
            }

            virtual ~StateSampler() = default;

            virtual void sampleUniform(State *state) = 0;

            virtual void sampleUniformNear(State *state, const State *near, double distance) = 0;

            virtual void sampleGaussian(State *state, const State *mean, double stdDev) = 0;

        protected:
            const StateSpace *space_;

            RNG rng_;
        };

        class CompoundStateSampler : public StateSampler
        {
        public:
            CompoundStateSampler(const StateSpace *space) : StateSampler(space), samplerCount_(0)
            {
            }

            ~CompoundStateSampler() override = default;

            virtual void addSampler(const StateSamplerPtr &sampler, double weightImportance);

            void sampleUniform(State *state) override;

            void sampleUniformNear(State *state, const State *near, double distance) override;

            void sampleGaussian(State *state, const State *mean, double stdDev) override;

        protected:
            std::vector<StateSamplerPtr> samplers_;

            std::vector<double> weightImportance_;

        private:
            unsigned int samplerCount_;
        };

        class SubspaceStateSampler : public StateSampler
        {
        public:
            SubspaceStateSampler(const StateSpace *space, const StateSpace *subspace, double weight);
            ~SubspaceStateSampler() override;

            void sampleUniform(State *state) override;

            void sampleUniformNear(State *state, const State *near, double distance) override;

            void sampleGaussian(State *state, const State *mean, double stdDev) override;

        protected:
            const StateSpace *subspace_;

            StateSamplerPtr subspaceSampler_;

            double weight_;

            std::vector<std::string> subspaces_;

        private:
            State *work_;

            State *work2_;
        };

        using StateSamplerAllocator = std::function<StateSamplerPtr(const StateSpace *)>;
    }  // namespace base
}  // namespace ompl

#endif