eb0cd04066653a2ccf8f88457b4c9063f737039d
[blender.git] / extern / ceres / internal / ceres / covariance_impl.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_COVARIANCE_IMPL_H_
32 #define CERES_INTERNAL_COVARIANCE_IMPL_H_
33
34 #include <map>
35 #include <set>
36 #include <utility>
37 #include <vector>
38 #include "ceres/covariance.h"
39 #include "ceres/internal/scoped_ptr.h"
40 #include "ceres/problem_impl.h"
41 #include "ceres/suitesparse.h"
42
43 namespace ceres {
44 namespace internal {
45
46 class CompressedRowSparseMatrix;
47
48 class CovarianceImpl {
49  public:
50   explicit CovarianceImpl(const Covariance::Options& options);
51   ~CovarianceImpl();
52
53   bool Compute(
54       const std::vector<std::pair<const double*,
55                                   const double*> >& covariance_blocks,
56       ProblemImpl* problem);
57
58   bool GetCovarianceBlockInTangentOrAmbientSpace(
59       const double* parameter_block1,
60       const double* parameter_block2,
61       bool lift_covariance_to_ambient_space,
62       double* covariance_block) const;
63
64   bool ComputeCovarianceSparsity(
65       const std::vector<std::pair<const double*,
66                                   const double*> >& covariance_blocks,
67       ProblemImpl* problem);
68
69   bool ComputeCovarianceValues();
70   bool ComputeCovarianceValuesUsingDenseSVD();
71   bool ComputeCovarianceValuesUsingSuiteSparseQR();
72   bool ComputeCovarianceValuesUsingEigenSparseQR();
73
74   const CompressedRowSparseMatrix* covariance_matrix() const {
75     return covariance_matrix_.get();
76   }
77
78  private:
79   ProblemImpl* problem_;
80   Covariance::Options options_;
81   Problem::EvaluateOptions evaluate_options_;
82   bool is_computed_;
83   bool is_valid_;
84   std::map<const double*, int> parameter_block_to_row_index_;
85   std::set<const double*> constant_parameter_blocks_;
86   scoped_ptr<CompressedRowSparseMatrix> covariance_matrix_;
87 };
88
89 }  // namespace internal
90 }  // namespace ceres
91
92 #endif  // CERES_INTERNAL_COVARIANCE_IMPL_H_