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

Rename internal types to match new naming scheme #34

Closed
tpadioleau opened this issue Mar 23, 2022 · 7 comments
Closed

Rename internal types to match new naming scheme #34

tpadioleau opened this issue Mar 23, 2022 · 7 comments

Comments

@tpadioleau
Copy link
Member

Our types in classes haven't been renamed in the big !73 renaming. For example, we have stuff like:

template <class... DDims>
class DiscreteDomain
{
public:
    using mcoord_type = DiscreteCoordinate<DDims...>;
};

This should read more like:

template <class... DDims>
class DiscreteDomain
{
public:
    using discrete_coordinate_type = DiscreteCoordinate<DDims...>;
};
@jbigot
Copy link
Member

jbigot commented Mar 28, 2022

@tpadioleau
Copy link
Member Author

  • to_real -> coordinate, position ?
  • DiscreteCoordinate -> DiscreteElement
  • DiscreteVector -> ok
  • rcoord_type -> c_elem_type, c_element_type, continuous_element_type ?
  • dvect_type -> d_vect_type, discrete_vect_type, discrete_vector_type ?
  • ddom_type -> d_dom_type, discrete_dom_type, discrete_domain_type ?
  • rdim_type -> c_dim_type, c_dimension_type, continuous_dimension_type ?
  • mcoord_type -> d_elem_type, d_element_type, discrete_element_type ?
  • ddim_type -> d_dim_type, discrete_dim_type, discrete_dimension_type ?

@tpadioleau
Copy link
Member Author

  • discretization() -> discrete_space() ?

@jbigot
Copy link
Member

jbigot commented Jun 15, 2022

discretization() -> discrete_space() ?

👍

ddim_type -> d_dim_type, discrete_dim_type, discrete_dimension_type ?

👍 for discrete_dimension_type

DiscreteCoordinate -> DiscreteElement

👍

DiscreteVector -> ok

👍

I'd also propose to change:

  • UniformDiscretization -> UniformPointDiscretization or UniformPointSampling
  • NonUniformDiscretization -> NonUniformPointDiscretization or NonUniformPointSampling

dvect_type -> d_vect_type, discrete_vect_type, discrete_vector_type ?

👍 for discrete_vector_type

ddom_type -> d_dom_type, discrete_dom_type, discrete_domain_type ?

👍 for discrete_domain_type

mcoord_type -> d_elem_type, d_element_type, discrete_element_type ?

👍 for discrete_element_type

to_real -> coordinate, position ?

👍 for coordinate in case of a *PointDiscretization

rdim_type -> c_dim_type, c_dimension_type, continuous_dimension_type ?

👍 for continuous_dimension_type unless we can use different terms for the continuous and discrete cases...

rcoord_type -> c_elem_type, c_element_type, continuous_element_type ?

👍 for continuous_element_type, but maybe we can use coordinate_type for an element of a continuous space...

@tpadioleau
Copy link
Member Author

As discussed, there may be multiple attributes attached to a discrete coordinate. Some of them can be related to the underlying continous space like in the UniformPointDiscretization case. Then should we inject a type such as continuous_element_type ?

@tpadioleau
Copy link
Member Author

UniformPointDiscretization may be closer to the other names we already introduced ?

@tpadioleau
Copy link
Member Author

I tried UniformPointSampling in the end. Looks good to me.

tpadioleau added a commit that referenced this issue Jun 22, 2022
Renaming according to issue #34.
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