DSS-Extensions: KLUSolveX

This is a fork of KLUSolve used by DSS C-API. See the original at SourceForge. As explicit in LICENSE, this work uses the same license, LGPL 2.1 or later.

Changes include:

• Uses a CMake building script. Note: this was added long before CMake was used in the original KLUSolve. Our script is not based on the one in the KLUSolve repository, and it is more general, resulting in a cleaner repository.
• Uses either system SuiteSparse libraries (when compatible) or downloads upstream SuiteSparse source-code. The SuiteSparse source code is not included in the KLUSolveX repository anymore.
• Adds a dependency on Eigen, dropping the customized CZSparse.
• Introduces some dense matrix functions (e.g. mvmult) to be used in the DSS C-API, an alternative OpenDSS library, for better performance.
• Introduces reuse of the symbolic and numeric factorization steps from KLU when the sparse matrix is unchanged.
• Changes calling convention to CDECL on Windows -- so far this is the only change that breaks compatibility with KLUSolve.

For binary distributions, basic descriptions of the dependencies and licensing information is reproduced below. When building from source, be sure to check the licenses of the components.

Currently tested with Eigen 3.3.7 and SuiteSparse 5.6.0.

Credits / Acknowledgment

Original version is at SourceForge.

Most of the changes and new features were contributed by Paulo Meira (@PMeira).

Thanks for Felipe Markson (@felipemarkson) for contributing a static build option.

Since we don't include the code for KLU or SuiteSparse in this repository anymore, please see SuiteSparse and Eigen for credits and details of the dependencies.

KLUSolveX

Copyright (c) 2017-2020, Paulo Meira

Copyright (c) 2019-2022, DSS Extensions contributors

Copyright (c) 2008, EnerNex Corporation

All rights reserved.

KLUSolveX is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

KLUSolveX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this Module; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA