Skip to content

qttools.wave_function_solver.solver#

[docs] module qttools.wave_function_solver.solver 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Copyright (c) 2024-2026 ETH Zurich and the authors of the qttools package.

from abc import ABC, abstractmethod

from qttools import NDArray, sparse


class WFSolver(ABC):
    """Abstract base class for wave function solvers."""

    @abstractmethod
    def solve(
        self,
        a: sparse.spmatrix,
        b: NDArray,
    ) -> NDArray:
        """Solves the sparse linear system a @ x = b.

        Parameters
        ----------
        a : sparse.spmatrix
            The sparse system matrix.
        b : NDArray
            The right-hand side vector.

        Returns
        -------
        x : NDArray
            The solution vector.

        """