Magic Number in SampleStack
- Dominant language
- C++
- Stars
- 403
- Forks
- 154
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 90
Description
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
SampleStack contains [max_samples_ = 10](https://github.com/QMCPACK/qmcpack/blob/7a3f3da4fa624b02eceb0d78822a0f571adfe575/src/Particle/SampleStack.cpp#L19), without any context for this choice.
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
We need to document what `max_samples_ `does and use that info to decide what is a sensible value. We should also not change it just for the sake of changing it.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
If it ain't broke...
**Additional context**
Add any other context or screenshots about the feature request here.
This was found in #4496.
MaxSamples and it's initialization to 10 was introduced in 2cba125 ,
but it does not appear MaxSamples was used for anything in that commit.
`max_samples_` is used in `QMCCostFunctionBatched::correlatedSampling`, see [L461](https://github.com/QMCPACK/qmcpack/blob/7a3f3da4fa624b02eceb0d78822a0f571adfe575/src/QMCDrivers/WFOpt/QMCCostFunctionBatched.cpp#L461), [L548](https://github.com/QMCPACK/qmcpack/blob/7a3f3da4fa624b02eceb0d78822a0f571adfe575/src/QMCDrivers/WFOpt/QMCCostFunctionBatched.cpp#L548) and [L670](https://github.com/QMCPACK/qmcpack/blob/7a3f3da4fa624b02eceb0d78822a0f571adfe575/src/QMCDrivers/WFOpt/QMCCostFunctionBatched.cpp#L670)
Contributor guide
Assessment
This issue has not been assessed yet.