mirror of
https://gitlab.com/libeigen/eigen.git
synced 2024-12-27 07:29:52 +08:00
172000aaeb
Documentation: * add an overview for each module. * add an example for .all() and Cwise::operator<
57 lines
1.8 KiB
Plaintext
57 lines
1.8 KiB
Plaintext
#ifndef EIGEN_CHOLESKY_MODULE_H
|
|
#define EIGEN_CHOLESKY_MODULE_H
|
|
|
|
#include "Core"
|
|
|
|
// Note that EIGEN_HIDE_HEAVY_CODE has to be defined per module
|
|
#if (defined EIGEN_EXTERN_INSTANTIATIONS) && (EIGEN_EXTERN_INSTANTIATIONS>=2)
|
|
#ifndef EIGEN_HIDE_HEAVY_CODE
|
|
#define EIGEN_HIDE_HEAVY_CODE
|
|
#endif
|
|
#elif defined EIGEN_HIDE_HEAVY_CODE
|
|
#undef EIGEN_HIDE_HEAVY_CODE
|
|
#endif
|
|
|
|
namespace Eigen {
|
|
|
|
/** \defgroup Cholesky_Module Cholesky module
|
|
* This module provides two variants of the Cholesky decomposition for selfadjoint (hermitian) matrices.
|
|
* Those decompositions are accessible via the following MatrixBase methods:
|
|
* - MatrixBase::cholesky(),
|
|
* - MatrixBase::choleskyNoSqrt()
|
|
*
|
|
* \code
|
|
* #include <Eigen/Cholesky>
|
|
* \endcode
|
|
*/
|
|
|
|
#include "src/Cholesky/Cholesky.h"
|
|
#include "src/Cholesky/CholeskyWithoutSquareRoot.h"
|
|
|
|
} // namespace Eigen
|
|
|
|
#define EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(MATRIXTYPE,PREFIX) \
|
|
PREFIX template class Cholesky<MATRIXTYPE>; \
|
|
PREFIX template class CholeskyWithoutSquareRoot<MATRIXTYPE>
|
|
|
|
#define EIGEN_CHOLESKY_MODULE_INSTANTIATE(PREFIX) \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(Matrix2f,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(Matrix2d,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(Matrix3f,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(Matrix3d,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(Matrix4f,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(Matrix4d,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(MatrixXf,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(MatrixXd,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(MatrixXcf,PREFIX); \
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE_TYPE(MatrixXcd,PREFIX)
|
|
|
|
#ifdef EIGEN_EXTERN_INSTANTIATIONS
|
|
|
|
namespace Eigen {
|
|
EIGEN_CHOLESKY_MODULE_INSTANTIATE(extern);
|
|
} // namespace Eigen
|
|
#endif
|
|
|
|
#endif // EIGEN_CHOLESKY_MODULE_H
|