internal/ceres/coordinate_descent_minimizer.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_COORDINATE_DESCENT_MINIMIZER_H_
  32 #define CERES_INTERNAL_COORDINATE_DESCENT_MINIMIZER_H_
  33
  34 #include <string>
  35 #include <vector>
  36
  37 #include "ceres/evaluator.h"
  38 #include "ceres/minimizer.h"
  39 #include "ceres/problem_impl.h"
  40 #include "ceres/solver.h"
  41
  42 namespace ceres {
  43 namespace internal {
  44
  45 class Program;
  46 class LinearSolver;
  47
  48 // Given a Program, and a ParameterBlockOrdering which partitions
  49 // (non-exhaustively) the Hessian matrix into independent sets,
  50 // perform coordinate descent on the parameter blocks in the
  51 // ordering. The independent set structure allows for all parameter
  52 // blocks in the same independent set to be optimized in parallel, and
  53 // the order of the independent set determines the order in which the
  54 // parameter block groups are optimized.
  55 //
  56 // The minimizer assumes that none of the parameter blocks in the
  57 // program are constant.
  58 class CoordinateDescentMinimizer : public Minimizer {
  59  public:
  60   bool Init(const Program& program,
  61             const ProblemImpl::ParameterMap& parameter_map,
  62             const ParameterBlockOrdering& ordering,
  63             std::string* error);
  64
  65   // Minimizer interface.
  66   virtual ~CoordinateDescentMinimizer();
  67   virtual void Minimize(const Minimizer::Options& options,
  68                         double* parameters,
  69                         Solver::Summary* summary);
  70
  71   // Verify that each group in the ordering forms an independent set.
  72   static bool IsOrderingValid(const Program& program,
  73                               const ParameterBlockOrdering& ordering,
  74                               std::string* message);
  75
  76   // Find a recursive decomposition of the Hessian matrix as a set
  77   // of independent sets of decreasing size and invert it. This
  78   // seems to work better in practice, i.e., Cameras before
  79   // points.
  80   static ParameterBlockOrdering* CreateOrdering(const Program& program);
  81
  82  private:
  83   void Solve(Program* program,
  84              LinearSolver* linear_solver,
  85              double* parameters,
  86              Solver::Summary* summary);
  87
  88   std::vector<ParameterBlock*> parameter_blocks_;
  89   std::vector<std::vector<ResidualBlock*> > residual_blocks_;
  90   // The optimization is performed in rounds. In each round all the
  91   // parameter blocks that form one independent set are optimized in
  92   // parallel. This array, marks the boundaries of the independent
  93   // sets in parameter_blocks_.
  94   std::vector<int> independent_set_offsets_;
  95
  96   Evaluator::Options evaluator_options_;
  97 };
  98
  99 }  // namespace internal
 100 }  // namespace ceres
 101
 102 #endif  // CERES_INTERNAL_COORDINATE_DESCENT_MINIMIZER_H_