Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Mateusz Baran <mateuszbaran89@gmail.com>
  • Loading branch information
kellertuer and mateuszbaran authored Jul 30, 2024
1 parent 7827141 commit 7fc67fd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions src/plans/interior_point_Newton_plan.jl
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,7 @@ end
@doc raw"""
KKTVectorFieldNormSqGradient <: AbstractConstrainedSlackFunctor
Compute the gradient of the [`KKTVectorFieldNormSq`](@ref) ``φ(p,μ,λ,s) = \lVert F(p,μ,λ,s)\rvert^2``,
Compute the gradient of the [`KKTVectorFieldNormSq`](@ref) ``φ(p,μ,λ,s) = \lVert F(p,μ,λ,s)\rVert^2``,
that is of the norm squared of the [`KKTVectorField`](@ref) ``F``.
This is given in [LaiYoshise:2024](@cite) as the gradient of their merit function,
Expand Down Expand Up @@ -727,7 +727,7 @@ function interior_point_initial_guess(
end

"""
InteriorPointCentralityCondition{CO}
InteriorPointCentralityCondition{CO}
A functor to check the centrality condition.
Expand Down Expand Up @@ -760,7 +760,7 @@ function set_manopt_parameter!(ipcc::InteriorPointCentralityCondition, ::Val{:γ
end

@doc raw"""
StopWhenKKTResidualLess <: StoppingCriterion
StopWhenKKTResidualLess <: StoppingCriterion
Stop when the KKT residual
Expand Down
6 changes: 3 additions & 3 deletions src/solvers/interior_point_Newton.jl
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ the constraints are further fulfilled.
* `Hess_h=nothing`: the Hessian of the equality constraints
* `inequality_constraints=nothing`: the number ``m`` of inequality constraints.
* `λ=ones(size(h(M,x),1))`: the Lagrange multiplier with respect to the equality constraints ``h``
* `μ=ones(size(h(M,x),1))`: the Lagrange multiplier with respect to the inequality constraints ``g``
* `μ=ones(length(g(M,x)))`: the Lagrange multiplier with respect to the inequality constraints ``g``
* `s=μ`: initial value for the slack variables
* `σ=μ's/length(μ)`: ? (TODO find details about barrier parameter)
* `stopping_criterion::StoppingCriterion=`[`StopAfterIteration`](@ref)`(200)`[` | `](@ref StopWhenAny)[`StopWhenChangeLess`](@ref)`(1e-5)`: a stopping criterion
* `retraction_method=[`default_retraction_method`](@extref)`(M, typeof(p))`: the retraction to use, defaults to the default set `M` with respect to the representation for `p` chosen.
* `retraction_method=`[`default_retraction_method`](@extref)`(M, typeof(p))`: the retraction to use, defaults to the default set `M` with respect to the representation for `p` chosen.
* `stepsize=` TODO
* `sub_kwargs=(;)`: keyword arguments to decorate the sub options, for example debug, that automatically respects the main solvers debug options (like sub-sampling) as well
* `sub_stopping_criterion=TODO`: specify a stopping criterion for the subsolver.
* `sub_problem=TODO`: provide a problem for the subsolver, which is assumed to work on the tangent space of `\mathcal M \times ℝ^n`
* `sub_problem=TODO`: provide a problem for the subsolver, which is assumed to work on the tangent space of ``\mathcal M \times ℝ^n``
* `sub_state=TODO`: a state specifying the subsolver
# Output
Expand Down

0 comments on commit 7fc67fd

Please sign in to comment.