internal/ceres/sparse_cholesky.cc

   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 #include "ceres/sparse_cholesky.h"
  32
  33 #include "ceres/cxsparse.h"
  34 #include "ceres/eigensparse.h"
  35 #include "ceres/suitesparse.h"
  36
  37 namespace ceres {
  38 namespace internal {
  39
  40 SparseCholesky* SparseCholesky::Create(
  41     SparseLinearAlgebraLibraryType sparse_linear_algebra_library_type,
  42     OrderingType ordering_type) {
  43   switch (sparse_linear_algebra_library_type) {
  44     case SUITE_SPARSE:
  45 #ifndef CERES_NO_SUITESPARSE
  46       return SuiteSparseCholesky::Create(ordering_type);
  47 #else
  48       LOG(FATAL) << "Ceres was compiled without support for SuiteSparse.";
  49       return NULL;
  50 #endif
  51
  52     case EIGEN_SPARSE:
  53 #ifdef CERES_USE_EIGEN_SPARSE
  54       return EigenSparseCholesky::Create(ordering_type);
  55 #else
  56       LOG(FATAL) << "Ceres was compiled without support for "
  57                  << "Eigen's sparse Cholesky factorization routines.";
  58       return NULL;
  59 #endif
  60
  61     case CX_SPARSE:
  62 #ifndef CERES_NO_CXSPARSE
  63       return CXSparseCholesky::Create(ordering_type);
  64 #else
  65       LOG(FATAL) << "Ceres was compiled without support for CXSparse.";
  66       return NULL;
  67 #endif
  68
  69     default:
  70       LOG(FATAL) << "Unknown sparse linear algebra library type : "
  71                  << SparseLinearAlgebraLibraryTypeToString(
  72                         sparse_linear_algebra_library_type);
  73   }
  74   return NULL;
  75 }
  76
  77 SparseCholesky::~SparseCholesky() {}
  78
  79 LinearSolverTerminationType SparseCholesky::FactorAndSolve(
  80     CompressedRowSparseMatrix* lhs,
  81     const double* rhs,
  82     double* solution,
  83     std::string* message) {
  84   LinearSolverTerminationType termination_type = Factorize(lhs, message);
  85   if (termination_type == LINEAR_SOLVER_SUCCESS) {
  86     termination_type = Solve(rhs, solution, message);
  87   }
  88   return termination_type;
  89 }
  90
  91 CompressedRowSparseMatrix::StorageType StorageTypeForSparseLinearAlgebraLibrary(
  92     SparseLinearAlgebraLibraryType sparse_linear_algebra_library_type) {
  93   if (sparse_linear_algebra_library_type == SUITE_SPARSE) {
  94     return CompressedRowSparseMatrix::UPPER_TRIANGULAR;
  95   }
  96   return CompressedRowSparseMatrix::LOWER_TRIANGULAR;
  97 }
  98
  99 }  // namespace internal
 100 }  // namespace ceres