Menu

#190 Various renaming issues

0.3.2
done
nobody
None
nobody
2020-08-30
2020-05-21
Ulf Lorenz
No
What and Why

With the new functionality of [#144], several terms have gotten new or more precise meanings. to avoid identical names for different concepts, the class names should be adjusted. Since this is a breaking change, it should be done as early as possible.

  • Fix capitalization. For example, we use dvrToFbr(), but FFTTransformation.
  • In the doxygen documentation, always explicitly use the namespace in cross-references. It is introduced in the beginning, I think people can handle that.
  • The name "transformation" is used for two different concept: Transformations between representations (fine) and modifications of operators. The latter has to be renamed.
  • With the transformations, we introduced representation as a concept with two ingredients: a grid and a meaning of the coefficients. We only track the former, but not the latter. This clashes with the name of the Representation class, which only describes the grid part. Suggestion: Rename all simple grids to ...Grid1D, rename Representation to GridND. Note that all references also need to change then (Python argument names, function names, BadRepresentationException, ...)

renamed simple grids to DegreeOfFreedom for better distinguishability; did not use camel case for IOException and NIPFactory, because both should be replaced by further refactorings.

Related

Tickets: #144

Discussion

  • Ulf Lorenz

    Ulf Lorenz - 2020-07-31
    • Milestone: 0.4 goal --> 0.3.2
     
  • Ulf Lorenz

    Ulf Lorenz - 2020-08-15
    • status: open --> assigned
    • assigned_to: Ulf Lorenz
     
  • Ulf Lorenz

    Ulf Lorenz - 2020-08-30
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -6,3 +6,7 @@
     * In the doxygen documentation, always explicitly use the namespace in cross-references. It is introduced in the beginning, I think people can handle that.
     * The name "transformation"  is used for two different concept: Transformations between representations (fine) and modifications of operators. The latter has to be renamed.
     * With the transformations, we introduced representation as a concept with two ingredients: a grid and a meaning of the coefficients. We only track the former, but not the latter. This clashes with the name of the Representation class, which only describes the grid part. Suggestion: Rename all simple grids to ...Grid1D, rename Representation to GridND. Note that all references also need to change then (Python argument names, function names, BadRepresentationException, ...)
    +
    +----
    +
    +renamed simple grids to DegreeOfFreedom for better distinguishability; did not use camel case for IOException and NIPFactory, because both should be replaced by further refactorings.
    
    • status: assigned --> done
    • assigned_to: Ulf Lorenz --> nobody
     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.