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

README table is missing * and mul! #107

Open
JeffFessler opened this issue Jul 14, 2023 · 5 comments
Open

README table is missing * and mul! #107

JeffFessler opened this issue Jul 14, 2023 · 5 comments

Comments

@JeffFessler
Copy link
Member

The README interface table
https://github.com/JuliaLinearAlgebra/ToeplitzMatrices.jl#implemented-interface
is missing * and mul! and probably more like \ and ldiv!.
Maybe they "go without saying" but I'm not 100% sure they all apply to every subtype.
I could make a PR if someone can confirm that all 4 apply to all AbstractToeplitz types.

@putianyi889
Copy link
Contributor

they should belong to the LinearAlgebra section which I didn't participate, so I left that section blank.

@JeffFessler
Copy link
Member Author

Since + is that table probably * belongs in that same table?

@putianyi889
Copy link
Contributor

no since + is straightforward while * applies proprietary algorithms for Toeplitz

@JeffFessler
Copy link
Member Author

The developer knows that, but a user's perspective is that they are both methods for the type.

@putianyi889
Copy link
Contributor

putianyi889 commented Jul 14, 2023

they are both methods for the type.

A method doesn't always belong to the category of interface. For example, Array addition and subtraction is implemented in Base via broadcasting while Matrix multiplication is implemented in LinearAlgebra.

Anyway, I agree that * and \ can go to interface since they are at the very front end, while the underlying principles need to be explained in the section of linear algebra.

The developer knows that, but a user's perspective is that

A significant task this package does is fast linear algebra operations, as pointed out at the very beginning of README. I would say they are more important than the interface, so they need a separate section to clarify. The users also need to be aware that some proprietary algorithms are applied and they are not as reliable as the default Julia routine. The issues can confirm that.

I'm not 100% sure they all apply to every subtype. I could make a PR if someone can confirm

Me too. It's the exact reason I left the section blank. @jishnub @dlfivefifty

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants