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

ENH: Better named functions #29

Closed
HaoZeke opened this issue Oct 22, 2023 · 1 comment
Closed

ENH: Better named functions #29

HaoZeke opened this issue Oct 22, 2023 · 1 comment
Labels
enhancement New feature or request ropensci-review Issues related to the ROpenSci review
Milestone

Comments

@HaoZeke
Copy link
Member

HaoZeke commented Oct 22, 2023

consider increased consistency of function names? e.g fmm_to_sparseMatrix vs sparse_to_fmm. sparse_to_fmm was a bit confusing to me in that if I understand correctly, the package is 'fast', not the target format itself (?). matrix and vector is abbreviated to spare a few characters, while sparse_matrix is not. A vague suggestion: possibly follow the pattern of fmm_write_vector, fmm_read_to_vector for all formats?

First noted here: ropensci/software-review#606 (comment).

This is a breaking change, so I'm not too sure, but then again, better now than any other time. I'm OK with fmm myself, since its the package name, but yeah consistency is a good target.

@HaoZeke HaoZeke added enhancement New feature or request ropensci-review Issues related to the ROpenSci review labels Oct 22, 2023
@HaoZeke HaoZeke added this to the v1.0.0 milestone Oct 22, 2023
@HaoZeke
Copy link
Member Author

HaoZeke commented Oct 23, 2023

Also, there are some minor differences between Matrix Market files and what fast matrix market supports, including higher than single precision digits. Since the package name is abbreviated to fmm (in C++). fmm_to_sparse_Matrix is different because it constructs the sparse matrix as implemented in Matrix, a dgCMatrix.

sparse_to_fmm has been converted to sparse_Matrix_to_fmm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ropensci-review Issues related to the ROpenSci review
Projects
None yet
Development

No branches or pull requests

1 participant