Program Listing for File BiTRRT.h

↰ Return to documentation for file (src/ompl/geometric/planners/rrt/BiTRRT.h)

/*********************************************************************
* Software License Agreement (BSD License)
*
*  Copyright (c) 2015, 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: Ryan Luna */

#ifndef OMPL_GEOMETRIC_PLANNERS_RRT_BITRRT_
#define OMPL_GEOMETRIC_PLANNERS_RRT_BITRRT_

#include <cmath>
#include "ompl/geometric/planners/PlannerIncludes.h"
#include "ompl/datastructures/NearestNeighbors.h"
#include "ompl/base/OptimizationObjective.h"

namespace ompl
{
    namespace geometric
    {

        class BiTRRT : public base::Planner
        {
        public:
            BiTRRT(const base::SpaceInformationPtr &si);
            ~BiTRRT() override;
            void clear() override;
            void setup() override;
            void getPlannerData(base::PlannerData &data) const override;
            base::PlannerStatus solve(const base::PlannerTerminationCondition &ptc) override;

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

            double getRange() const
            {
                return maxDistance_;
            }

            void setTempChangeFactor(double factor)
            {
                tempChangeFactor_ = exp(factor);
            }

            double getTempChangeFactor() const
            {
                return log(tempChangeFactor_);
            }

            void setCostThreshold(double maxCost)
            {
                costThreshold_ = base::Cost(maxCost);
            }

            double getCostThreshold() const
            {
                return costThreshold_.value();
            }

            void setInitTemperature(double initTemperature)
            {
                initTemperature_ = initTemperature;
            }

            double getInitTemperature() const
            {
                return initTemperature_;
            }

            void setFrontierThreshold(double frontierThreshold)
            {
                frontierThreshold_ = frontierThreshold;
            }

            double getFrontierThreshold() const
            {
                return frontierThreshold_;
            }

            void setFrontierNodeRatio(double frontierNodeRatio)
            {
                frontierNodeRatio_ = frontierNodeRatio;
            }

            double getFrontierNodeRatio() const
            {
                return frontierNodeRatio_;
            }

            template <template <typename T> class NN>
            void setNearestNeighbors()
            {
                if ((tStart_ && tStart_->size() != 0) || (tGoal_ && tGoal_->size() != 0))
                    OMPL_WARN("Calling setNearestNeighbors will clear all states.");
                clear();
                tStart_ = std::make_shared<NN<Motion *>>();
                tGoal_ = std::make_shared<NN<Motion *>>();
                setup();
            }

        protected:
            class Motion
            {
            public:
                Motion() = default;

                Motion(const base::SpaceInformationPtr &si) : state(si->allocState())
                {
                }

                ~Motion() = default;

                base::State *state{nullptr};

                Motion *parent{nullptr};

                base::Cost cost;

                const base::State *root{nullptr};
            };

            void freeMemory();

            using TreeData = std::shared_ptr<NearestNeighbors<Motion *>>;

            Motion *addMotion(const base::State *state, TreeData &tree, Motion *parent = nullptr);

            bool transitionTest(const base::Cost &motionCost);

            bool minExpansionControl(double dist);

            enum GrowResult
            {
                FAILED,
                ADVANCED,
                SUCCESS
            };

            GrowResult extendTree(Motion *toMotion, TreeData &tree, Motion *&result);

            GrowResult extendTree(Motion *nearest, TreeData &tree, Motion *toMotion, Motion *&result);

            bool connectTrees(Motion *nmotion, TreeData &tree, Motion *xmotion);

            double distanceFunction(const Motion *a, const Motion *b) const
            {
                return si_->distance(a->state, b->state);
            }

            double maxDistance_{0.};

            double tempChangeFactor_;

            base::Cost bestCost_;

            base::Cost worstCost_;

            base::Cost costThreshold_{std::numeric_limits<double>::infinity()};

            double initTemperature_{100.};

            double frontierThreshold_{0.};

            double frontierNodeRatio_{.1};

            double temp_;

            double nonfrontierCount_;

            double frontierCount_;

            double connectionRange_;

            std::pair<Motion *, Motion *> connectionPoint_{nullptr, nullptr};

            TreeData tStart_;

            TreeData tGoal_;

            ompl::base::OptimizationObjectivePtr opt_;
        };
    }
}

#endif