internal/ceres/solver_utils.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 #include <algorithm>
  32 #include <string>
  33
  34 #include "ceres/iteration_callback.h"
  35 #include "ceres/types.h"
  36
  37 namespace ceres {
  38 namespace internal {
  39
  40 template <typename SummaryType>
  41 bool IsSolutionUsable(const SummaryType& summary) {
  42   return (summary.termination_type == CONVERGENCE ||
  43           summary.termination_type == NO_CONVERGENCE ||
  44           summary.termination_type == USER_SUCCESS);
  45 }
  46
  47 template <typename SummaryType>
  48 void SetSummaryFinalCost(SummaryType* summary) {
  49   summary->final_cost = summary->initial_cost;
  50   // We need the loop here, instead of just looking at the last
  51   // iteration because the minimizer maybe making non-monotonic steps.
  52   for (int i = 0; i < summary->iterations.size(); ++i) {
  53     const IterationSummary& iteration_summary = summary->iterations[i];
  54     summary->final_cost = std::min(iteration_summary.cost, summary->final_cost);
  55   }
  56 }
  57
  58 std::string VersionString();
  59
  60 }  // namespace internal
  61 }  // namespace ceres