Skip to content

Commit cb1eda1

Browse files
committed
docs: add default values in jsdoc
closes: #28
1 parent f8a4c20 commit cb1eda1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/index.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ import { antiLowerConvexHull } from './util/antiLowerConvexHull';
1313
* @param {import('cheminfo-types').NumberArray} lowerBoundaries - Array containing for each variable the lower boundary
1414
* @param {import('cheminfo-types').NumberArray} upperBoundaries - Array containing for each variable the higher boundary
1515
* @param {object} [options={}]
16-
* @param {number} [options.iterations] - Number of iterations.
17-
* @param {number} [options.epsilon] - Tolerance to choose best current value.
18-
* @param {number} [options.tolerance] - Minimum tolerance of the function.
19-
* @param {number} [options.tolerance2] - Minimum tolerance of the function.
16+
* @param {number} [options.iterations=50] - Number of iterations.
17+
* @param {number} [options.epsilon=1e-4] - Tolerance to choose best current value.
18+
* @param {number} [options.tolerance=1e-16] - Minimum tolerance of the function.
19+
* @param {number} [options.tolerance2=1e-12] - Minimum tolerance of the function.
2020
* @param {object} [options.initialState={}] - finalState of previous optimization.
2121
* @returns {object} {finalState, iterations, minFunctionValue}
2222
*/

0 commit comments

Comments
 (0)