Home | History | Annotate | Download | only in ceres 
      1 // Ceres Solver - A fast non-linear least squares minimizer
      2 // Copyright 2012 Google Inc. All rights reserved.
      3 // http://code.google.com/p/ceres-solver/
      4 //
      5 // Redistribution and use in source and binary forms, with or without
      6 // modification, are permitted provided that the following conditions are met:
      7 //
      8 // * Redistributions of source code must retain the above copyright notice,
      9 //   this list of conditions and the following disclaimer.
     10 // * Redistributions in binary form must reproduce the above copyright notice,
     11 //   this list of conditions and the following disclaimer in the documentation
     12 //   and/or other materials provided with the distribution.
     13 // * Neither the name of Google Inc. nor the names of its contributors may be
     14 //   used to endorse or promote products derived from this software without
     15 //   specific prior written permission.
     16 //
     17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     20 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
     21 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     25 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     26 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     27 // POSSIBILITY OF SUCH DAMAGE.
     28 //
     29 // Author: sameeragarwal (at) google.com (Sameer Agarwal)
     30 
     31 #ifndef CERES_INTERNAL_LINE_SEARCH_DIRECTION_H_
     32 #define CERES_INTERNAL_LINE_SEARCH_DIRECTION_H_
     33 
     34 #ifndef CERES_NO_LINE_SEARCH_MINIMIZER
     35 
     36 #include "ceres/internal/eigen.h"
     37 #include "ceres/line_search_minimizer.h"
     38 #include "ceres/types.h"
     39 
     40 namespace ceres {
     41 namespace internal {
     42 
     43 class LineSearchDirection {
     44  public:
     45   struct Options {
     46     Options()
     47         : num_parameters(0),
     48           type(LBFGS),
     49           nonlinear_conjugate_gradient_type(FLETCHER_REEVES),
     50           function_tolerance(1e-12),
     51           max_lbfgs_rank(20),
     52           use_approximate_eigenvalue_bfgs_scaling(true) {
     53     }
     54 
     55     int num_parameters;
     56     LineSearchDirectionType type;
     57     NonlinearConjugateGradientType nonlinear_conjugate_gradient_type;
     58     double function_tolerance;
     59     int max_lbfgs_rank;
     60     bool use_approximate_eigenvalue_bfgs_scaling;
     61   };
     62 
     63   static LineSearchDirection* Create(const Options& options);
     64 
     65   virtual ~LineSearchDirection() {}
     66   virtual bool NextDirection(const LineSearchMinimizer::State& previous,
     67                              const LineSearchMinimizer::State& current,
     68                              Vector* search_direction) = 0;
     69 };
     70 
     71 }  // namespace internal
     72 }  // namespace ceres
     73 
     74 #endif  // CERES_NO_LINE_SEARCH_MINIMIZER
     75 #endif  // CERES_INTERNAL_LINE_SEARCH_DIRECTION_H_
     76