3rdparty/Eigen/Eigen/src/OrderingMethods/Ordering.h
Go to the documentation of this file.
1 
2 // This file is part of Eigen, a lightweight C++ template library
3 // for linear algebra.
4 //
5 // Copyright (C) 2012 Désiré Nuentsa-Wakam <desire.nuentsa_wakam@inria.fr>
6 //
7 // This Source Code Form is subject to the terms of the Mozilla
8 // Public License v. 2.0. If a copy of the MPL was not distributed
9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 
11 #ifndef EIGEN_ORDERING_H
12 #define EIGEN_ORDERING_H
13 
14 namespace Eigen {
15 
16 #include "Eigen_Colamd.h"
17 
18 namespace internal {
19 
26 template<typename MatrixType>
28 {
29  MatrixType C;
30  C = A.transpose(); // NOTE: Could be costly
31  for (int i = 0; i < C.rows(); i++)
32  {
33  for (typename MatrixType::InnerIterator it(C, i); it; ++it)
34  it.valueRef() = 0.0;
35  }
36  symmat = C + A;
37 }
38 
39 }
40 
41 #ifndef EIGEN_MPL2_ONLY
42 
51 template <typename StorageIndex>
53 {
54  public:
56 
60  template <typename MatrixType>
61  void operator()(const MatrixType& mat, PermutationType& perm)
62  {
63  // Compute the symmetric pattern
64  SparseMatrix<typename MatrixType::Scalar, ColMajor, StorageIndex> symm;
66 
67  // Call the AMD routine
68  //m_mat.prune(keep_diag());
70  }
71 
73  template <typename SrcType, unsigned int SrcUpLo>
75  {
76  SparseMatrix<typename SrcType::Scalar, ColMajor, StorageIndex> C; C = mat;
77 
78  // Call the AMD routine
79  // m_mat.prune(keep_diag()); //Remove the diagonal elements
81  }
82 };
83 
84 #endif // EIGEN_MPL2_ONLY
85 
94 template <typename StorageIndex>
95 class NaturalOrdering
96 {
97  public:
99 
101  template <typename MatrixType>
102  void operator()(const MatrixType& /*mat*/, PermutationType& perm)
103  {
104  perm.resize(0);
105  }
106 
107 };
108 
117 template<typename StorageIndex>
118 class COLAMDOrdering
119 {
120  public:
121  typedef PermutationMatrix<Dynamic, Dynamic, StorageIndex> PermutationType;
122  typedef Matrix<StorageIndex, Dynamic, 1> IndexVector;
123 
127  template <typename MatrixType>
128  void operator() (const MatrixType& mat, PermutationType& perm)
129  {
130  eigen_assert(mat.isCompressed() && "COLAMDOrdering requires a sparse matrix in compressed mode. Call .makeCompressed() before passing it to COLAMDOrdering");
131 
132  StorageIndex m = StorageIndex(mat.rows());
133  StorageIndex n = StorageIndex(mat.cols());
134  StorageIndex nnz = StorageIndex(mat.nonZeros());
135  // Get the recommended value of Alen to be used by colamd
136  StorageIndex Alen = internal::colamd_recommended(nnz, m, n);
137  // Set the default parameters
138  double knobs [COLAMD_KNOBS];
139  StorageIndex stats [COLAMD_STATS];
141 
142  IndexVector p(n+1), A(Alen);
143  for(StorageIndex i=0; i <= n; i++) p(i) = mat.outerIndexPtr()[i];
144  for(StorageIndex i=0; i < nnz; i++) A(i) = mat.innerIndexPtr()[i];
145  // Call Colamd routine to compute the ordering
146  StorageIndex info = internal::colamd(m, n, Alen, A.data(), p.data(), knobs, stats);
148  eigen_assert( info && "COLAMD failed " );
149 
150  perm.resize(n);
151  for (StorageIndex i = 0; i < n; i++) perm.indices()(p(i)) = i;
152  }
153 };
155 } // end namespace Eigen
156 
157 #endif
Matrix3f m
int n
Namespace containing all symbols from the Eigen library.
Definition: jet.h:637
#define COLAMD_KNOBS
Pseudo expression to manipulate a triangular sparse matrix as a selfadjoint matrix.
MatrixXf MatrixType
PermutationMatrix< Dynamic, Dynamic, StorageIndex > PermutationType
bool stats
else if n * info
void ordering_helper_at_plus_a(const MatrixType &A, MatrixType &symmat)
PermutationMatrix< Dynamic, Dynamic, StorageIndex > PermutationType
IndexType colamd_recommended(IndexType nnz, IndexType n_row, IndexType n_col)
Returns the recommended value of Alen.
#define eigen_assert(x)
Definition: Macros.h:579
idx_t idx_t idx_t idx_t idx_t * perm
void minimum_degree_ordering(SparseMatrix< Scalar, ColMajor, StorageIndex > &C, PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm)
Definition: Amd.h:94
#define COLAMD_STATS
static bool colamd(IndexType n_row, IndexType n_col, IndexType Alen, IndexType *A, IndexType *p, double knobs[COLAMD_KNOBS], IndexType stats[COLAMD_STATS])
Computes a column ordering using the column approximate minimum degree ordering.
static void colamd_set_defaults(double knobs[COLAMD_KNOBS])
set default parameters The use of this routine is optional.
Matrix< Scalar, Dynamic, Dynamic > C
Definition: bench_gemm.cpp:37
const IndicesType & indices() const
float * p
void operator()(const SparseSelfAdjointView< SrcType, SrcUpLo > &mat, PermutationType &perm)
void resize(Index newSize)
int EIGEN_BLAS_FUNC() symm(const char *side, const char *uplo, const int *m, const int *n, const RealScalar *palpha, const RealScalar *pa, const int *lda, const RealScalar *pb, const int *ldb, const RealScalar *pbeta, RealScalar *pc, const int *ldc)
Definition: level3_impl.h:287
#define EIGEN_UNUSED_VARIABLE(var)
Definition: Macros.h:618


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:43:06