Skip to content

Commit

Permalink
Document the matrix-function vector products
Browse files Browse the repository at this point in the history
  • Loading branch information
pnkraemer committed Jan 12, 2024
1 parent 8220e04 commit b2ca8fc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions matfree/matfun.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
"""Implement approximations of matrix-function-vector products.
This module is experimental.
Examples
--------
>>> import jax.random
Expand Down Expand Up @@ -89,6 +91,8 @@ def matrix_poly_chebyshev(matfun, order, matvec, /):
This function assumes that the spectrum of the matrix-vector product
is contained in the interval (-1, 1), and that the matrix-function
is analytic on this interval.
If this is not the case,
transform the matrix-vector product and the matrix-function accordingly.
"""
# Construct nodes
nodes = _chebyshev_nodes(order)
Expand Down

0 comments on commit b2ca8fc

Please sign in to comment.