POptUS / IBCDFO

Interpolation-Based Composite Derivative-Free Optimization
Other
7 stars 2 forks source link

Clarifying formquad docstring #118

Closed jmlarson1 closed 11 months ago

jmlarson1 commented 11 months ago

Formquad supports npmax=n+1. Also, the models are at xkin.

coveralls commented 11 months ago

Pull Request Test Coverage Report for Build 7145728007


Totals Coverage Status
Change from base Build 7051375403: 0.0%
Covered Lines: 1386
Relevant Lines: 1431

💛 - Coveralls
jmlarson1 commented 11 months ago

The npmax clarification makes sense, but why is "xkin" better than "Xk" in the description for G and H?

I was thinking because xkin is declared on line 19 it is clearer. Otherwise, Xk isn't used anywhere else in the docstring, right? (I can remove that edit if you prefer.)

jmlarson1 commented 11 months ago

That wording is even better. Thanks @mmenickelly