Skip to content

Commit

Permalink
Corrected documentation of MObjFn. It does not return an f64, as the
Browse files Browse the repository at this point in the history
return values are passed as function parameters.
  • Loading branch information
Daniel A. Probst committed Jun 18, 2023
1 parent 766bead commit 5f40ec5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ type ConstraintCfg<F, T> = FunctionCfg<F, T>;

/// 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
Expand Down

0 comments on commit 5f40ec5

Please sign in to comment.