internal/ceres/block_random_access_sparse_matrix.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_BLOCK_RANDOM_ACCESS_SPARSE_MATRIX_H_
  32 #define CERES_INTERNAL_BLOCK_RANDOM_ACCESS_SPARSE_MATRIX_H_
  33
  34 #include <set>
  35 #include <vector>
  36 #include <utility>
  37 #include "ceres/mutex.h"
  38 #include "ceres/block_random_access_matrix.h"
  39 #include "ceres/collections_port.h"
  40 #include "ceres/triplet_sparse_matrix.h"
  41 #include "ceres/integral_types.h"
  42 #include "ceres/internal/macros.h"
  43 #include "ceres/internal/port.h"
  44 #include "ceres/internal/scoped_ptr.h"
  45 #include "ceres/types.h"
  46 #include "ceres/small_blas.h"
  47
  48 namespace ceres {
  49 namespace internal {
  50
  51 // A thread safe square block sparse implementation of
  52 // BlockRandomAccessMatrix. Internally a TripletSparseMatrix is used
  53 // for doing the actual storage. This class augments this matrix with
  54 // an unordered_map that allows random read/write access.
  55 class BlockRandomAccessSparseMatrix : public BlockRandomAccessMatrix {
  56  public:
  57   // blocks is an array of block sizes. block_pairs is a set of
  58   // <row_block_id, col_block_id> pairs to identify the non-zero cells
  59   // of this matrix.
  60   BlockRandomAccessSparseMatrix(
  61       const std::vector<int>& blocks,
  62       const std::set<std::pair<int, int> >& block_pairs);
  63
  64   // The destructor is not thread safe. It assumes that no one is
  65   // modifying any cells when the matrix is being destroyed.
  66   virtual ~BlockRandomAccessSparseMatrix();
  67
  68   // BlockRandomAccessMatrix Interface.
  69   virtual CellInfo* GetCell(int row_block_id,
  70                             int col_block_id,
  71                             int* row,
  72                             int* col,
  73                             int* row_stride,
  74                             int* col_stride);
  75
  76   // This is not a thread safe method, it assumes that no cell is
  77   // locked.
  78   virtual void SetZero();
  79
  80   // Assume that the matrix is symmetric and only one half of the
  81   // matrix is stored.
  82   //
  83   // y += S * x
  84   void SymmetricRightMultiply(const double* x, double* y) const;
  85
  86   // Since the matrix is square, num_rows() == num_cols().
  87   virtual int num_rows() const { return tsm_->num_rows(); }
  88   virtual int num_cols() const { return tsm_->num_cols(); }
  89
  90   // Access to the underlying matrix object.
  91   const TripletSparseMatrix* matrix() const { return tsm_.get(); }
  92   TripletSparseMatrix* mutable_matrix() { return tsm_.get(); }
  93
  94  private:
  95   int64 IntPairToLong(int row, int col) const {
  96     return row * kMaxRowBlocks + col;
  97   }
  98
  99   void LongToIntPair(int64 index, int* row, int* col) const {
 100     *row = index / kMaxRowBlocks;
 101     *col = index % kMaxRowBlocks;
 102   }
 103
 104   const int64 kMaxRowBlocks;
 105
 106   // row/column block sizes.
 107   const std::vector<int> blocks_;
 108   std::vector<int> block_positions_;
 109
 110   // A mapping from <row_block_id, col_block_id> to the position in
 111   // the values array of tsm_ where the block is stored.
 112   typedef HashMap<long int, CellInfo* > LayoutType;
 113   LayoutType layout_;
 114
 115   // In order traversal of contents of the matrix. This allows us to
 116   // implement a matrix-vector which is 20% faster than using the
 117   // iterator in the Layout object instead.
 118   std::vector<std::pair<std::pair<int, int>, double*> > cell_values_;
 119   // The underlying matrix object which actually stores the cells.
 120   scoped_ptr<TripletSparseMatrix> tsm_;
 121
 122   friend class BlockRandomAccessSparseMatrixTest;
 123   CERES_DISALLOW_COPY_AND_ASSIGN(BlockRandomAccessSparseMatrix);
 124 };
 125
 126 }  // namespace internal
 127 }  // namespace ceres
 128
 129 #endif  // CERES_INTERNAL_BLOCK_RANDOM_ACCESS_SPARSE_MATRIX_H_