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

naming for AGHQ/AGHQuad #1465

Open
paciorek opened this issue Jun 6, 2024 · 7 comments
Open

naming for AGHQ/AGHQuad #1465

paciorek opened this issue Jun 6, 2024 · 7 comments

Comments

@paciorek
Copy link
Contributor

paciorek commented Jun 6, 2024

@perrydv @paul-vdb @weizhangstats We have buildAGHQuad but runAGHQ and summaryAGHQ.

I'm somewhat inclined to change to buildAGHQ.

I think we want to decide on a single naming convention. If we decide today or early tomorrow, we could change for the release. Or we could wait for nimbleQuad.

@paciorek
Copy link
Contributor Author

paciorek commented Jun 6, 2024

I should also note "AGHQuad_" is used internally.

@perrydv
Copy link
Contributor

perrydv commented Jun 6, 2024

Sorry that's partly my fault on runAGHQ as a late addition. I like "AGHQ" without the "uad", but I could be convinced the other way. I agree consistency will be easier in the long run.

Some names like nQuad_ are used so that that can be an internal (member) variable name and thus leave nQuad available as an argument name. I don't see AGHQuad_ but if it's there I think that kind of reason would be why.

@paciorek
Copy link
Contributor Author

paciorek commented Jun 6, 2024

Most of our internal naming of functions/methods and objects is of the form AGHQuad*. I think it would be ok to leave that and have only user facing be AGHQ, namely buildAGHQ and runAGHQ.

@perrydv
Copy link
Contributor

perrydv commented Jun 6, 2024

Agreed, the topic now is user-facing names.

@weizhangstats
Copy link
Contributor

buildQuad? AGHQ is of a particular type and the more generic name Quad for quadrature will allow us to build in other types if of interest?

@paciorek
Copy link
Contributor Author

paciorek commented Jun 6, 2024

I think if we added other types, we could then create a buildQuad as a wrapper. I'm inclined not to do that at this point.

@paul-vdb
Copy link
Contributor

paul-vdb commented Jun 6, 2024

I think it's splitting hairs and agree with buildQuad big picture but buildLaplace and buildAGHQ as a wrapper in the future works just fine. I vote for buildAGHQ for this release. Remove the uad :)

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

4 participants