Warning, /include/eigen3/Eigen/SuperLUSupport is written in an unsupported language. File is not indexed.
0001 // This file is part of Eigen, a lightweight C++ template library
0002 // for linear algebra.
0003 //
0004 // This Source Code Form is subject to the terms of the Mozilla
0005 // Public License v. 2.0. If a copy of the MPL was not distributed
0006 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
0007
0008 #ifndef EIGEN_SUPERLUSUPPORT_MODULE_H
0009 #define EIGEN_SUPERLUSUPPORT_MODULE_H
0010
0011 #include "SparseCore"
0012
0013 #include "src/Core/util/DisableStupidWarnings.h"
0014
0015 #ifdef EMPTY
0016 #define EIGEN_EMPTY_WAS_ALREADY_DEFINED
0017 #endif
0018
0019 typedef int int_t;
0020 #include <slu_Cnames.h>
0021 #include <supermatrix.h>
0022 #include <slu_util.h>
0023
0024 // slu_util.h defines a preprocessor token named EMPTY which is really polluting,
0025 // so we remove it in favor of a SUPERLU_EMPTY token.
0026 // If EMPTY was already defined then we don't undef it.
0027
0028 #if defined(EIGEN_EMPTY_WAS_ALREADY_DEFINED)
0029 # undef EIGEN_EMPTY_WAS_ALREADY_DEFINED
0030 #elif defined(EMPTY)
0031 # undef EMPTY
0032 #endif
0033
0034 #define SUPERLU_EMPTY (-1)
0035
0036 namespace Eigen { struct SluMatrix; }
0037
0038 /** \ingroup Support_modules
0039 * \defgroup SuperLUSupport_Module SuperLUSupport module
0040 *
0041 * This module provides an interface to the <a href="http://crd-legacy.lbl.gov/~xiaoye/SuperLU/">SuperLU</a> library.
0042 * It provides the following factorization class:
0043 * - class SuperLU: a supernodal sequential LU factorization.
0044 * - class SuperILU: a supernodal sequential incomplete LU factorization (to be used as a preconditioner for iterative methods).
0045 *
0046 * \warning This wrapper requires at least versions 4.0 of SuperLU. The 3.x versions are not supported.
0047 *
0048 * \warning When including this module, you have to use SUPERLU_EMPTY instead of EMPTY which is no longer defined because it is too polluting.
0049 *
0050 * \code
0051 * #include <Eigen/SuperLUSupport>
0052 * \endcode
0053 *
0054 * In order to use this module, the superlu headers must be accessible from the include paths, and your binary must be linked to the superlu library and its dependencies.
0055 * The dependencies depend on how superlu has been compiled.
0056 * For a cmake based project, you can use our FindSuperLU.cmake module to help you in this task.
0057 *
0058 */
0059
0060 #include "src/SuperLUSupport/SuperLUSupport.h"
0061
0062 #include "src/Core/util/ReenableStupidWarnings.h"
0063
0064 #endif // EIGEN_SUPERLUSUPPORT_MODULE_H
