Program Listing for File GeneticSearch.h

↰ Return to documentation for file (src/ompl/geometric/GeneticSearch.h)

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2008, Willow Garage, Inc.
 *  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 Willow Garage 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_GEOMETRIC_GENETIC_SEARCH_
#define OMPL_GEOMETRIC_GENETIC_SEARCH_

#include "ompl/base/SpaceInformation.h"
#include "ompl/base/goals/GoalRegion.h"
#include "ompl/geometric/HillClimbing.h"
#include "ompl/util/Console.h"

namespace ompl
{
    namespace geometric
    {
        class GeneticSearch
        {
        public:
            GeneticSearch(const base::SpaceInformationPtr &si);
            ~GeneticSearch();

            bool solve(double solveTime, const base::GoalRegion &goal, base::State *result,
                       const std::vector<base::State *> &hint = std::vector<base::State *>());

            void setMaxImproveSteps(unsigned int maxSteps)
            {
                hc_.setMaxImproveSteps(maxSteps);
            }

            unsigned int getMaxImproveSteps() const
            {
                return hc_.getMaxImproveSteps();
            }

            void setValidityCheck(bool valid)
            {
                checkValidity_ = valid;
                hc_.setValidityCheck(valid);
            }

            bool getValidityCheck() const
            {
                return checkValidity_;
            }

            void setTryImprove(bool flag)
            {
                tryImprove_ = flag;
            }

            bool getTryImprove() const
            {
                return tryImprove_;
            }

            void setPoolSize(unsigned int size)
            {
                poolSize_ = size;
            }

            unsigned int getPoolSize() const
            {
                return poolSize_;
            }

            void setPoolMutationSize(unsigned int size)
            {
                poolMutation_ = size;
            }

            unsigned int getPoolMutationSize() const
            {
                return poolMutation_;
            }

            void setPoolRandomSize(unsigned int size)
            {
                poolRandom_ = size;
            }

            unsigned int getPoolRandomSize() const
            {
                return poolRandom_;
            }

            void setRange(double distance)
            {
                maxDistance_ = distance;
            }

            double getRange() const
            {
                return maxDistance_;
            }

            void clear();

        private:
            void tryToImprove(const base::GoalRegion &goal, base::State *state, double distance);

            bool valid(const base::State *state) const
            {
                return checkValidity_ ? si_->isValid(state) : true;
            }

            struct Individual
            {
                base::State *state;
                double distance;
                bool valid;
            };

            struct IndividualSort
            {
                bool operator()(const Individual &a, const Individual &b)
                {
                    if (a.valid == b.valid)
                        return a.distance < b.distance;
                    return a.valid;
                }
            };

            HillClimbing hc_;
            base::SpaceInformationPtr si_;
            base::StateSamplerPtr sampler_;
            std::vector<Individual> pool_;
            unsigned int poolSize_;
            unsigned int poolMutation_;
            unsigned int poolRandom_;
            unsigned int generations_;
            bool checkValidity_;
            bool tryImprove_;

            double maxDistance_;
        };
    }  // namespace geometric
}  // namespace ompl

#endif