From 5f40ec5e5aa478707a155fe6e66bdb1ef2e7ec7f Mon Sep 17 00:00:00 2001 From: "Daniel A. Probst" Date: Sun, 18 Jun 2023 15:46:07 +0200 Subject: [PATCH] Corrected documentation of MObjFn. It does not return an f64, as the return values are passed as function parameters. --- src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 4ad3978..46133a9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -211,7 +211,7 @@ type ConstraintCfg = FunctionCfg; /// A trait representing a multi-objective function. /// -/// A multi-objective function takes the form of a closure `f(result: &mut [f64], x: &[f64], gradient: Option<&mut [f64], user_data: &mut U) -> f64` +/// A multi-objective function takes the form of a closure `f(result: &mut [f64], x: &[f64], gradient: Option<&mut [f64], user_data: &mut U)` /// /// * `result` - `m`-dimensional array to store the value `f(x)` /// * `x` - `n`-dimensional array