Repository navigation
Rename packages that have DHB in their names #62
Description
The following packages still have the DHB part in their names:
Math-DHB-NumericalMath-Tests-DHB-NumericalMath-Tests-DHB-wk
We should change DHB to PM.
However (!), it would be much better to come up with better names for these packages. At this moment the naming is very inconsistent. For example, the tests for PMMatrix are in package Math-Tests-Matrix and the tests for PMVector are in Math-Tests-DHB-Numerical.
Activity
[-]Rename test packages that have DHB in their names[/-][+]Rename packages that have DHB in their names[/+]SergeStinckwich commentedon Jul 5, 2018
Or remove completely PM or DHB, because they have all a Math prefix.
I agree with you about the inconsistent naming.
What do you propose ?
olekscode commentedon Jul 5, 2018
Is Math a good prefix?
We will be prefixing all classes with PM, so maybe we can use the same prefix for packages?
Of course,
PM-Testsdoesn't look as good asMath-Tests, but two different prefixes may confuse the users.olekscode commentedon Jul 5, 2018
I propose creating a file where we describe the style rules (brief style guide).
Then we can post the link to in on the mailing list and Discord and discuss with everyone what could be the best naming conventions.
This way we should redefine all names in PolyMath and make them consistent with each other.
For example:
Packages: PM-{Package}-{Name}
Classes: PM{ClassName}
Test packages: PM-Tests-{Name}
Test classes: PM{Name}Tests
Another big question is what should be the level of abstraction. Right now we have many packages which have just one class inside (especially test packages), and other packages that have so many classes that they could be split into multiple packages.
I think it's a very difficult question, but probably we should start by defining the whole scope of applications of PolyMath. For example, "PolyMath is a library of numerical algorithms". Then split this area into subareas. Example: "Statistics", "Linear algebra", "Machine Learning", etc. (we can use the chapters of Numerical Methods book as a reference, but we need to update this classification because modern PolyMath is different from what it was back then). Then each group could be a package:
PM-Statistics,PM-Linear-Algebra,PM-Machine-Learning. And then:PM-Tests-Statistics,PM-Tests-Linear-Algebra,PM-Tests-Machine-Learning.This is just an idea. I think that we need to discuss this with everyone and make a style guide.
SergeStinckwich commentedon Jul 8, 2018
I agree mostly with what you say, but I'm a reluctant to move all
Math-XXX packagetoPM-XXX. First of all because it will need a lot of changes and then because if look at current packages names, most of the time there is not acronyms in package names. So for the moment, until we release 1.0, we can keepMath-XXXor rename withPolyMath-XXX.SergeStinckwich commentedon Jul 8, 2018
yes the whole scope of PolyMath is a library of numerical algorithms and then we need to split in different meaningfull packages :
PolyMath-Algebra,PolyMath-DataAnalysis, etc ...SergeStinckwich commentedon Apr 30, 2019
There is no more package with DHB inside. What is only missing is classes without PM prefix.
hemalvarambhia commentedon Apr 30, 2019
@SergeStinckwich I'll get on to that.
Working on #62 rename TSNE => PMSTE
- Remove Manifest classes
Close #62
Close #62
Merge dev commits to master for the 1.0 release (#145)