Skip to content

Commit a943805

Browse files
committed
Updated documentation around optional input 'args'
1 parent cc20390 commit a943805

File tree

2 files changed

+1
-1
lines changed

2 files changed

+1
-1
lines changed

docs/userguide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The :code:`solve` function has several optional arguments which the user may pro
7272
7373
These arguments are:
7474

75-
* :code:`args` - a tuple of extra arguments passed to the objective function
75+
* :code:`args` - a tuple of extra arguments passed to the objective function. This feature is new, and not yet avaiable in the PyPI version of Py-BOBYQA; instead, use Python's built-in function :code:`lambda`.
7676
* :code:`bounds` - a tuple :code:`(lower, upper)` with the vectors :math:`a` and :math:`b` of lower and upper bounds on :math:`x` (default is :math:`a_i=-10^{20}` and :math:`b_i=10^{20}`). To set bounds for either :code:`lower` or :code:`upper`, but not both, pass a tuple :code:`(lower, None)` or :code:`(None, upper)`.
7777
* :code:`npt` - the number of interpolation points to use (default is :code:`2*len(x0)+1`). Py-BOBYQA requires :code:`n+1 <= npt <= (n+1)*(n+2)/2` for a problem with :code:`len(x0)=n`. Larger values are particularly useful for noisy problems.
7878
* :code:`rhobeg` - the initial value of the trust region radius (default is :math:`0.1\max(\|x_0\|_{\infty}, 1)`).

manual.pdf

106 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)