Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
asistradition committed Oct 3, 2024
1 parent dfd6eb8 commit e52d9b6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,18 @@ It will return a dense array X.
`cast=True` will convert data to compatible floats by making an internal copy if necessary.
It will also convert a CSC matrix to a CSR matrix if necessary.

#### PARDISO
`pardisoinit(mtype, pt=None, iparm=None, single_precision=None,zero_indexing=True)`
`pardiso(A, B, pt, mtype, iparm, phase=13, maxfct=1, mnum=1, perm=None, msglvl=0, X=None, quiet=False)`

Wrapper for MKL pardiso solver and the pardisoinit function which initializes `pt` and `iparm`.
This is a direct solver for real or complex systems of linear equations (AX = B) where `A`
is a sparse CSR matrix and `B` is a dense matrix with one or more right-hand sides.
It will return a dense array X.

Refer to the pardiso documentation for detailed description of options.
Consider this wrapper to be experimental.

#### gram_matrix_mkl
`gram_matrix_mkl(matrix, transpose=False, cast=False, dense=False, debug=False, reorder_output=False)`

Expand Down
5 changes: 3 additions & 2 deletions sparse_dot_mkl/solvers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def pardiso(
pt,
mtype,
iparm,
phase,
phase=13,
maxfct=1,
mnum=1,
perm=None,
Expand Down Expand Up @@ -65,7 +65,8 @@ def pardiso(
:type mtype: int
:param iparm: Solver parameters array, shape=(64,)
:type iparm: np.ndarray
:param phase: Solver phase
:param phase: Solver phase, defaults to 13
(Analysis, numerical factorization, solve, iterative refinement)
:type phase: int
:param maxfct: Pardiso maxfct, defaults to 1
:type maxfct: int, optional
Expand Down

0 comments on commit e52d9b6

Please sign in to comment.