internal/ceres/minimizer.cc

   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 #include "ceres/line_search_minimizer.h"
  32 #include "ceres/minimizer.h"
  33 #include "ceres/trust_region_minimizer.h"
  34 #include "ceres/types.h"
  35 #include "glog/logging.h"
  36
  37 namespace ceres {
  38 namespace internal {
  39
  40 Minimizer* Minimizer::Create(MinimizerType minimizer_type) {
  41   if (minimizer_type == TRUST_REGION) {
  42     return new TrustRegionMinimizer;
  43   }
  44
  45   if (minimizer_type == LINE_SEARCH) {
  46     return new LineSearchMinimizer;
  47   }
  48
  49   LOG(FATAL) << "Unknown minimizer_type: " << minimizer_type;
  50   return NULL;
  51 }
  52
  53
  54 Minimizer::~Minimizer() {}
  55
  56 bool Minimizer::RunCallbacks(const Minimizer::Options& options,
  57                              const IterationSummary& iteration_summary,
  58                              Solver::Summary* summary) {
  59   const bool is_not_silent = !options.is_silent;
  60   CallbackReturnType status = SOLVER_CONTINUE;
  61   int i = 0;
  62   while (status == SOLVER_CONTINUE && i < options.callbacks.size()) {
  63     status = (*options.callbacks[i])(iteration_summary);
  64     ++i;
  65   }
  66   switch (status) {
  67     case SOLVER_CONTINUE:
  68       return true;
  69     case SOLVER_TERMINATE_SUCCESSFULLY:
  70       summary->termination_type = USER_SUCCESS;
  71       summary->message =
  72           "User callback returned SOLVER_TERMINATE_SUCCESSFULLY.";
  73       VLOG_IF(1, is_not_silent) << "Terminating: " << summary->message;
  74       return false;
  75     case SOLVER_ABORT:
  76       summary->termination_type = USER_FAILURE;
  77       summary->message = "User callback returned SOLVER_ABORT.";
  78       VLOG_IF(1, is_not_silent) << "Terminating: " << summary->message;
  79       return false;
  80     default:
  81       LOG(FATAL) << "Unknown type of user callback status";
  82   }
  83   return false;
  84 }
  85
  86 }  // namespace internal
  87 }  // namespace ceres