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

How do we track constant parameters? #174

Open
joergi-w opened this issue Oct 25, 2021 · 0 comments
Open

How do we track constant parameters? #174

joergi-w opened this issue Oct 25, 2021 · 0 comments
Labels
question Further information is requested

Comments

@joergi-w
Copy link
Member

Some parameters we don't want to expose to the user for several reasons:

  1. in order to simplify the interface
  2. sometimes there are optimal/useful values and users could rather do "mistakes" there
  3. they are dependent on other parameters or user input

We still want to track, which constants we are defining for our algorithms. Here are ideas and [dis]advantages:

  • define locally and document in the GitHub wiki:
    (-) needs to be maintained and can possibly get outdated, website lookup/maintenance is more effort than code documentation, we need a structure ("parameters for algorithm A", possibly links to the code (even more maintenance effort))
    (+) parameter only exists locally only where it is needed, can be found and modified quickly in the beginning of the respective function, easier to track where in iGenVar a parameter is actually used
  • define as constants in the cmd_arguments struct and document there:
    (-) the values must be passed as parameters to all the respective functions, longer parameter lists of the functions with also longer (redundant) parameter documentation, unnecessary copies of constant values, more #include needed, one needs to know where to look them up, danger of unused parameters if functions are deleted
    (+) central view on all parameters in iGenVar.hpp (they are not related, so is this really useful?), easier documentation
@joergi-w joergi-w added the question Further information is requested label Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant