internal/ceres/dynamic_sparse_normal_cholesky_solver.h

   1 // Ceres Solver - A fast non-linear least squares minimizer
   2 // Copyright 2017 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 // A solver for sparse linear least squares problem based on solving
  32 // the normal equations via a sparse cholesky factorization.
  33
  34 #ifndef CERES_INTERNAL_DYNAMIC_SPARSE_NORMAL_CHOLESKY_SOLVER_H_
  35 #define CERES_INTERNAL_DYNAMIC_SPARSE_NORMAL_CHOLESKY_SOLVER_H_
  36
  37 // This include must come before any #ifndef check on Ceres compile options.
  38 #include "ceres/internal/port.h"
  39
  40 #include "ceres/internal/macros.h"
  41 #include "ceres/linear_solver.h"
  42
  43 namespace ceres {
  44 namespace internal {
  45
  46 class CompressedRowSparseMatrix;
  47
  48 // A variant of SparseNormalCholeskySolver in the case where matrix
  49 // sparsity is not constant across calls to Solve. This means that
  50 // there is no benefit to symbolically factorizing the matrix and
  51 // caching this factorization.
  52 class DynamicSparseNormalCholeskySolver
  53     : public CompressedRowSparseMatrixSolver {
  54  public:
  55   explicit DynamicSparseNormalCholeskySolver(
  56       const LinearSolver::Options& options);
  57   virtual ~DynamicSparseNormalCholeskySolver() {}
  58
  59  private:
  60   virtual LinearSolver::Summary SolveImpl(
  61       CompressedRowSparseMatrix* A,
  62       const double* b,
  63       const LinearSolver::PerSolveOptions& options,
  64       double* x);
  65
  66   LinearSolver::Summary SolveImplUsingSuiteSparse(
  67       CompressedRowSparseMatrix* A,
  68       double* rhs_and_solution);
  69
  70   LinearSolver::Summary SolveImplUsingCXSparse(
  71       CompressedRowSparseMatrix* A,
  72       double* rhs_and_solution);
  73
  74   LinearSolver::Summary SolveImplUsingEigen(
  75       CompressedRowSparseMatrix* A,
  76       double* rhs_and_solution);
  77
  78   const LinearSolver::Options options_;
  79   CERES_DISALLOW_COPY_AND_ASSIGN(DynamicSparseNormalCholeskySolver);
  80 };
  81
  82 }  // namespace internal
  83 }  // namespace ceres
  84
  85 #endif  // CERES_INTERNAL_DYNAMIC_SPARSE_NORMAL_CHOLESKY_SOLVER_H_