API Reference

Shared types and configuration functions are listed here. The method reference documents BackTracking and its execution. See Using a line search for the evaluation and buffer workflow.

MultiObjectiveLineSearches — Module

Line searches for multiobjective optimization.

Prepare a method such as BackTracking with configure_linesearch, then call perform_linesearch! to search for a step size along a given direction.

source

Configuration

MultiObjectiveLineSearches.configure_linesearch — Function
configure_linesearch(spec, ::Type{T}) where T<:AbstractFloat

Prepare a line search for vectors with element type T. Reuse the returned configuration across iterations. Invalid options raise ArgumentError.

source

Result

MultiObjectiveLineSearches.LineSearchResult — Type
LineSearchResult(success, alpha, reason, message, nfev, iterations)

Result of a line search. alpha is the accepted step on success; on failure, it is the last candidate step, which may not have been evaluated. nfev counts evaluator calls, including one that reports an error, and iterations counts step reductions. On success, the accepted point and objective values are in the trial buffers passed to perform_linesearch!.

reason is :success, :max_iterations, :minimum_step, :evaluation_failure, or :indistinguishable_point. message contains additional detail, or nothing.

source