Commons

The commons section of the documentation collects common elements used by more than one solver.

Overview

  • debug actions that can be used in any solver, including the DebugActionFactory that turns the input array to a debug= keyword of a solver into the corresponding concrete debugs, especially when passing symbols like :Cost.
  • functions that are shared by several solvers.
  • objectives, including the decorators that cache, count or embed an objective.
  • problems that carry more than a manifold and an objective.
  • record actions that can be used in any solver, including the RecordActionFactory that turns the input of a record= keyword into the corresponding concrete records.
  • robustifiers used in LevenbergMarquardt to approximate nonsmooth nonlinear least squares.
  • states of the sub solvers.
  • step sizes that can be used with different solvers in the stepsize= keyword.
  • stopping criteria that can be used with different solvers in the stopping_criterion= keyword.
  • vector functions to model, for example, constraints.

Passing parameters

Since the overall design of Manopt.jl is modular, one way to set parameters, for example in the objective of a sub problem, is via set_parameter!.

Manopt.is_tutorial_modeMethod
is_tutorial_mode()

A small internal helper to indicate whether tutorial mode is active.

You can set the mode by calling set_parameter!(:Mode, "Tutorial") or deactivate it by set_parameter!(:Mode, "").

source