internal/ceres/gradient_problem_evaluator.h

   1 // Ceres Solver - A fast non-linear least squares minimizer
   2 // Copyright 2015 Google Inc. All rights reserved.
   3 // http://ceres-solver.org/
   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@google.com (Sameer Agarwal)
  30
  31 #ifndef CERES_INTERNAL_GRADIENT_PROBLEM_EVALUATOR_H_
  32 #define CERES_INTERNAL_GRADIENT_PROBLEM_EVALUATOR_H_
  33
  34 #include <map>
  35 #include <string>
  36
  37 #include "ceres/evaluator.h"
  38 #include "ceres/execution_summary.h"
  39 #include "ceres/gradient_problem.h"
  40 #include "ceres/internal/port.h"
  41 #include "ceres/wall_time.h"
  42
  43 namespace ceres {
  44 namespace internal {
  45
  46 class GradientProblemEvaluator : public Evaluator {
  47  public:
  48   explicit GradientProblemEvaluator(const GradientProblem& problem)
  49       : problem_(problem) {}
  50   virtual ~GradientProblemEvaluator() {}
  51   virtual SparseMatrix* CreateJacobian() const { return NULL; }
  52   virtual bool Evaluate(const EvaluateOptions& evaluate_options,
  53                         const double* state,
  54                         double* cost,
  55                         double* residuals,
  56                         double* gradient,
  57                         SparseMatrix* jacobian) {
  58     CHECK(jacobian == NULL);
  59     ScopedExecutionTimer total_timer("Evaluator::Total", &execution_summary_);
  60     // The reason we use Residual and Jacobian here even when we are
  61     // only computing the cost and gradient has to do with the fact
  62     // that the line search minimizer code is used by both the
  63     // GradientProblemSolver and the main CeresSolver coder where the
  64     // Evaluator evaluates the Jacobian, and these magic strings need
  65     // to be consistent across the code base for the time accounting
  66     // to work.
  67     ScopedExecutionTimer call_type_timer(
  68         gradient == NULL ? "Evaluator::Residual" : "Evaluator::Jacobian",
  69         &execution_summary_);
  70     execution_summary_.IncrementCall(gradient == NULL ? "Evaluator::Residual"
  71                                                       : "Evaluator::Jacobian");
  72     return problem_.Evaluate(state, cost, gradient);
  73   }
  74
  75   virtual bool Plus(const double* state,
  76                     const double* delta,
  77                     double* state_plus_delta) const {
  78     return problem_.Plus(state, delta, state_plus_delta);
  79   }
  80
  81   virtual int NumParameters() const {
  82     return problem_.NumParameters();
  83   }
  84
  85   virtual int NumEffectiveParameters()  const {
  86     return problem_.NumLocalParameters();
  87   }
  88
  89   virtual int NumResiduals() const { return 1; }
  90
  91   virtual std::map<std::string, int> CallStatistics() const {
  92     return execution_summary_.calls();
  93   }
  94
  95   virtual std::map<std::string, double> TimeStatistics() const {
  96     return execution_summary_.times();
  97   }
  98
  99  private:
 100   const GradientProblem& problem_;
 101   ::ceres::internal::ExecutionSummary execution_summary_;
 102 };
 103
 104 }  // namespace internal
 105 }  // namespace ceres
 106
 107 #endif  // CERES_INTERNAL_GRADIENT_PROBLEM_EVALUATOR_H_