foot_point_on_quadric_finder.h

Go to the documentation of this file.

//
// Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of geomtools.
//
// geomtools is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// geomtools is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with geomtools. If not, see <http://www.gnu.org/licenses/>.

#ifndef GEOMTOOLS_FOOT_POINT_ON_QUADRIC_FINDER_H
#define GEOMTOOLS_FOOT_POINT_ON_QUADRIC_FINDER_H

// This project:
#include <geomtools/quadric.h>

namespace geomtools {

  struct foot_point_on_quadric_finder
  {
  public:

    static double default_alpha_max();

    static unsigned int default_max_iter();

    void set_epsilon(double);

    void set_alpha_max(double);

    foot_point_on_quadric_finder(const quadric & q_,
                                 double epsilon_,
                                 double alpha_max_ = -1.0,
                                 unsigned int max_iter_ = 20,
                                 const std::string & dbg_filename_ = "");

    int find(const geomtools::vector_3d & start_,
             geomtools::vector_3d & foot_point_);

  protected:

    void _init();

  private:

    const quadric * _quadric_; 
    double _epsilon_; 
    double _alpha_max_; 
    unsigned int _max_iter_; 
    bool _debug_; 
    std::string _debug_filename_; 

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_POINT_ON_QUADRIC_FINDER_H

/*
** Local Variables: --
** mode: c++ --
** c-file-style: "gnu" --
** tab-width: 2 --
** End: --
*/