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

[FEATURE] More concise and clear way of declaring types in main core / container #798

Open
Jerry-Jinfeng-Guo opened this issue Oct 21, 2024 · 0 comments
Labels
feature New feature or request

Comments

@Jerry-Jinfeng-Guo
Copy link
Contributor

Jerry-Jinfeng-Guo commented Oct 21, 2024

In the Container implementation, there now exist three types: Storagable, Gettable and ExtraRetrievable. However, the functions that are defined around are not clear in the way what types are actually expected and what the result is actually about. In this issue, changes are proposed to rename in certain locations when it comes to templated types.

For example, when getting indices on Storagable, it should be clear that this in on the level of base class and derived classes on Gettable types. E.g., consider the following function signatures:
rename

template <supported_type_c<GettableTypes...> Gettable> Idx2D get_idx_by_id(ID id) const

to

template <supported_type_c<GettableTypes...> Gettable> Idx2D get_detail_idx_by_id(ID id) const

or

template <supported_type_c<GettableTypes...> Gettable> Idx2D get_secondary_idx_by_id(ID id) const

and

template <supported_type_c<StorageableTypes...> Storageable> Idx get_group_idx() const

to

template <supported_type_c<StorageableTypes...> Storageable> Idx get_abstract_group_idx() const

or

template <supported_type_c<StorageableTypes...> Storageable> Idx get_primary_group_idx() const

etc..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
Status: No status
Development

No branches or pull requests

1 participant