2010-06-18 17:28:30 +08:00
#ifndef EIGEN_SUPERLUSUPPORT_MODULE_H
#define EIGEN_SUPERLUSUPPORT_MODULE_H
2011-11-12 21:11:27 +08:00
#include "SparseCore"
2010-06-18 17:28:30 +08:00
2011-11-16 16:27:38 +08:00
#include "src/Core/util/DisableStupidWarnings.h"
2010-06-18 17:28:30 +08:00
2011-07-07 22:42:51 +08:00
#ifdef EMPTY
#define EIGEN_EMPTY_WAS_ALREADY_DEFINED
#endif
2010-06-18 17:28:30 +08:00
typedef int int_t;
#include <slu_Cnames.h>
#include <supermatrix.h>
#include <slu_util.h>
2011-07-07 22:42:51 +08:00
// slu_util.h defines a preprocessor token named EMPTY which is really polluting,
// so we remove it in favor of a SUPERLU_EMPTY token.
2012-04-15 18:06:28 +08:00
// If EMPTY was already defined then we don't undef it.
2011-07-07 22:42:51 +08:00
#if defined(EIGEN_EMPTY_WAS_ALREADY_DEFINED)
# undef EIGEN_EMPTY_WAS_ALREADY_DEFINED
#elif defined(EMPTY)
# undef EMPTY
#endif
#define SUPERLU_EMPTY (-1)
2010-06-18 17:28:30 +08:00
namespace Eigen { struct SluMatrix; }
2011-11-28 23:36:37 +08:00
/** \ingroup Support_modules
2011-11-12 21:11:27 +08:00
* \defgroup SuperLUSupport_Module SuperLUSupport module
2010-06-18 17:28:30 +08:00
*
2012-06-21 16:51:22 +08:00
* This module provides an interface to the <a href="http://crd-legacy.lbl.gov/~xiaoye/SuperLU/">SuperLU</a> library.
* It provides the following factorization class:
* - class SuperLU: a supernodal sequential LU factorization.
* - class SuperILU: a supernodal sequential incomplete LU factorization (to be used as a preconditioner for iterative methods).
*
2011-07-07 22:42:51 +08:00
* \warning When including this module, you have to use SUPERLU_EMPTY instead of EMPTY which is no longer defined because it is too polluting.
2010-06-18 17:28:30 +08:00
*
* \code
* #include <Eigen/SuperLUSupport>
* \endcode
2012-06-21 16:51:22 +08:00
*
* 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.
* The dependencies depend on how superlu has been compiled.
* For a cmake based project, you can use our FindSuperLU.cmake module to help you in this task.
*
2010-06-18 17:28:30 +08:00
*/
2011-11-12 21:11:27 +08:00
#include "src/SuperLUSupport/SuperLUSupport.h"
2010-06-18 17:28:30 +08:00
2011-11-16 16:27:38 +08:00
#include "src/Core/util/ReenableStupidWarnings.h"
2010-06-18 17:28:30 +08:00
#endif // EIGEN_SUPERLUSUPPORT_MODULE_H