Eigen/PaStiXSupport

// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// SPDX-FileCopyrightText: The Eigen Authors
// SPDX-License-Identifier: MPL-2.0

#ifndef EIGEN_PASTIXSUPPORT_MODULE_H
#define EIGEN_PASTIXSUPPORT_MODULE_H

#include "SparseCore"

#include "src/Core/util/DisableStupidWarnings.h"

extern "C" {
#include <pastix.h>
}

#if !defined(PASTIX_VERSION_MAJOR) || PASTIX_VERSION_MAJOR != 6
#error Eigen PaStiXSupport requires PaStiX 6.x
#endif

#ifdef complex
#undef complex
#endif

/** \ingroup Support_modules
 * \defgroup PaStiXSupport_Module PaStiXSupport module
 *
 * This module provides an interface to the <a href="https://solverstack.gitlabpages.inria.fr/pastix/">PaSTiX</a> library.
 * PaSTiX is a general \b supernodal, \b parallel and \b opensource sparse solver.
 * It provides the following factorization classes:
 * - class PastixLLT : a supernodal, parallel LLT (real) or LL* (complex) Cholesky factorization.
 * - class PastixLDLT: a supernodal, parallel LDLT (real) or LDL* (complex) factorization.
 * - class PastixLU : a supernodal, parallel LU factorization (optimized for a symmetric pattern).
 *
 * \code
 * #include <Eigen/PaStiXSupport>
 * \endcode
 *
 * In order to use this module, the PaSTiX headers must be accessible from the include paths, and your binary must be
 * linked to the PaSTiX library and its dependencies. This wrapper supports PaStiX 6.x compiled
 * without MPI support. The dependencies depend on how PaSTiX has been compiled. For a cmake based project, you can use our
 * FindPASTIX.cmake module to help you in this task.
 *
 */

// IWYU pragma: begin_exports
#include "src/PaStiXSupport/PaStiXSupport.h"
// IWYU pragma: end_exports

#include "src/Core/util/ReenableStupidWarnings.h"

#endif  // EIGEN_PASTIXSUPPORT_MODULE_H