smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

Naming `FunctADT` Module in MIS #131

Closed niazim3 closed 6 years ago

niazim3 commented 6 years ago

Is there a reason why this module is named what it is? Can it be named to something more descriptive? Would InterpADT be a poor choice? image

smiths commented 6 years ago

I like the name. The ADT represents a function. For any value of x it returns a value of the function. It stores the limits over which the function is defined. It uses interpolation, but it could use regression or some other approach and have almost the same interface. I thought about the name curve, but that is more general than we want to be. A curve isn't necessarily a function. I'm happy to listen to other ideas, but for now I'm going to close this issue.