mikegashler / waffles

A toolkit of machine learning algorithms.
http://gashler.com/mike/waffles/
86 stars 33 forks source link

Inconsistencies #23

Closed StephenAshmore closed 7 years ago

StephenAshmore commented 7 years ago

It has been noted that there are some inconsistencies with syntax in waffles. For example, the GMatrix class has a setAll method, but then has methods called fillUniform etc. GVec also has a fill method. This is a very low priority issue, and should be considered a quality of life fix. I don't want to go through pushing a bunch of method name changes without getting some feedback first.

thelukester92 commented 7 years ago

I second this; perhaps leave the old method names in as aliases (just call the actual method) and mark the old one as deprecated?

thelukester92 commented 7 years ago

I second this; perhaps leave the old method names in as aliases (just call the actual method) and mark the old one as deprecated?

On Oct 24, 2016, at 1:55 PM, Stephen Ashmore notifications@github.com wrote:

It has been noted that there are some inconsistencies with syntax in waffles. For example, the GMatrix class has a setAll method, but then has methods called fillUniform etc. GVec also has a fill method. This is a very low priority issue, and should be considered a quality of life fix. I don't want to go through pushing a bunch of method name changes without getting some feedback first.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/mikegashler/waffles/issues/23, or mute the thread https://github.com/notifications/unsubscribe-auth/ABpaDG5P1AIIOOx7xA9NtAvnfj_EQ6xzks5q3P8mgaJpZM4KfJy0.

mikegashler commented 7 years ago

"setAll" exists because I wrote it a long time ago. "fill" is more consistent with STL containers, so I think we should push in that direction. Since we are still small, I think it is better to be agile than to worry about maintaining backward compatibility, so I propose we just fix it and don't worry too much about whose code breaks.

On 10/24/2016 02:11 PM, Luke Godfrey wrote:

I second this; perhaps leave the old method names in as aliases (just call the actual method) and mark the old one as deprecated?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/mikegashler/waffles/issues/23#issuecomment-255836341, or mute the thread https://github.com/notifications/unsubscribe-auth/AB2c64DZ66PVWpYffRpke0AMX8OtZJxXks5q3QL5gaJpZM4KfJy0.

StephenAshmore commented 7 years ago

We should be able to fix these up after @thelukester92 's big merge as part of #26. I'll fix up the inconsistencies in names that aren't already fixed by @thelukester92, and then we should be able to mark waffles 1.1 as done.

StephenAshmore commented 7 years ago

Fixed the fill, and a couple of other things. If there are other inconsistencies that you find, please let me know and I can fix them up. Closing this issue for now.