12#include <Eigen/SparseCore>
13#include <gch/small_vector.hpp>
15#include "sleipnir/optimization/solver/exit_status.hpp"
16#include "sleipnir/optimization/solver/interior_point_matrix_callbacks.hpp"
17#include "sleipnir/optimization/solver/iteration_info.hpp"
18#include "sleipnir/optimization/solver/options.hpp"
19#include "sleipnir/optimization/solver/util/all_finite.hpp"
20#include "sleipnir/optimization/solver/util/append_as_triplets.hpp"
21#include "sleipnir/optimization/solver/util/feasibility_restoration.hpp"
22#include "sleipnir/optimization/solver/util/filter.hpp"
23#include "sleipnir/optimization/solver/util/fraction_to_the_boundary_rule.hpp"
24#include "sleipnir/optimization/solver/util/kkt_error.hpp"
25#include "sleipnir/optimization/solver/util/regularized_ldlt.hpp"
26#include "sleipnir/util/assert.hpp"
27#include "sleipnir/util/print_diagnostics.hpp"
28#include "sleipnir/util/profiler.hpp"
29#include "sleipnir/util/scope_exit.hpp"
30#include "sleipnir/util/symbol_exports.hpp"
61template <
typename Scalar>
62ExitStatus interior_point(
63 const InteriorPointMatrixCallbacks<Scalar>& matrix_callbacks,
64 std::span<std::function<
bool(
const IterationInfo<Scalar>& info)>>
66 const Options& options,
67#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
68 const Eigen::ArrayX<bool>& bound_constraint_mask,
70 Eigen::Vector<Scalar, Eigen::Dynamic>& x) {
71 using DenseVector = Eigen::Vector<Scalar, Eigen::Dynamic>;
74 DenseVector::Ones(matrix_callbacks.num_inequality_constraints);
75 DenseVector y = DenseVector::Zero(matrix_callbacks.num_equality_constraints);
77 DenseVector::Ones(matrix_callbacks.num_inequality_constraints);
78 Scalar μ = Scalar(0.1) * matrix_callbacks.scaling.f;
81 return interior_point(matrix_callbacks, iteration_callbacks, options,
false,
82#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
83 bound_constraint_mask,
85 x, s, y, z, μ, iterations);
121template <
typename Scalar>
122ExitStatus interior_point(
123 const InteriorPointMatrixCallbacks<Scalar>& matrix_callbacks,
124 std::span<std::function<
bool(
const IterationInfo<Scalar>& info)>>
126 const Options& options,
bool in_feasibility_restoration,
127#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
128 const Eigen::ArrayX<bool>& bound_constraint_mask,
130 Eigen::Vector<Scalar, Eigen::Dynamic>& x,
131 Eigen::Vector<Scalar, Eigen::Dynamic>& s,
132 Eigen::Vector<Scalar, Eigen::Dynamic>& y,
133 Eigen::Vector<Scalar, Eigen::Dynamic>& z, Scalar& μ,
int& iterations) {
134 using DenseVector = Eigen::Vector<Scalar, Eigen::Dynamic>;
135 using SparseMatrix = Eigen::SparseMatrix<Scalar>;
136 using SparseVector = Eigen::SparseVector<Scalar>;
152 const auto solve_start_time = std::chrono::steady_clock::now();
154 gch::small_vector<SolveProfiler> solve_profilers;
155 solve_profilers.emplace_back(
"solver");
156 solve_profilers.emplace_back(
"↳ setup");
157 solve_profilers.emplace_back(
"↳ iteration");
158 solve_profilers.emplace_back(
" ↳ callbacks");
159 solve_profilers.emplace_back(
" ↳ KKT matrix build");
160 solve_profilers.emplace_back(
" ↳ KKT matrix decomp");
161 solve_profilers.emplace_back(
" ↳ KKT system solve");
162 solve_profilers.emplace_back(
" ↳ line search");
163 solve_profilers.emplace_back(
" ↳ SOC");
164 solve_profilers.emplace_back(
" ↳ feas. restoration");
165 solve_profilers.emplace_back(
" ↳ f(x)");
166 solve_profilers.emplace_back(
" ↳ ∇f(x)");
167 solve_profilers.emplace_back(
" ↳ ∇²ₓₓL");
168 solve_profilers.emplace_back(
" ↳ ∇²ₓₓL_c");
169 solve_profilers.emplace_back(
" ↳ cₑ(x)");
170 solve_profilers.emplace_back(
" ↳ ∂cₑ/∂x");
171 solve_profilers.emplace_back(
" ↳ cᵢ(x)");
172 solve_profilers.emplace_back(
" ↳ ∂cᵢ/∂x");
174 auto& solver_prof = solve_profilers[0];
175 auto& setup_prof = solve_profilers[1];
176 auto& inner_iter_prof = solve_profilers[2];
177 auto& iter_callbacks_prof = solve_profilers[3];
178 auto& kkt_matrix_build_prof = solve_profilers[4];
179 auto& kkt_matrix_decomp_prof = solve_profilers[5];
180 auto& kkt_system_solve_prof = solve_profilers[6];
181 auto& line_search_prof = solve_profilers[7];
182 auto& soc_prof = solve_profilers[8];
183 auto& feasibility_restoration_prof = solve_profilers[9];
186#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
187 auto& f_prof = solve_profilers[10];
188 auto& g_prof = solve_profilers[11];
189 auto& H_prof = solve_profilers[12];
190 auto& H_c_prof = solve_profilers[13];
191 auto& c_e_prof = solve_profilers[14];
192 auto& A_e_prof = solve_profilers[15];
193 auto& c_i_prof = solve_profilers[16];
194 auto& A_i_prof = solve_profilers[17];
196 InteriorPointMatrixCallbacks<Scalar> matrices{
197 matrix_callbacks.num_decision_variables,
198 matrix_callbacks.num_equality_constraints,
199 matrix_callbacks.num_inequality_constraints,
200 [&](
const DenseVector& x) -> Scalar {
201 ScopedProfiler prof{f_prof};
202 return matrix_callbacks.f(x);
204 [&](
const DenseVector& x) -> SparseVector {
205 ScopedProfiler prof{g_prof};
206 return matrix_callbacks.g(x);
208 [&](
const DenseVector& x,
const DenseVector& y,
209 const DenseVector& z) -> SparseMatrix {
210 ScopedProfiler prof{H_prof};
211 return matrix_callbacks.H(x, y, z);
213 [&](
const DenseVector& x,
const DenseVector& y,
214 const DenseVector& z) -> SparseMatrix {
215 ScopedProfiler prof{H_c_prof};
216 return matrix_callbacks.H_c(x, y, z);
218 [&](
const DenseVector& x) -> DenseVector {
219 ScopedProfiler prof{c_e_prof};
220 return matrix_callbacks.c_e(x);
222 [&](
const DenseVector& x) -> SparseMatrix {
223 ScopedProfiler prof{A_e_prof};
224 return matrix_callbacks.A_e(x);
226 [&](
const DenseVector& x) -> DenseVector {
227 ScopedProfiler prof{c_i_prof};
228 return matrix_callbacks.c_i(x);
230 [&](
const DenseVector& x) -> SparseMatrix {
231 ScopedProfiler prof{A_i_prof};
232 return matrix_callbacks.A_i(x);
234 matrix_callbacks.scaling};
236 const auto& matrices = matrix_callbacks;
242 Scalar f = matrices.f(x);
243 SparseVector g = matrices.g(x);
244 SparseMatrix H = matrices.H(x, y, z);
245 DenseVector c_e = matrices.c_e(x);
246 SparseMatrix A_e = matrices.A_e(x);
247 DenseVector c_i = matrices.c_i(x);
248 SparseMatrix A_i = matrices.A_i(x);
251 slp_assert(g.rows() == matrices.num_decision_variables);
252 slp_assert(H.rows() == matrices.num_decision_variables);
253 slp_assert(H.cols() == matrices.num_decision_variables);
254 slp_assert(c_e.rows() == matrices.num_equality_constraints);
255 slp_assert(A_e.rows() == matrices.num_equality_constraints);
256 slp_assert(A_e.cols() == matrices.num_decision_variables);
257 slp_assert(c_i.rows() == matrices.num_inequality_constraints);
258 slp_assert(A_i.rows() == matrices.num_inequality_constraints);
259 slp_assert(A_i.cols() == matrices.num_decision_variables);
267 DenseVector trial_c_e;
268 DenseVector trial_c_i;
271 if (matrices.num_equality_constraints > matrices.num_decision_variables) {
272 if (options.diagnostics) {
273 print_too_few_dofs_error(c_e);
276 return ExitStatus::TOO_FEW_DOFS;
280 if (!isfinite(f) || !all_finite(g) || !all_finite(H) || !c_e.allFinite() ||
281 !all_finite(A_e) || !c_i.allFinite() || !all_finite(A_i)) {
282 return ExitStatus::NONFINITE_INITIAL_GUESS;
285#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
287 s = bound_constraint_mask.select(c_i, s);
292 matrices.scaling.f * Scalar(options.tolerance) / Scalar(10);
295 constexpr Scalar τ_min(0.99);
300 Filter<Scalar> filter{c_e.template lpNorm<1>() +
301 (c_i - s).
template lpNorm<1>()};
305 auto update_barrier_parameter_and_reset_filter = [&] {
307 constexpr Scalar κ_μ(0.2);
311 constexpr Scalar θ_μ(1.5);
319 μ = std::max(μ_min, std::min(κ_μ * μ, pow(μ, θ_μ)));
326 τ = std::max(τ_min, Scalar(1) - μ);
333 gch::small_vector<Eigen::Triplet<Scalar>> triplets;
336 matrices.num_decision_variables + matrices.num_equality_constraints;
337 RegularizedLDLT<Scalar> solver{
340 (A_i.transpose() * A_i)
341 .
template triangularView<Eigen::Lower>()
345 0.25 * lhs_rows * lhs_rows,
346 matrices.num_decision_variables, matrices.num_equality_constraints,
349 in_feasibility_restoration ? Scalar(0) : Scalar(1e-10)};
352 constexpr Scalar α_reduction_factor(0.5);
353 constexpr Scalar α_min(1e-7);
355 int full_step_rejected_counter = 0;
358 Scalar E_0 = unscaled_kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(
359 matrices.scaling, g, A_e, c_e, A_i, c_i, s, y, z, Scalar(0));
364 scope_exit exit{[&] {
365 if (options.diagnostics) {
368 if (in_feasibility_restoration) {
372 if (iterations > 0) {
373 print_bottom_iteration_diagnostics();
375 print_solver_diagnostics(solve_profilers);
379 while (E_0 > Scalar(options.tolerance)) {
380 ScopedProfiler inner_iter_profiler{inner_iter_prof};
383 if (x.template lpNorm<Eigen::Infinity>() > Scalar(1e10) || !x.allFinite() ||
384 s.template lpNorm<Eigen::Infinity>() > Scalar(1e10) || !s.allFinite()) {
385 return ExitStatus::DIVERGING_ITERATES;
388 ScopedProfiler iter_callbacks_profiler{iter_callbacks_prof};
391 for (
const auto& callback : iteration_callbacks) {
392 if (callback({iterations, x, s, y, z, g, H, A_e, A_i})) {
393 return ExitStatus::CALLBACK_REQUESTED_STOP;
397 iter_callbacks_profiler.stop();
398 ScopedProfiler kkt_matrix_build_profiler{kkt_matrix_build_prof};
403 const SparseMatrix Σ{s.cwiseInverse().asDiagonal() * z.asDiagonal()};
409 const SparseMatrix top_left =
410 H + (A_i.transpose() * Σ * A_i).
template triangularView<Eigen::Lower>();
412 triplets.reserve(top_left.nonZeros() + A_e.nonZeros());
413 append_as_triplets(triplets, 0, 0, {top_left, A_e});
415 matrices.num_decision_variables + matrices.num_equality_constraints,
416 matrices.num_decision_variables + matrices.num_equality_constraints);
417 lhs.setFromSortedTriplets(triplets.begin(), triplets.end());
421 DenseVector rhs{x.rows() + y.rows()};
422 rhs.segment(0, x.rows()) =
423 -g + A_e.transpose() * y +
424 A_i.transpose() * (-Σ * c_i + μ * s.cwiseInverse() + z);
425 rhs.segment(x.rows(), y.rows()) = -c_e;
427 kkt_matrix_build_profiler.stop();
428 ScopedProfiler kkt_matrix_decomp_profiler{kkt_matrix_decomp_prof};
434 bool call_feasibility_restoration =
false;
440 if (solver.compute(lhs).info() != Eigen::Success) [[unlikely]] {
441 return ExitStatus::FACTORIZATION_FAILED;
444 kkt_matrix_decomp_profiler.stop();
445 ScopedProfiler kkt_system_solve_profiler{kkt_system_solve_prof};
447 auto compute_step = [&](Step& step,
const DenseVector& c_i_minus_s) {
450 DenseVector p = solver.solve(rhs);
451 step.p_x = p.segment(0, x.rows());
452 step.p_y = -p.segment(x.rows(), y.rows());
456 step.p_s = c_i_minus_s + A_i * step.p_x;
457 step.p_z = μ * s.cwiseInverse() - z - Σ * step.p_s;
459 compute_step(step, c_i - s);
461 kkt_system_solve_profiler.stop();
462 ScopedProfiler line_search_profiler{line_search_prof};
465 α_max = fraction_to_the_boundary_rule<Scalar>(s, step.p_s, τ);
470 call_feasibility_restoration =
true;
474 α_z = fraction_to_the_boundary_rule<Scalar>(z, step.p_z, τ);
476 const FilterEntry<Scalar> current_entry{f, s, c_e, c_i, μ};
486 g.transpose() * step.p_x - μ * s.cwiseInverse().dot(step.p_s);
490 trial_x = x + α * step.p_x;
491 trial_c_i = matrices.c_i(trial_x);
492 if (options.feasible_ipm && c_i.cwiseGreater(Scalar(0)).all()) {
499 trial_s = s + α * step.p_s;
501 trial_y = y + α_z * step.p_y;
502 trial_z = z + α_z * step.p_z;
504 trial_f = matrices.f(trial_x);
505 trial_c_e = matrices.c_e(trial_x);
509 if (!isfinite(trial_f) || !trial_c_e.allFinite() ||
510 !trial_c_i.allFinite()) {
512 α *= α_reduction_factor;
515 call_feasibility_restoration =
true;
522 FilterEntry trial_entry{trial_f, trial_s, trial_c_e, trial_c_i, μ};
523 if (filter.try_add(current_entry, trial_entry, D_ϕ, α)) {
528 Scalar prev_constraint_violation =
529 c_e.template lpNorm<1>() + (c_i - s).
template lpNorm<1>();
530 Scalar next_constraint_violation =
531 trial_c_e.template lpNorm<1>() +
532 (trial_c_i - trial_s).
template lpNorm<1>();
539 next_constraint_violation >= prev_constraint_violation) {
541 auto soc_step = step;
544 Scalar α_z_soc = α_z;
545 DenseVector c_e_soc = c_e;
546 DenseVector c_i_minus_s_soc = c_i - s;
548 Scalar soc_constraint_violation = next_constraint_violation;
550 bool step_acceptable =
false;
551 for (
int soc_iteration = 0; soc_iteration < 5 && !step_acceptable;
553 ScopedProfiler soc_profiler{soc_prof};
555 scope_exit soc_exit{[&] {
558 if (options.diagnostics && step_acceptable) {
559 print_iteration_diagnostics(
560 iterations, IterationType::SECOND_ORDER_CORRECTION,
561 soc_profiler.current_duration(),
562 unscaled_kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(
563 matrices.scaling, g, A_e, trial_c_e, A_i, trial_c_i,
564 trial_s, trial_y, trial_z, Scalar(0)),
566 trial_c_e.template lpNorm<1>() +
567 (trial_c_i - trial_s).template lpNorm<1>(),
568 trial_s.dot(trial_z), μ, solver.hessian_regularization(),
569 solver.constraint_jacobian_regularization(),
570 std::max(soc_step.p_x.template lpNorm<Eigen::Infinity>(),
571 soc_step.p_s.template lpNorm<Eigen::Infinity>()),
572 std::max(soc_step.p_y.template lpNorm<Eigen::Infinity>(),
573 soc_step.p_z.template lpNorm<Eigen::Infinity>()),
574 α_soc, Scalar(1), α_reduction_factor, α_z_soc);
588 c_e_soc = α_soc * c_e_soc + trial_c_e;
589 c_i_minus_s_soc = α_soc * c_i_minus_s_soc + trial_c_i - trial_s;
590 rhs.segment(0, x.rows()) =
591 -g + A_e.transpose() * y +
592 A_i.transpose() * (μ * s.cwiseInverse() - Σ * c_i_minus_s_soc);
593 rhs.segment(x.rows(), y.rows()) = -c_e_soc;
596 compute_step(soc_step, c_i_minus_s_soc);
600 α_soc = fraction_to_the_boundary_rule<Scalar>(s, soc_step.p_s, τ);
601 α_z_soc = fraction_to_the_boundary_rule<Scalar>(z, soc_step.p_z, τ);
603 trial_x = x + α_soc * soc_step.p_x;
604 trial_s = s + α_soc * soc_step.p_s;
605 trial_y = y + α_z_soc * soc_step.p_y;
606 trial_z = z + α_z_soc * soc_step.p_z;
608 trial_f = matrices.f(trial_x);
609 trial_c_e = matrices.c_e(trial_x);
610 trial_c_i = matrices.c_i(trial_x);
613 FilterEntry trial_entry{trial_f, trial_s, trial_c_e, trial_c_i, μ};
614 if (filter.try_add(current_entry, trial_entry, D_ϕ, α)) {
618 step_acceptable =
true;
623 constexpr Scalar κ_soc(0.99);
627 next_constraint_violation =
628 trial_c_e.template lpNorm<1>() +
629 (trial_c_i - trial_s).
template lpNorm<1>();
630 if (next_constraint_violation > κ_soc * soc_constraint_violation) {
634 soc_constraint_violation = next_constraint_violation;
637 if (step_acceptable) {
647 ++full_step_rejected_counter;
654 if (full_step_rejected_counter >= 4 &&
655 filter.max_constraint_violation >
656 current_entry.constraint_violation / Scalar(10) &&
657 filter.last_rejection_due_to_filter()) {
658 filter.max_constraint_violation *= Scalar(0.1);
664 α *= α_reduction_factor;
669 Scalar current_kkt_error = kkt_error<Scalar, KKTErrorType::ONE_NORM>(
670 g, A_e, c_e, A_i, c_i, s, y, z, μ);
672 trial_x = x + α_max * step.p_x;
673 trial_s = s + α_max * step.p_s;
674 trial_y = y + α_z * step.p_y;
675 trial_z = z + α_z * step.p_z;
677 trial_f = matrices.f(trial_x);
678 trial_c_e = matrices.c_e(trial_x);
679 trial_c_i = matrices.c_i(trial_x);
681 Scalar next_kkt_error = kkt_error<Scalar, KKTErrorType::ONE_NORM>(
682 matrices.g(trial_x), matrices.A_e(trial_x), trial_c_e,
683 matrices.A_i(trial_x), trial_c_i, trial_s, trial_y, trial_z, μ);
686 if (next_kkt_error <= Scalar(0.999) * current_kkt_error) {
691 call_feasibility_restoration =
true;
696 line_search_profiler.stop();
698 if (call_feasibility_restoration) {
699 ScopedProfiler feasibility_restoration_profiler{
700 feasibility_restoration_prof};
703 if (in_feasibility_restoration) {
704 return ExitStatus::FEASIBILITY_RESTORATION_FAILED;
707 FilterEntry initial_entry{matrices.f(x), s, c_e, c_i, μ};
710 gch::small_vector<std::function<bool(
const IterationInfo<Scalar>& info)>>
712 for (
auto& callback : iteration_callbacks) {
713 callbacks.emplace_back(callback);
715 callbacks.emplace_back([&](
const IterationInfo<Scalar>& info) {
716 DenseVector trial_x =
717 info.x.segment(0, matrices.num_decision_variables);
718 DenseVector trial_s =
719 info.s.segment(0, matrices.num_inequality_constraints);
721 DenseVector trial_c_e = matrices.c_e(trial_x);
722 DenseVector trial_c_i = matrices.c_i(trial_x);
726 FilterEntry trial_entry{matrices.f(trial_x), trial_s, trial_c_e,
728 const Scalar D_ϕ_restoration = g.transpose() * (trial_x - x) -
729 μ * s.cwiseInverse().dot(trial_s - s);
730 return trial_entry.constraint_violation <
731 Scalar(0.9) * initial_entry.constraint_violation &&
732 filter.try_add(initial_entry, trial_entry, D_ϕ_restoration, α);
735 feasibility_restoration<Scalar>(matrices, callbacks, options,
736#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
737 bound_constraint_mask,
739 x, s, y, z, μ, iterations);
741 if (status != ExitStatus::SUCCESS) {
747 c_e = matrices.c_e(x);
748 c_i = matrices.c_i(x);
752 full_step_rejected_counter = 0;
774 for (
int row = 0; row < z.rows(); ++row) {
775 constexpr Scalar κ_Σ(1e10);
777 std::clamp(z[row], Scalar(1) / κ_Σ * μ / s[row], κ_Σ * μ / s[row]);
786 A_e = matrices.A_e(x);
787 A_i = matrices.A_i(x);
789 H = matrices.H(x, y, z);
792 E_0 = unscaled_kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(
793 matrices.scaling, g, A_e, c_e, A_i, c_i, s, y, z, Scalar(0));
796 if (E_0 > Scalar(options.tolerance)) {
798 constexpr Scalar κ_ε(10);
802 Scalar E_μ = kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(
803 g, A_e, c_e, A_i, c_i, s, y, z, μ);
804 while (μ > μ_min && E_μ <= κ_ε * μ) {
805 update_barrier_parameter_and_reset_filter();
806 E_μ = kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(g, A_e, c_e, A_i,
811 inner_iter_profiler.stop();
813 if (options.diagnostics) {
814 print_iteration_diagnostics(
816 in_feasibility_restoration ? IterationType::FEASIBILITY_RESTORATION
817 : IterationType::NORMAL,
818 inner_iter_profiler.current_duration(), E_0, f,
819 c_e.template lpNorm<1>() + (c_i - s).template lpNorm<1>(), s.dot(z),
820 μ, solver.hessian_regularization(),
821 solver.constraint_jacobian_regularization(),
822 std::max(step.p_x.template lpNorm<Eigen::Infinity>(),
823 step.p_s.template lpNorm<Eigen::Infinity>()),
824 std::max(step.p_y.template lpNorm<Eigen::Infinity>(),
825 step.p_z.template lpNorm<Eigen::Infinity>()),
826 α, α_max, α_reduction_factor, α_z);
832 if (iterations >= options.max_iterations) {
833 return ExitStatus::MAX_ITERATIONS_EXCEEDED;
837 if (std::chrono::steady_clock::now() - solve_start_time > options.timeout) {
838 return ExitStatus::TIMEOUT;
842 return ExitStatus::SUCCESS;
845extern template SLEIPNIR_DLLEXPORT ExitStatus
846interior_point(
const InteriorPointMatrixCallbacks<double>& matrix_callbacks,
847 std::span<std::function<
bool(
const IterationInfo<double>& info)>>
849 const Options& options,
850#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
851 const Eigen::ArrayX<bool>& bound_constraint_mask,
853 Eigen::Vector<double, Eigen::Dynamic>& x);