Add EigenSystem with multi-dtype support and shared_ptr management#833
Merged
Conversation
Add float32/complex64/complex128 variants of EigenSystem alongside the existing float64 path. Complex eigenvalues are returned as separate wr/wi real arrays, and the Plex wrapper is renamed to `EigenSystem` in Python. The class is now managed exclusively via std::shared_ptr through a construct() factory function, The type-erased EigenSystemPlex implementation is consolidated into `EigenSystem.cpp` to save compilation time. Add more LAPACK type compatbility in `lapack_compat.hpp` and update the Python tests accordingly.
yungyuc
commented
May 26, 2026
| // Reinterpret the plex's type-erased instance as the typed SimpleArray<T> it | ||
| // actually holds; the caller must have verified data_type() == T. | ||
| template <typename T> | ||
| static SimpleArray<T> const & typed_array(SimpleArrayPlex const & plex) |
Member
Author
There was a problem hiding this comment.
Static function template to support type-erased SimpleArray.
| static constexpr bool is_complex = is_complex_v<T>; | ||
|
|
||
| explicit EigenSystem(array_type const & matrix, bool do_vl = true, bool do_vr = true); | ||
| static std::shared_ptr<EigenSystem> construct(array_type const & matrix, bool do_vl = true, bool do_vr = true) |
Member
Author
There was a problem hiding this comment.
Factory function template to make EigenSystem exclusively managed by using std::shared_ptr.
| throw std::runtime_error(std::format( | ||
| "EigenSystem::run: DGEEV workspace query failed with info={}", | ||
| static_cast<int64_t>(info))); | ||
| // CGEEV/ZGEEV return eigenvalues as a single complex array and need a |
Member
Author
There was a problem hiding this comment.
[CZ]GEEV require a single complex array as the working space. To keep the external interface the same, the implementation here differs between complex and scalar input.
|
|
||
| /** | ||
| * Overloaded thin wrappers around the LAPACK *GEEV entry points, presenting a | ||
| * uniform call shape to EigenSystem<T>. modmesh's Complex<T> is |
Member
Author
There was a problem hiding this comment.
Complex<T> uses the same memory layout as std::complex.
| WrapEigenSystem<Complex<double>>::commit(mod, "EigenSystemComplex128", "Eigen problem solver (complex128)"); | ||
| // EigenSystem is the type-erased, general entry point that infers the | ||
| // element type from a SimpleArrayPlex (C++ class: EigenSystemPlex). | ||
| WrapEigenSystemPlex::commit(mod, "EigenSystem", "Type-erased eigen problem solver"); |
Member
Author
There was a problem hiding this comment.
Type-erased EigenSystemPlex is wrapped to Python as EigenSystem.
yungyuc
commented
May 26, 2026
| conjugate pair (wi[j] > 0, wi[j+1] = -wi[j]) the j-th and (j+1)-th | ||
| columns hold the real and imaginary parts of the eigenvector; the | ||
| (j+1)-th eigenvector is the complex conjugate of the j-th. | ||
| class TestEigenSystemPlexTC(unittest.TestCase): |
Member
Author
There was a problem hiding this comment.
Test the type-erased EigenSystem.
|
|
||
| REAL = ("float32", "float64") | ||
| COMPLEX = ("complex64", "complex128") | ||
| ALL = REAL + COMPLEX |
|
|
||
| @classmethod | ||
| def get_complex_type(cls): | ||
| _ = {'float32': 'complex64', 'float64': 'complex128'} |
Member
Author
There was a problem hiding this comment.
Use corresponding complex types.
| np.testing.assert_array_equal(solver.matrix.ndarray, A_np) | ||
| @unittest.skipIf(mm.EigenSystemFloat32 is None, | ||
| "EigenSystem is not built (no vendor LAPACK)") | ||
| class TestLinalgEigenSystemFloat32TC(EigenSystemTB, unittest.TestCase): |
Member
Author
There was a problem hiding this comment.
Test for all 4 types with the explicitly typed EigenSystem* classes.
yungyuc
changed the title
shared_ptr management
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add float32/complex64/complex128 variants of EigenSystem alongside the existing float64 path. Complex eigenvalues are returned as separate wr/wi real arrays, and the Plex wrapper is renamed to
EigenSystemin Python. The class is now managed exclusively viastd::shared_ptrthrough aconstruct()factory function,The type-erased EigenSystemPlex implementation is consolidated into
EigenSystem.cppto save compilation time.Add more LAPACK type compatbility in
lapack_compat.hppand update the Python tests accordingly.For issue #790.