xref: /aosp_15_r20/external/eigen/Eigen/Jacobi (revision bf2c37156dfe67e5dfebd6d394bad8b2ab5804d4)
1*bf2c3715SXin Li// This file is part of Eigen, a lightweight C++ template library
2*bf2c3715SXin Li// for linear algebra.
3*bf2c3715SXin Li//
4*bf2c3715SXin Li// This Source Code Form is subject to the terms of the Mozilla
5*bf2c3715SXin Li// Public License v. 2.0. If a copy of the MPL was not distributed
6*bf2c3715SXin Li// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
7*bf2c3715SXin Li
8*bf2c3715SXin Li#ifndef EIGEN_JACOBI_MODULE_H
9*bf2c3715SXin Li#define EIGEN_JACOBI_MODULE_H
10*bf2c3715SXin Li
11*bf2c3715SXin Li#include "Core"
12*bf2c3715SXin Li
13*bf2c3715SXin Li#include "src/Core/util/DisableStupidWarnings.h"
14*bf2c3715SXin Li
15*bf2c3715SXin Li/** \defgroup Jacobi_Module Jacobi module
16*bf2c3715SXin Li  * This module provides Jacobi and Givens rotations.
17*bf2c3715SXin Li  *
18*bf2c3715SXin Li  * \code
19*bf2c3715SXin Li  * #include <Eigen/Jacobi>
20*bf2c3715SXin Li  * \endcode
21*bf2c3715SXin Li  *
22*bf2c3715SXin Li  * In addition to listed classes, it defines the two following MatrixBase methods to apply a Jacobi or Givens rotation:
23*bf2c3715SXin Li  *  - MatrixBase::applyOnTheLeft()
24*bf2c3715SXin Li  *  - MatrixBase::applyOnTheRight().
25*bf2c3715SXin Li  */
26*bf2c3715SXin Li
27*bf2c3715SXin Li#include "src/Jacobi/Jacobi.h"
28*bf2c3715SXin Li
29*bf2c3715SXin Li#include "src/Core/util/ReenableStupidWarnings.h"
30*bf2c3715SXin Li
31*bf2c3715SXin Li#endif // EIGEN_JACOBI_MODULE_H
32*bf2c3715SXin Li
33