Program Listing for File ControlSampler.h

↰ Return to documentation for file (src/ompl/control/ControlSampler.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_CONTROL_CONTROL_SAMPLER_
#define OMPL_CONTROL_CONTROL_SAMPLER_

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

namespace ompl
{
    namespace control
    {
        OMPL_CLASS_FORWARD(ControlSpace);


        OMPL_CLASS_FORWARD(ControlSampler);

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

            ControlSampler(const ControlSpace *space) : space_(space)
            {
            }

            virtual ~ControlSampler() = default;

            virtual void sample(Control *control) = 0;

            virtual void sample(Control *control, const base::State *state);

            virtual void sampleNext(Control *control, const Control *previous);

            virtual void sampleNext(Control *control, const Control *previous, const base::State *state);

            virtual unsigned int sampleStepCount(unsigned int minSteps, unsigned int maxSteps);

        protected:
            const ControlSpace *space_;

            RNG rng_;
        };

        class CompoundControlSampler : public ControlSampler
        {
        public:
            CompoundControlSampler(const ControlSpace *space) : ControlSampler(space)
            {
            }

            ~CompoundControlSampler() override = default;

            virtual void addSampler(const ControlSamplerPtr &sampler);

            void sample(Control *control) override;
            void sample(Control *control, const base::State *state) override;
            void sampleNext(Control *control, const Control *previous) override;
            void sampleNext(Control *control, const Control *previous, const base::State *state) override;

        protected:
            std::vector<ControlSamplerPtr> samplers_;

        private:
            unsigned int samplerCount_;
        };

        using ControlSamplerAllocator = std::function<ControlSamplerPtr(const ControlSpace *)>;
    }  // namespace control
}  // namespace ompl

#endif