SVD 1.59 KB
Newer Older
1 2 3 4 5 6 7
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

LM's avatar
LM committed
8 9 10 11 12 13 14 15 16 17 18 19 20
#ifndef EIGEN_SVD_MODULE_H
#define EIGEN_SVD_MODULE_H

#include "QR"
#include "Householder"
#include "Jacobi"

#include "src/Core/util/DisableStupidWarnings.h"

/** \defgroup SVD_Module SVD module
  *
  *
  *
Don Gagne's avatar
Don Gagne committed
21
  * This module provides SVD decomposition for matrices (both real and complex).
22 23 24 25
  * Two decomposition algorithms are provided:
  *  - JacobiSVD implementing two-sided Jacobi iterations is numerically very accurate, fast for small matrices, but very slow for larger ones.
  *  - BDCSVD implementing a recursive divide & conquer strategy on top of an upper-bidiagonalization which remains fast for large problems.
  * These decompositions are accessible via the respective classes and following MatrixBase methods:
Don Gagne's avatar
Don Gagne committed
26
  *  - MatrixBase::jacobiSvd()
27
  *  - MatrixBase::bdcSvd()
LM's avatar
LM committed
28 29 30 31 32 33
  *
  * \code
  * #include <Eigen/SVD>
  * \endcode
  */

34 35 36
#include "src/misc/RealSvd2x2.h"
#include "src/SVD/UpperBidiagonalization.h"
#include "src/SVD/SVDBase.h"
LM's avatar
LM committed
37
#include "src/SVD/JacobiSVD.h"
38
#include "src/SVD/BDCSVD.h"
Don Gagne's avatar
Don Gagne committed
39
#if defined(EIGEN_USE_LAPACKE) && !defined(EIGEN_USE_LAPACKE_STRICT)
40 41 42 43
#ifdef EIGEN_USE_MKL
#include "mkl_lapacke.h"
#else
#include "src/misc/lapacke.h"
Don Gagne's avatar
Don Gagne committed
44
#endif
45
#include "src/SVD/JacobiSVD_LAPACKE.h"
LM's avatar
LM committed
46 47 48 49 50 51
#endif

#include "src/Core/util/ReenableStupidWarnings.h"

#endif // EIGEN_SVD_MODULE_H
/* vim: set filetype=cpp et sw=2 ts=2 ai: */