13#include <Eigen/SparseCore>
14#include <gch/small_vector.hpp>
16#include "sleipnir/optimization/solver/exit_status.hpp"
17#include "sleipnir/optimization/solver/interior_point_matrix_callbacks.hpp"
18#include "sleipnir/optimization/solver/iteration_info.hpp"
19#include "sleipnir/optimization/solver/options.hpp"
20#include "sleipnir/optimization/solver/util/all_finite.hpp"
21#include "sleipnir/optimization/solver/util/append_as_triplets.hpp"
22#include "sleipnir/optimization/solver/util/feasibility_restoration.hpp"
23#include "sleipnir/optimization/solver/util/filter.hpp"
24#include "sleipnir/optimization/solver/util/fraction_to_the_boundary_rule.hpp"
25#include "sleipnir/optimization/solver/util/is_locally_infeasible.hpp"
26#include "sleipnir/optimization/solver/util/kkt_error.hpp"
27#include "sleipnir/optimization/solver/util/regularized_ldlt.hpp"
28#include "sleipnir/util/assert.hpp"
29#include "sleipnir/util/print_diagnostics.hpp"
30#include "sleipnir/util/profiler.hpp"
31#include "sleipnir/util/scope_exit.hpp"
32#include "sleipnir/util/symbol_exports.hpp"
63template <
typename Scalar>
64ExitStatus interior_point(
65 const InteriorPointMatrixCallbacks<Scalar>& matrix_callbacks,
66 std::span<std::function<
bool(
const IterationInfo<Scalar>& info)>>
68 const Options& options,
69#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
70 const Eigen::ArrayX<bool>& bound_constraint_mask,
72 Eigen::Vector<Scalar, Eigen::Dynamic>& x) {
73 using DenseVector = Eigen::Vector<Scalar, Eigen::Dynamic>;
76 DenseVector::Ones(matrix_callbacks.num_inequality_constraints);
77 DenseVector y = DenseVector::Zero(matrix_callbacks.num_equality_constraints);
79 DenseVector::Ones(matrix_callbacks.num_inequality_constraints);
82 return interior_point(matrix_callbacks, iteration_callbacks, options,
false,
83#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
84 bound_constraint_mask,
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& μ) {
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(
" ↳ feasibility check");
159 solve_profilers.emplace_back(
" ↳ callbacks");
160 solve_profilers.emplace_back(
" ↳ KKT matrix build");
161 solve_profilers.emplace_back(
" ↳ KKT matrix decomp");
162 solve_profilers.emplace_back(
" ↳ KKT system solve");
163 solve_profilers.emplace_back(
" ↳ line search");
164 solve_profilers.emplace_back(
" ↳ SOC");
165 solve_profilers.emplace_back(
" ↳ next iter prep");
166 solve_profilers.emplace_back(
" ↳ f(x)");
167 solve_profilers.emplace_back(
" ↳ ∇f(x)");
168 solve_profilers.emplace_back(
" ↳ ∇²ₓₓL");
169 solve_profilers.emplace_back(
" ↳ ∇²ₓₓL_c");
170 solve_profilers.emplace_back(
" ↳ cₑ(x)");
171 solve_profilers.emplace_back(
" ↳ ∂cₑ/∂x");
172 solve_profilers.emplace_back(
" ↳ cᵢ(x)");
173 solve_profilers.emplace_back(
" ↳ ∂cᵢ/∂x");
175 auto& solver_prof = solve_profilers[0];
176 auto& setup_prof = solve_profilers[1];
177 auto& inner_iter_prof = solve_profilers[2];
178 auto& feasibility_check_prof = solve_profilers[3];
179 auto& iter_callbacks_prof = solve_profilers[4];
180 auto& kkt_matrix_build_prof = solve_profilers[5];
181 auto& kkt_matrix_decomp_prof = solve_profilers[6];
182 auto& kkt_system_solve_prof = solve_profilers[7];
183 auto& line_search_prof = solve_profilers[8];
184 auto& soc_prof = solve_profilers[9];
185 auto& next_iter_prep_prof = solve_profilers[10];
188#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
189 auto& f_prof = solve_profilers[11];
190 auto& g_prof = solve_profilers[12];
191 auto& H_prof = solve_profilers[13];
192 auto& H_c_prof = solve_profilers[14];
193 auto& c_e_prof = solve_profilers[15];
194 auto& A_e_prof = solve_profilers[16];
195 auto& c_i_prof = solve_profilers[17];
196 auto& A_i_prof = solve_profilers[18];
198 InteriorPointMatrixCallbacks<Scalar> matrices{
199 matrix_callbacks.num_decision_variables,
200 matrix_callbacks.num_equality_constraints,
201 matrix_callbacks.num_inequality_constraints,
202 [&](
const DenseVector& x) -> Scalar {
203 ScopedProfiler prof{f_prof};
204 return matrix_callbacks.f(x);
206 [&](
const DenseVector& x) -> SparseVector {
207 ScopedProfiler prof{g_prof};
208 return matrix_callbacks.g(x);
210 [&](
const DenseVector& x,
const DenseVector& y,
211 const DenseVector& z) -> SparseMatrix {
212 ScopedProfiler prof{H_prof};
213 return matrix_callbacks.H(x, y, z);
215 [&](
const DenseVector& x,
const DenseVector& y,
216 const DenseVector& z) -> SparseMatrix {
217 ScopedProfiler prof{H_c_prof};
218 return matrix_callbacks.H_c(x, y, z);
220 [&](
const DenseVector& x) -> DenseVector {
221 ScopedProfiler prof{c_e_prof};
222 return matrix_callbacks.c_e(x);
224 [&](
const DenseVector& x) -> SparseMatrix {
225 ScopedProfiler prof{A_e_prof};
226 return matrix_callbacks.A_e(x);
228 [&](
const DenseVector& x) -> DenseVector {
229 ScopedProfiler prof{c_i_prof};
230 return matrix_callbacks.c_i(x);
232 [&](
const DenseVector& x) -> SparseMatrix {
233 ScopedProfiler prof{A_i_prof};
234 return matrix_callbacks.A_i(x);
237 const auto& matrices = matrix_callbacks;
243 Scalar f = matrices.f(x);
244 SparseVector g = matrices.g(x);
245 SparseMatrix H = matrices.H(x, y, z);
246 DenseVector c_e = matrices.c_e(x);
247 SparseMatrix A_e = matrices.A_e(x);
248 DenseVector c_i = matrices.c_i(x);
249 SparseMatrix A_i = matrices.A_i(x);
252 slp_assert(g.rows() == matrices.num_decision_variables);
253 slp_assert(H.rows() == matrices.num_decision_variables);
254 slp_assert(H.cols() == matrices.num_decision_variables);
255 slp_assert(c_e.rows() == matrices.num_equality_constraints);
256 slp_assert(A_e.rows() == matrices.num_equality_constraints);
257 slp_assert(A_e.cols() == matrices.num_decision_variables);
258 slp_assert(c_i.rows() == matrices.num_inequality_constraints);
259 slp_assert(A_i.rows() == matrices.num_inequality_constraints);
260 slp_assert(A_i.cols() == matrices.num_decision_variables);
263 if (matrices.num_equality_constraints > matrices.num_decision_variables) {
264 if (options.diagnostics) {
265 print_too_few_dofs_error(c_e);
268 return ExitStatus::TOO_FEW_DOFS;
272 if (!isfinite(f) || !all_finite(g) || !all_finite(H) || !c_e.allFinite() ||
273 !all_finite(A_e) || !c_i.allFinite() || !all_finite(A_i)) {
274 return ExitStatus::NONFINITE_INITIAL_GUESS;
277#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
279 s = bound_constraint_mask.select(c_i, s);
285 const Scalar μ_min = Scalar(options.tolerance) / Scalar(10);
288 constexpr Scalar τ_min(0.99);
293 Filter<Scalar> filter{c_e.template lpNorm<1>() +
294 (c_i - s).
template lpNorm<1>()};
298 auto update_barrier_parameter_and_reset_filter = [&] {
300 constexpr Scalar κ_μ(0.2);
304 constexpr Scalar θ_μ(1.5);
312 μ = std::max(μ_min, std::min(κ_μ * μ, pow(μ, θ_μ)));
319 τ = std::max(τ_min, Scalar(1) - μ);
326 gch::small_vector<Eigen::Triplet<Scalar>> triplets;
330 RegularizedLDLT<Scalar> solver{
331 matrices.num_decision_variables, matrices.num_equality_constraints,
332 in_feasibility_restoration ? Scalar(0) : Scalar(1e-10)};
335 constexpr Scalar α_reduction_factor(0.5);
336 constexpr Scalar α_min(1e-7);
338 int full_step_rejected_counter = 0;
341 Scalar E_0 = std::numeric_limits<Scalar>::infinity();
346 scope_exit exit{[&] {
347 if (options.diagnostics) {
350 if (in_feasibility_restoration) {
354 if (iterations > 0) {
355 print_bottom_iteration_diagnostics();
357 print_solver_diagnostics(solve_profilers);
361 while (E_0 > Scalar(options.tolerance)) {
362 ScopedProfiler inner_iter_profiler{inner_iter_prof};
363 ScopedProfiler feasibility_check_profiler{feasibility_check_prof};
366 if (is_equality_locally_infeasible(A_e, c_e)) {
367 if (options.diagnostics) {
368 print_c_e_local_infeasibility_error(c_e);
371 return ExitStatus::LOCALLY_INFEASIBLE;
375 if (is_inequality_locally_infeasible(A_i, c_i)) {
376 if (options.diagnostics) {
377 print_c_i_local_infeasibility_error(c_i);
380 return ExitStatus::LOCALLY_INFEASIBLE;
384 if (x.template lpNorm<Eigen::Infinity>() > Scalar(1e10) || !x.allFinite() ||
385 s.template lpNorm<Eigen::Infinity>() > Scalar(1e10) || !s.allFinite()) {
386 return ExitStatus::DIVERGING_ITERATES;
389 feasibility_check_profiler.stop();
390 ScopedProfiler iter_callbacks_profiler{iter_callbacks_prof};
393 for (
const auto& callback : iteration_callbacks) {
394 if (callback({iterations, x, s, y, z, g, H, A_e, A_i})) {
395 return ExitStatus::CALLBACK_REQUESTED_STOP;
399 iter_callbacks_profiler.stop();
400 ScopedProfiler kkt_matrix_build_profiler{kkt_matrix_build_prof};
405 const SparseMatrix Σ{s.cwiseInverse().asDiagonal() * z.asDiagonal()};
411 const SparseMatrix top_left =
412 H + (A_i.transpose() * Σ * A_i).
template triangularView<Eigen::Lower>();
414 triplets.reserve(top_left.nonZeros() + A_e.nonZeros());
415 append_as_triplets(triplets, 0, 0, {top_left, A_e});
417 matrices.num_decision_variables + matrices.num_equality_constraints,
418 matrices.num_decision_variables + matrices.num_equality_constraints);
419 lhs.setFromSortedTriplets(triplets.begin(), triplets.end());
423 DenseVector rhs{x.rows() + y.rows()};
424 rhs.segment(0, x.rows()) =
425 -g + A_e.transpose() * y +
426 A_i.transpose() * (-Σ * c_i + μ * s.cwiseInverse() + z);
427 rhs.segment(x.rows(), y.rows()) = -c_e;
429 kkt_matrix_build_profiler.stop();
430 ScopedProfiler kkt_matrix_decomp_profiler{kkt_matrix_decomp_prof};
436 bool call_feasibility_restoration =
false;
442 if (solver.compute(lhs).info() != Eigen::Success) [[unlikely]] {
443 return ExitStatus::FACTORIZATION_FAILED;
446 kkt_matrix_decomp_profiler.stop();
447 ScopedProfiler kkt_system_solve_profiler{kkt_system_solve_prof};
449 auto compute_step = [&](Step& step) {
452 DenseVector p = solver.solve(rhs);
453 step.p_x = p.segment(0, x.rows());
454 step.p_y = -p.segment(x.rows(), y.rows());
458 step.p_s = c_i - s + A_i * step.p_x;
459 step.p_z = -Σ * c_i + μ * s.cwiseInverse() - Σ * A_i * step.p_x;
463 kkt_system_solve_profiler.stop();
464 ScopedProfiler line_search_profiler{line_search_prof};
467 α_max = fraction_to_the_boundary_rule<Scalar>(s, step.p_s, τ);
472 call_feasibility_restoration =
true;
476 α_z = fraction_to_the_boundary_rule<Scalar>(z, step.p_z, τ);
478 const FilterEntry<Scalar> current_entry{f, s, c_e, c_i, μ};
482 DenseVector trial_x = x + α * step.p_x;
483 DenseVector trial_y = y + α_z * step.p_y;
484 DenseVector trial_z = z + α_z * step.p_z;
486 Scalar trial_f = matrices.f(trial_x);
487 DenseVector trial_c_e = matrices.c_e(trial_x);
488 DenseVector trial_c_i = matrices.c_i(trial_x);
492 if (!isfinite(trial_f) || !trial_c_e.allFinite() ||
493 !trial_c_i.allFinite()) {
495 α *= α_reduction_factor;
498 call_feasibility_restoration =
true;
505 if (options.feasible_ipm && c_i.cwiseGreater(Scalar(0)).all()) {
512 trial_s = s + α * step.p_s;
516 FilterEntry trial_entry{trial_f, trial_s, trial_c_e, trial_c_i, μ};
517 if (filter.try_add(current_entry, trial_entry, step.p_x, g, α)) {
522 Scalar prev_constraint_violation =
523 c_e.template lpNorm<1>() + (c_i - s).
template lpNorm<1>();
524 Scalar next_constraint_violation =
525 trial_c_e.template lpNorm<1>() +
526 (trial_c_i - trial_s).
template lpNorm<1>();
533 next_constraint_violation >= prev_constraint_violation) {
535 auto soc_step = step;
538 Scalar α_z_soc = α_z;
539 DenseVector c_e_soc = c_e;
541 bool step_acceptable =
false;
542 for (
int soc_iteration = 0; soc_iteration < 5 && !step_acceptable;
544 ScopedProfiler soc_profiler{soc_prof};
546 scope_exit soc_exit{[&] {
549 if (options.diagnostics) {
550 print_iteration_diagnostics(
552 step_acceptable ? IterationType::ACCEPTED_SOC
553 : IterationType::REJECTED_SOC,
554 soc_profiler.current_duration(),
555 kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(
556 g, A_e, trial_c_e, A_i, trial_c_i, trial_s, trial_y,
559 trial_c_e.template lpNorm<1>() +
560 (trial_c_i - trial_s).template lpNorm<1>(),
561 trial_s.dot(trial_z), μ, solver.hessian_regularization(),
562 α_soc, Scalar(1), α_reduction_factor, α_z_soc);
572 c_e_soc = α_soc * c_e_soc + trial_c_e;
573 rhs.bottomRows(y.rows()) = -c_e_soc;
576 compute_step(soc_step);
579 α_soc = fraction_to_the_boundary_rule<Scalar>(s, soc_step.p_s, τ);
580 trial_x = x + α_soc * soc_step.p_x;
581 trial_s = s + α_soc * soc_step.p_s;
584 α_z_soc = fraction_to_the_boundary_rule<Scalar>(z, soc_step.p_z, τ);
585 trial_y = y + α_z_soc * soc_step.p_y;
586 trial_z = z + α_z_soc * soc_step.p_z;
588 trial_f = matrices.f(trial_x);
589 trial_c_e = matrices.c_e(trial_x);
590 trial_c_i = matrices.c_i(trial_x);
593 constexpr Scalar κ_soc(0.99);
597 next_constraint_violation =
598 trial_c_e.template lpNorm<1>() +
599 (trial_c_i - trial_s).
template lpNorm<1>();
600 if (next_constraint_violation > κ_soc * prev_constraint_violation) {
605 FilterEntry trial_entry{trial_f, trial_s, trial_c_e, trial_c_i, μ};
606 if (filter.try_add(current_entry, trial_entry, step.p_x, g, α)) {
610 step_acceptable =
true;
614 if (step_acceptable) {
624 ++full_step_rejected_counter;
631 if (full_step_rejected_counter >= 4 &&
632 filter.max_constraint_violation >
633 current_entry.constraint_violation / Scalar(10) &&
634 filter.last_rejection_due_to_filter()) {
635 filter.max_constraint_violation *= Scalar(0.1);
641 α *= α_reduction_factor;
646 Scalar current_kkt_error = kkt_error<Scalar, KKTErrorType::ONE_NORM>(
647 g, A_e, c_e, A_i, c_i, s, y, z, μ);
649 trial_x = x + α_max * step.p_x;
650 trial_s = s + α_max * step.p_s;
652 trial_y = y + α_z * step.p_y;
653 trial_z = z + α_z * step.p_z;
655 trial_c_e = matrices.c_e(trial_x);
656 trial_c_i = matrices.c_i(trial_x);
658 Scalar next_kkt_error = kkt_error<Scalar, KKTErrorType::ONE_NORM>(
659 matrices.g(trial_x), matrices.A_e(trial_x), matrices.c_e(trial_x),
660 matrices.A_i(trial_x), trial_c_i, trial_s, trial_y, trial_z, μ);
663 if (next_kkt_error <= Scalar(0.999) * current_kkt_error) {
670 call_feasibility_restoration =
true;
675 line_search_profiler.stop();
677 if (call_feasibility_restoration) {
679 if (in_feasibility_restoration) {
680 return ExitStatus::FEASIBILITY_RESTORATION_FAILED;
683 FilterEntry initial_entry{matrices.f(x), s, c_e, c_i, μ};
686 gch::small_vector<std::function<bool(
const IterationInfo<Scalar>& info)>>
688 for (
auto& callback : iteration_callbacks) {
689 callbacks.emplace_back(callback);
691 callbacks.emplace_back([&](
const IterationInfo<Scalar>& info) {
692 DenseVector trial_x =
693 info.x.segment(0, matrices.num_decision_variables);
694 DenseVector trial_s =
695 info.s.segment(0, matrices.num_inequality_constraints);
697 DenseVector trial_c_e = matrices.c_e(trial_x);
698 DenseVector trial_c_i = matrices.c_i(trial_x);
702 FilterEntry trial_entry{matrices.f(trial_x), trial_s, trial_c_e,
704 return trial_entry.constraint_violation <
705 Scalar(0.9) * initial_entry.constraint_violation &&
706 filter.try_add(initial_entry, trial_entry, trial_x - x, g, α);
708 auto status = feasibility_restoration<Scalar>(matrices, callbacks,
709 options, x, s, y, z, μ);
711 if (status != ExitStatus::SUCCESS) {
718 full_step_rejected_counter = 0;
743 for (
int row = 0; row < z.rows(); ++row) {
744 constexpr Scalar κ_Σ(1e10);
746 std::clamp(z[row], Scalar(1) / κ_Σ * μ / s[row], κ_Σ * μ / s[row]);
752 A_e = matrices.A_e(x);
753 A_i = matrices.A_i(x);
755 H = matrices.H(x, y, z);
757 ScopedProfiler next_iter_prep_profiler{next_iter_prep_prof};
759 c_e = matrices.c_e(x);
760 c_i = matrices.c_i(x);
763 E_0 = kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(
764 g, A_e, c_e, A_i, c_i, s, y, z, Scalar(0));
767 if (E_0 > Scalar(options.tolerance)) {
769 constexpr Scalar κ_ε(10);
773 Scalar E_μ = kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(
774 g, A_e, c_e, A_i, c_i, s, y, z, μ);
775 while (μ > μ_min && E_μ <= κ_ε * μ) {
776 update_barrier_parameter_and_reset_filter();
777 E_μ = kkt_error<Scalar, KKTErrorType::INF_NORM_SCALED>(g, A_e, c_e, A_i,
782 next_iter_prep_profiler.stop();
783 inner_iter_profiler.stop();
785 if (options.diagnostics) {
786 print_iteration_diagnostics(
788 in_feasibility_restoration ? IterationType::FEASIBILITY_RESTORATION
789 : IterationType::NORMAL,
790 inner_iter_profiler.current_duration(), E_0, f,
791 c_e.template lpNorm<1>() + (c_i - s).template lpNorm<1>(), s.dot(z),
792 μ, solver.hessian_regularization(), α, α_max, α_reduction_factor,
799 if (iterations >= options.max_iterations) {
800 return ExitStatus::MAX_ITERATIONS_EXCEEDED;
804 if (std::chrono::steady_clock::now() - solve_start_time > options.timeout) {
805 return ExitStatus::TIMEOUT;
809 return ExitStatus::SUCCESS;
812extern template SLEIPNIR_DLLEXPORT ExitStatus
813interior_point(
const InteriorPointMatrixCallbacks<double>& matrix_callbacks,
814 std::span<std::function<
bool(
const IterationInfo<double>& info)>>
816 const Options& options,
817#ifdef SLEIPNIR_ENABLE_BOUND_PROJECTION
818 const Eigen::ArrayX<bool>& bound_constraint_mask,
820 Eigen::Vector<double, Eigen::Dynamic>& x);