search

GAA-UAM / scikit-fda

Functional Data Analysis Python package
https://fda.readthedocs.io
BSD 3-Clause "New" or "Revised" License
287 stars 51 forks source link

Rename Gramian matrix to Gram matrix. #501

Closed vnmabus closed 1 year ago

vnmabus commented 1 year ago

In some places we use the terminology Gramian matrix (even in function names). We should use always the name Gram matrix for consistency.

Saumya-ranjan commented 1 year ago

I'd like to take this up. I would really appreciate some clarification on the same

vnmabus commented 1 year ago

Sure! There are some places in which we used the terminology "Gramian matrix" instead of the more common "Gram matrix": https://github.com/GAA-UAM/scikit-fda/search?q=gramian

In particular, the functions gramian_matrix, gramian_matrix_numerical and gramian_matrix_optimization should be renamed, as well as the related comments. As far as I know, nobody is using these functions in other projects (although gramian_matrix_optimization was exposed to be able to provide optimized implementations for particular combinations of basis and operator), so no deprecation would be needed.

I assign you to this issue, please tell me in case you have any other doubt.

Saumya-ranjan commented 1 year ago

So Basically we have to change Gramian_matrix,gramian_matrix_numerical to Gram matrix to be more consistent. Wherein gramian _matrix_optimization is able to provide optimized implementation so it doesn't need to be changed right?

vnmabus commented 1 year ago

All of them should be renamed. The search for gramian should return 0 results.

Saumya-ranjan commented 1 year ago

@vnmabus please do review this https://github.com/GAA-UAM/scikit-fda/pull/502

vnmabus commented 1 year ago

Solved in #502.