Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation wherever a matrix can be provided as callable #561

Open
jeverink opened this issue Nov 6, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@jeverink
Copy link
Collaborator

jeverink commented Nov 6, 2024

In various locations, e.g., for example CGLS and FISTAin the solvers module, the matrix can be provided as a ndarray and callable and is described in the documentation as

A : ndarray or callable f(x,*args).

It would be helpful to have a more clearer description of what is required from the callable, e.g., like is being done for ADMM as

A : ndarray or callable
Represents a matrix or a function that performs matrix-vector multiplications.
When A is a callable, it accepts arguments (x, flag) where:
- flag=1 indicates multiplication of A with vector x, that is A @ x.
- flag=2 indicates multiplication of the transpose of A with vector x, that is A.T @ x.

@jeverink jeverink added the enhancement New feature or request label Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant