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