1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
//! Main optimization loop — port of
//! `Algorithm/IpIpoptAlg.{hpp,cpp}`.
//!
//! Phase 7 ships the loop scaffold matching `Optimize()` lines
//! 292-563 in upstream. The body invokes:
//!
//! 1. `IterateInitializer::set_initial_iterates`
//! 2. (loop) `OutputIteration` → `CheckConvergence` →
//! `UpdateBarrierParameter` → `UpdateHessian` →
//! `ComputeSearchDirection` → `ComputeAcceptableTrialPoint` →
//! `AcceptTrialPoint`
//! 3. `correct_bound_multiplier` (kappa_sigma) per `MAIN_LOOP.md`
//! §"Bound multiplier reset" lines 1055-1134
//! 4. exception → `SolverReturn` mapping per the table in
//! `MAIN_LOOP.md`.
//!
//! The NLP handle and search-direction calculator are optional:
//! when both are present, `iterate()` computes a real Newton step and
//! drives the line search. Without them, `iterate()` runs the bookkeeping
//! pieces (mu update, hessian update, conv check, kappa_sigma reset)
//! and is exercised by structural unit tests. The full path lights up
//! once `pounce-nlp::OrigIpoptNLP` lands.
use crate::alg_builder::AlgorithmBundle;
use crate::conv_check::r#trait::ConvergenceStatus;
use crate::intermediate::{CtxGuard, IntermediateContext};
use crate::ipopt_cq::IpoptCqHandle;
use crate::ipopt_data::IpoptDataHandle;
use crate::ipopt_nlp::IpoptNlp;
use crate::iter_dump::IterDumper;
use crate::iterate_dump::emit_record as emit_iterate_record;
use crate::kkt::pd_search_dir_calc::PdSearchDirCalc;
use crate::line_search::backtracking::Outcome;
use crate::restoration::{RestorationOutcome, RestorationPhase};
use pounce_common::diagnostics::DiagnosticsState;
use pounce_common::types::{Index, Number};
use pounce_linalg::Vector;
use pounce_nlp::alg_types::SolverReturn;
use pounce_nlp::return_codes::AlgorithmMode;
use pounce_nlp::tnlp::{IpoptCq as TnlpIpoptCq, IpoptData as TnlpIpoptData, IterStats, TNLP};
use std::cell::RefCell;
use std::rc::Rc;
/// Dual-divergence guard (pounce#246): only dual-infeasibility growth in the
/// *elevated* regime (`inf_du` above this) counts toward the streak, so the
/// noisy early iterations of a normal solve never build one.
const DUAL_DIV_COUNT_FLOOR: Number = 1e2;
/// Dual-divergence guard: the guard fires only once `inf_du` is this large in
/// absolute terms — well above the transient peaks a converging solve reaches
/// (e.g. the least-square-init path recovers from ~6e9 on emfl050), and below
/// the ~1e10 where the KKT factorizations begin to choke, so the diversion to
/// restoration happens *before* the seconds-long factorizations start.
const DUAL_DIV_FIRE_TOL: Number = 1e8;
/// gh #534 — how many consecutive outer NLP errors the progress test reads.
/// Four samples give three ratios: enough that a single lucky step cannot pass
/// the test, short enough to still be inside the endgame it is meant to
/// recognise. `eigena2`'s quoted tail is exactly four iterations long
/// (`1.19e-5 → 2.96e-6 → 7.38e-7 → 1.84e-7`).
const DECLINE_PROGRESS_SAMPLES: usize = 4;
/// gh #534 — default `resto_decline_progress_ratio`: every one of those ratios
/// must be at least this contraction for the decline to be deferred. `eigena2`
/// quarters (ratio `0.249`) and passes; `eigenb2`'s tail *rises*
/// (`1.88e-7, 2.69e-7, 2.89e-7, 2.93e-7`) and fails, which is the intended
/// split — the issue calls `eigenb2` a plausible genuine stall and the guard
/// plausibly right there.
const DEFAULT_DECLINE_PROGRESS_RATIO: Number = 0.5;
/// gh #534 — outer iterations a deferred continuation gets to produce a strict
/// certificate before it is cut and the floor reported. `eigena2`'s
/// extrapolation needs three; ten leaves room for a slower but still genuine
/// endgame while keeping the cost of a lost bet bounded and small.
const DECLINE_CONTINUATION_BUDGET: Index = 10;
/// gh #534 — default for `resto_decline_deferrals`. One deferral is enough for
/// the reported case (the continuation either converges within the budget or it
/// does not); more entries would mostly re-bet on a point the first bet already
/// failed to improve.
const DEFAULT_RESTO_DECLINE_DEFERRALS: usize = 1;
pub struct IpoptAlgorithm {
pub data: IpoptDataHandle,
pub cq: IpoptCqHandle,
pub bundle: AlgorithmBundle,
/// Optional NLP handle. Required for any step that evaluates
/// problem functions or pulls bound expansion matrices (init,
/// search direction, line-search trial-point evaluation). Absent
/// in the structural unit tests of Phases 5-6.
pub nlp: Option<Rc<RefCell<dyn IpoptNlp>>>,
/// Optional TNLP handle — the user-facing problem. When present,
/// `iterate()` fires `TNLP::intermediate_callback` once per outer
/// iteration so callers can monitor progress or request early
/// termination (returning `false` from the callback surfaces as
/// `SolverReturn::UserRequestedStop`). Kept separate from `nlp`
/// because the algorithm-side NLP is the *compressed* `OrigIpoptNlp`
/// view (fixed-variable elimination, c/d split) while the callback
/// payload needs to expose the original-coordinate iterate.
pub tnlp: Option<Rc<RefCell<dyn TNLP>>>,
/// Search-direction calculator (`PdSearchDirCalc`). Lands once a
/// concrete `SymLinearSolver` backend (MUMPS / FERAL) is wired
/// through `AlgBuilder` in Phase 7's tail.
pub search_dir: Option<PdSearchDirCalc>,
/// Restoration-phase strategy. Invoked when the line search
/// returns [`Outcome::Failed`] (port of upstream
/// `IpBacktrackingLineSearch::ActivateLineSearch`'s resto
/// fallback). Optional: in its absence, line-search failure maps
/// directly to [`SolverReturn::RestorationFailure`] so the main
/// loop's exit-code semantics match upstream's "no resto built"
/// case.
pub restoration: Option<Box<dyn RestorationPhase>>,
/// `kappa_sigma` for the post-AcceptTrialPoint multiplier reset
/// (`IpIpoptAlg.cpp:correct_bound_multiplier`, line 1055-1134).
pub kappa_sigma: Number,
pub max_iter: Index,
/// Initial primal step length offered to the line search at the
/// top of each iteration. Mirrors `IpBacktrackingLineSearch`'s
/// fraction-to-the-boundary primal step (with τ = `data.curr_tau`).
/// In v1.0 the structural value here is 1.0 and the FTB cap is
/// applied per-component when the line-search driver computes
/// trial slacks; the simplification holds for non-degenerate runs.
pub alpha_init: Number,
/// Tiny-step relative tolerance — port of upstream
/// `IpBacktrackingLineSearch::tiny_step_tol_` (default `10·EPSILON`).
/// Step is "tiny" when `max_i |δx_i|/(1+|x_i|) ≤ tiny_step_tol`
/// (and same for s, and `c_viol ≤ 1e-4`).
pub tiny_step_tol: Number,
/// Port of upstream `IpIpoptAlg.cpp` divergence guard: when
/// `max_i |x_i|` exceeds this threshold the optimization aborts with
/// `SolverReturn::DivergingIterates`. Default `1e20` matches the
/// registered `diverging_iterates_tol` option. Catches MESH and
/// similar cases where the normal-mode IPM heads off to infinity
/// (orig `f` to ±1e33 by iter 90) before line-search failure forces
/// a degenerate restoration entry.
pub diverging_iterates_tol: Number,
/// #248 divergence persistence — consecutive iterations the primal
/// iterate has kept *growing* while past `diverging_iterates_tol` on a
/// structurally unbounded side. A genuine recession ray sustains this;
/// a transient ill-scaling excursion on a bounded-below problem peaks
/// and recedes (MINLPLib `jit1`: `|x|` climbs to ~16 then falls back to
/// ~2.9 at the finite optimum). Reset to zero whenever the iterate is
/// within the threshold or is not growing.
divergence_streak: u32,
/// Largest `|x|` seen in the current growth run (companion to
/// [`Self::divergence_streak`]). Zero when no run is active.
divergence_prev_amax: Number,
/// #252 objective at the previous over-threshold iterate of the current
/// growth run (companion to [`Self::divergence_streak`]). A genuine
/// recession ray drives the (minimized) objective toward `−∞`, so a
/// diverging iterate only counts toward the streak when the objective is
/// *still descending* against this reference. A transient ill-scaling
/// excursion past a finite optimum grows `|x|` while the objective
/// *worsens* (the linear tail dominates), so it never accumulates the
/// streak — this is the fix for the unbounded-box (`ub = +∞`) B&B node
/// subproblems of jit1 that #248's growth-only check still mislabelled
/// `UNBOUNDED`. `+∞` when no run is active.
divergence_prev_f: Number,
/// #252 objective *decrease* at the previous step of the current growth
/// run (`prev_prev_f − prev_f`), the companion that lets the streak
/// require the descent to be *non-decelerating*. A recession ray's
/// per-step objective drop keeps up or accelerates as `|x|` grows
/// geometrically (`f` is at least linear along the ray); an excursion
/// converging to a finite optimum has a per-step drop that shrinks
/// toward zero. `NaN` (non-finite) until the run has a first finite
/// decrease to compare against, which bootstraps the check.
divergence_prev_decrease: Number,
/// #285 recession-ray persistence — consecutive iterations for which the
/// *checked recession-ray proof* ([`Self::curr_is_recession_ray`]) held
/// while the primal iterate kept growing. This is a second, independent
/// unboundedness path that catches a genuine recession ray in
/// `null(A_eq)` over free variables whose `|x|` grows only *linearly*
/// (the regularized zero-Hessian step in an equality null space marches
/// out at a bounded rate), so it never crosses `diverging_iterates_tol`
/// (`1e20`) within `max_iter` and the geometric-growth
/// [`Self::divergence_streak`] never accumulates. Reset to zero whenever
/// the proof fails or the iterate stops growing.
recession_streak: u32,
/// Largest `|x|` seen in the current recession-ray run (companion to
/// [`Self::recession_streak`]). Zero when no run is active.
recession_prev_amax: Number,
/// Companion threshold on the dual step — when both primal and dual
/// steps are tiny in two consecutive iterations the algorithm
/// declares convergence at the best attainable accuracy. Default
/// `1e-2` matches upstream.
pub tiny_step_y_tol: Number,
/// `dual_diverging_streak` (pounce#246) — number of consecutive
/// iterations of *growing* dual infeasibility (in the elevated regime,
/// `inf_du > `[`DUAL_DIV_COUNT_FLOOR`]) that must accumulate before the
/// dual-divergence guard fires. When the streak reaches the limit and
/// `inf_du > `[`DUAL_DIV_FIRE_TOL`], the outer routes to restoration.
///
/// **`0` (off) is the default**, set from the option of the same name
/// (`application.rs`). It defaulted to `15` when introduced; see the option
/// help in `upstream_options.rs` for why that changed, and
/// [`Self::honour_best_acceptable_after_dual_guard`] for what protects a
/// solve when it is enabled. See the guard itself in [`Self::iterate`].
pub dual_diverging_streak: usize,
dual_inf_prev: Number,
dual_growth_streak: usize,
/// Set true when the previous iterate was tagged tiny; on the
/// second consecutive tiny step the loop sets `data.tiny_step_flag`
/// so the mu update can attempt to terminate. Mirrors
/// `IpBacktrackingLineSearch::tiny_step_last_iteration_`.
pub tiny_step_last_iteration: bool,
/// Cycle-detection state for [`Self::invoke_restoration`]: the
/// outer `(x, s)` snapshot from the previous restoration entry,
/// cleared on any iteration that exits via a normal line-search
/// accept. When restoration is invoked twice in a row and the
/// outer iterate has not moved between entries (relative
/// 2-norm < 1e-10 on both `x` and `s`), the inner resto-IPM is
/// returning Recovered points indistinguishable from `curr` — a
/// cycle. Surfaces as `ErrorInStepComputation`. Mirrors the
/// *intent* of upstream `IpBacktrackingLineSearch.cpp:580-600`'s
/// almost-feasible-resto guard while staying robust against the
/// `inf_pr` micro-drift seen on ACOPR14 (delta ~3e-12 per entry,
/// inf_du essentially constant) where a scalar-`inf_pr` heuristic
/// fails. Productive single-restoration sequences (BT8, HIMMELBJ,
/// LINSPANH, LSNNODOC, ODFITS, OET3) clear the snapshot via
/// `Outcome::Accepted` between entries and are unaffected.
last_resto_entry_x: Option<Box<dyn Vector>>,
last_resto_entry_s: Option<Box<dyn Vector>>,
/// Snapshot of the *recovery* iterate from the previous
/// restoration. Compared against the next entry's `(x, s)` to
/// detect "outer made no progress between consecutive resto
/// invocations". When this distance is below threshold for
/// several consecutive entries, terminate — catching
/// slow-non-convergence cycles (ACOPR14, TRO3X3, ACOPR30) where
/// resto's *inner* moves substantively each call but the *outer*
/// makes no progress between calls. Cleared on any LS-accepted
/// step.
last_resto_recovery_x: Option<Box<dyn Vector>>,
last_resto_recovery_s: Option<Box<dyn Vector>>,
/// Count of consecutive restoration entries on which the outer
/// step (recovery → next-entry) was below the iterate-distance
/// threshold. Cleared on any LS-accepted step. Limit chosen to
/// let MAKELA3, HAIFAM, HALDMADS, ROBOT, TENBARS2 — which need
/// 2-3 consecutive resto entries to recover — pass through.
resto_no_outer_progress_count: usize,
/// `resto_decline_deferrals` (gh #534) — how many times the
/// acceptable-point restoration decline in [`Self::invoke_restoration`] may
/// be *deferred* on a solve whose NLP error is still contracting. `0`
/// restores the pre-#534 behaviour (decline immediately, always).
///
/// See [`Self::may_defer_acceptable_decline`] for the progress test and
/// [`Self::honour_decline_floor`] for what makes a spent deferral harmless.
pub resto_decline_deferrals: usize,
/// `resto_decline_progress_ratio` (gh #534) — the contraction each of the
/// last [`DECLINE_PROGRESS_SAMPLES`]` - 1` iterations must have achieved for
/// the decline to be deferred. Default
/// [`DEFAULT_DECLINE_PROGRESS_RATIO`]. A value of `1` admits any
/// non-increasing window and a large one drops the progress requirement
/// altogether, which is the "patch the guard and see" experiment the issue
/// asks for, available without patching.
pub resto_decline_progress_ratio: Number,
/// The most recent outer-iteration NLP errors, oldest first, with
/// [`Self::nlp_err_recent_len`] entries live. Feeds the gh #534 progress
/// test and nothing else.
nlp_err_recent: [Number; DECLINE_PROGRESS_SAMPLES],
nlp_err_recent_len: usize,
/// gh #534 — deferrals of the acceptable-point decline spent so far.
decline_deferrals_used: usize,
/// gh #534 — the iterate the guard would have returned had it not been
/// deferred. Captured at the *first* deferral only, because that point is
/// precisely the answer the pre-#534 build reports; it is the floor the
/// continuation is never allowed to fall below.
decline_floor: Option<VetoSnapshot>,
/// gh #534 — outer iteration by which the deferred continuation must have
/// produced a strict certificate. Past it the continuation is cut and the
/// floor is reported, so the bet costs a bounded number of iterations.
decline_deadline_iter: Option<Index>,
/// Count of consecutive restoration entries on which the outer
/// constraint violation at entry was already below `tol` (the
/// outer optimality tolerance). Matches the *intent* of upstream
/// `IpBacktrackingLineSearch.cpp:580-600`'s almost-feasible-resto
/// guard while using a looser cv threshold (`tol` vs `1e-2·tol`)
/// — catches DECONVBNE's resto-thrash where each cycle re-enters
/// at cv ≈ 3e-10 < tol with bound multipliers reset to 1, the
/// outer's σ-blowup explodes inf_du to 1.9e7, alpha-min triggers
/// resto re-entry, and the (inf_pr, inf_du) post-recovery state
/// is essentially identical across cycles but `x` drifts enough
/// that [`Self::last_resto_recovery_x`]-based detection misses.
/// Cumulative (never cleared on LS-accept), since DECONVBNE's
/// cycle interleaves R-recoveries with sub-tol accepts that
/// accomplish no real outer progress. Fires after 3 near-feasible
/// entries — surfaces as `StopAtAcceptablePoint` since the
/// recovered point already satisfies constraint feasibility
/// within `tol`.
resto_near_feasible_count: usize,
/// Snapshot of the most recent iterate that the convergence check
/// flagged "acceptable" (NLP error ≤ `acceptable_tol`). Mirrors
/// upstream `IpBacktrackingLineSearch::acceptable_iterate_`
/// (`IpBacktrackingLineSearch.cpp:1286-1310`). Used by
/// [`Self::restore_acceptable_point`] to roll back when restoration
/// fails — if such an iterate exists, the algorithm exits with
/// `SolverReturn::StopAtAcceptablePoint` rather than
/// `RestorationFailure`. Cleared/refreshed on every iteration that
/// satisfies the acceptable predicate.
acceptable_iterate: Option<crate::iterates_vector::IteratesVector>,
/// The first iterate whose *strict* certificate the masked-scale veto
/// refused (gh #200), kept so the refusal can be undone verbatim if the
/// continued run does not do better. Deliberately not the acceptable
/// snapshot: that one is overwritten unconditionally and drifts.
vetoed: Option<VetoSnapshot>,
/// The iterate at which a refused *acceptable-level* termination would have
/// fired. Held separately from `vetoed` because it restores under a weaker
/// status, and claiming `Success` for it would over-report.
vetoed_acceptable: Option<VetoSnapshot>,
/// Whether a strict refusal has already been *seen*, independent of whether
/// a snapshot was successfully captured for it.
///
/// This is the first-only latch, held apart from `vetoed` on purpose.
/// Testing `vetoed.is_none()` instead would let a refusal whose capture
/// failed be "completed" at a later iterate — the veto flag on the
/// convergence check is sticky, so it still reads true next pass, and the
/// fallback would then restore a point that never passed the strict test.
/// With the latch, a failed capture stays failed and the fallback declines.
///
/// Declining is *not* the baseline outcome — the baseline stopped and
/// reported a certificate at the uncaptured iterate, and declining fails to
/// reproduce it. It is the least-bad handling of an unidentifiable baseline,
/// not a faithful one.
vetoed_seen: bool,
/// Same latch for the acceptable-level refusal.
vetoed_acceptable_seen: bool,
/// Whether the dual-divergence guard (pounce#246) actually fired this
/// solve. Gates the *use* of [`Self::best_acceptable`], so solves the guard
/// never touches behave identically — see
/// [`Self::honour_best_acceptable_after_dual_guard`].
dual_guard_fired: bool,
/// Best (lowest scaled objective) acceptable-quality iterate seen anywhere
/// in this solve. Recorded unconditionally — including *before* any
/// diversion, which is the point: the guard returns to the driver before
/// the recording site on the iteration it fires, so gating the recording on
/// `dual_guard_fired` would miss everything up to and including the
/// diversion. Only read when `dual_guard_fired`.
best_acceptable: Option<VetoSnapshot>,
/// `kkt_fidelity_tol` (pounce#173), needed here — not just at termination —
/// because the fallback's tiebreak has to predict the post-solve status
/// gate. See [`Self::honour_refused_certificate`]. Zero (the default)
/// disables the gate, and with it every tiebreak effect it has.
pub kkt_fidelity_tol: Number,
acceptable_iter_number: Index,
/// Shared per-solve diagnostics state. `None` unless the CLI
/// requested `--dump <cat>:<spec>`. When set, the outer loop
/// advances the state's iter counter and the augmented-system
/// solver consults it to gate KKT dumps.
diagnostics: Option<Rc<DiagnosticsState>>,
/// Optional interactive debugger. Shared (`Rc<RefCell<…>>`) so the
/// same debugger instance also drives the restoration inner IPM —
/// one debugger sees both levels. Fired at every
/// [`crate::debug::Checkpoint`]. See `crate::debug`.
debug: Option<Rc<RefCell<dyn crate::debug::DebugHook>>>,
// ---- Restoration-phase audit counters (pounce#12). ----
//
// Drained into `SolveStatistics` by `IpoptApplication::optimize_constrained`
// after the solve completes. Counts are cumulative across the run.
/// Number of `invoke_restoration` entries.
pub resto_calls: Index,
/// Sum of inner-IPM iter counts across every restoration call.
pub resto_inner_iters: Index,
/// Number of outer iters that ran in restoration mode (R-line
/// equivalents in `print_level=5` output).
pub resto_outer_iters: Index,
/// Cumulative wall-clock seconds spent inside `perform_restoration`.
pub resto_wall_secs: Number,
// ---- Per-iteration history capture (pounce#8, pounce#71). ----
//
// The per-iteration trajectory is no longer accumulated on the
// algorithm: `iterate()` emits a structured `pounce::iteration`
// event each step, and `pounce_observability::IterCollectorLayer`
// rebuilds the `IterRecord`s into the active `IterCaptureGuard`
// that `IpoptApplication` installs around the solve.
/// When `false`, the per-iteration table that `iterate()` writes
/// straight to stdout is suppressed. Wired from
/// `IpoptApplication`'s `print_level` option: level 0 turns this
/// off (matches upstream's "no console output" contract). Default
/// `true` so CLI / direct-driver users keep the familiar trace.
pub print_iter_output: bool,
}
impl IpoptAlgorithm {
pub fn new(data: IpoptDataHandle, cq: IpoptCqHandle, mut bundle: AlgorithmBundle) -> Self {
// The builder may pre-populate `bundle.search_dir` when given a
// `LinearBackendFactory`; lift it onto the algorithm so the
// iterate body can call into it directly.
let search_dir = bundle.search_dir.take();
Self {
data,
cq,
bundle,
nlp: None,
tnlp: None,
search_dir,
restoration: None,
kappa_sigma: 1e10,
max_iter: 3000,
alpha_init: 1.0,
tiny_step_tol: 10.0 * Number::EPSILON,
diverging_iterates_tol: 1e20,
divergence_streak: 0,
divergence_prev_amax: 0.0,
divergence_prev_f: Number::INFINITY,
divergence_prev_decrease: Number::NAN,
recession_streak: 0,
recession_prev_amax: 0.0,
tiny_step_y_tol: 1e-2,
dual_diverging_streak: 15,
dual_inf_prev: 0.0,
dual_growth_streak: 0,
tiny_step_last_iteration: false,
last_resto_entry_x: None,
last_resto_entry_s: None,
last_resto_recovery_x: None,
last_resto_recovery_s: None,
resto_no_outer_progress_count: 0,
resto_decline_deferrals: DEFAULT_RESTO_DECLINE_DEFERRALS,
resto_decline_progress_ratio: DEFAULT_DECLINE_PROGRESS_RATIO,
nlp_err_recent: [Number::NAN; DECLINE_PROGRESS_SAMPLES],
nlp_err_recent_len: 0,
decline_deferrals_used: 0,
decline_floor: None,
decline_deadline_iter: None,
resto_near_feasible_count: 0,
acceptable_iterate: None,
vetoed: None,
vetoed_acceptable: None,
dual_guard_fired: false,
best_acceptable: None,
vetoed_seen: false,
vetoed_acceptable_seen: false,
kkt_fidelity_tol: 0.0,
acceptable_iter_number: 0,
diagnostics: None,
debug: None,
resto_calls: 0,
resto_inner_iters: 0,
resto_outer_iters: 0,
resto_wall_secs: 0.0,
print_iter_output: true,
}
}
/// Stash the current iterate as the "last acceptable" backup —
/// port of `IpBacktrackingLineSearch::StoreAcceptablePoint`
/// (`IpBacktrackingLineSearch.cpp:1286-1293`).
fn store_acceptable_point(&mut self) {
let d = self.data.borrow();
if let Some(curr) = d.curr.as_ref() {
self.acceptable_iterate = Some(curr.clone());
self.acceptable_iter_number = d.iter_count;
}
}
/// Record this outer iteration's NLP error for the gh #534 progress test.
///
/// One push per `iterate()` call, so the samples are consecutive outer
/// iterations by construction. Deliberately *not* cleared when restoration
/// recovers: a recovery that helped shows up as continued contraction and a
/// recovery that hurt shows up as a jump, and the ratio test reads both
/// correctly without needing to know which happened.
fn note_nlp_err(&mut self, nlp_err: Number) {
push_sample(
&mut self.nlp_err_recent,
&mut self.nlp_err_recent_len,
nlp_err,
);
}
/// Whether the last [`DECLINE_PROGRESS_SAMPLES`] outer iterations each cut
/// the NLP error by at least `resto_decline_progress_ratio` (gh #534).
///
/// The question the restoration-decline guard never asked: *is this solve
/// still converging?* A full window is required, so the test cannot pass on
/// a short history — the early iterations of every solve included.
///
/// The test itself lives in the pure [`window_is_contracting`], for the
/// reason [`ranks_better_within_band`] does: what it must and must not fire
/// on is stated in the issue as two recorded traces, and those are provable
/// by deterministic unit test rather than inferable from a solve.
fn nlp_err_contracting(&self) -> bool {
if self.nlp_err_recent_len < DECLINE_PROGRESS_SAMPLES {
return false;
}
window_is_contracting(&self.nlp_err_recent, self.resto_decline_progress_ratio)
}
/// The live progress window, oldest first, for the gh #534 trace lines.
fn nlp_err_window_str(&self) -> String {
let live = &self.nlp_err_recent[..self.nlp_err_recent_len];
let parts: Vec<String> = live.iter().map(|e| format!("{e:.3e}")).collect();
format!("[{}]", parts.join(" -> "))
}
/// Roll the iterate back to the last acceptable snapshot — port of
/// `IpBacktrackingLineSearch::RestoreAcceptablePoint`
/// (`IpBacktrackingLineSearch.cpp:1295-1310`). Returns `true` if a
/// snapshot was available and applied; `false` otherwise (caller
/// then surfaces the original failure status).
fn restore_acceptable_point(&mut self) -> bool {
let Some(prev) = self.acceptable_iterate.clone() else {
return false;
};
let mut d = self.data.borrow_mut();
d.set_trial(prev);
// `accept_trial_point` promotes `trial → curr`, mirroring the
// upstream sequence `set_trial(...); AcceptTrialPoint();`.
d.accept_trial_point();
true
}
/// Whether a diverging primal iterate is consistent with the feasible
/// region actually being *unbounded* (issue #248).
///
/// `DivergingIterates` is Ipopt's unboundedness verdict, but a large
/// `|x_i|` only proves unboundedness if variable `i` is free to escape
/// to infinity in the direction it is heading — i.e. it has no finite
/// bound on that side. This lifts a vector of ones from the compressed
/// lower/upper bound spaces through the `Px_L` / `Px_U` expansion
/// matrices to obtain full-length indicators of which variables carry a
/// finite bound, then returns `true` only when some component whose
/// magnitude exceeds `diverging_iterates_tol` is heading toward a side
/// with no finite bound.
///
/// When every large component is pinned by a finite bound — in
/// particular when all variables are boxed, so the feasible region is a
/// bounded box and unboundedness is structurally impossible — this
/// returns `false`, and the caller reports the best iterate via the
/// normal convergence / restoration path instead of a spurious
/// `Unbounded`.
/// #248: consecutive growing, over-threshold iterations required before
/// a structurally-free divergence is reported as `DivergingIterates`.
/// `jit1`'s transient excursion lasts ~2 growing steps and then
/// recedes, so a small persistence requirement clears it without
/// materially delaying a genuine ray.
const DIVERGENCE_PERSIST_ITERS: u32 = 4;
/// #248: an iterate counts as "still growing" toward divergence when it
/// grows at least this factor over the previous over-threshold iterate.
/// A recession ray in an interior-point method grows geometrically; an
/// iterate settling onto a finite optimum above the threshold does not.
const DIVERGENCE_GROWTH_FACTOR: Number = 2.0;
/// #252: the objective descent must *keep up* — each step's drop must be
/// at least this fraction of the previous step's drop for the iterate to
/// count toward the divergence streak. A recession ray descends `f` to
/// `−∞` with per-step drops that grow (ratio ≥ 1) as `|x|` grows
/// geometrically; an excursion converging to a finite optimum decelerates
/// (ratio → 0). The slack below 1 tolerates ordinary interior-point noise
/// on a genuine ray without admitting a decelerating excursion — jit1's
/// node subproblems shrink the drop by 3–15× per step, far past this bar.
const DIVERGENCE_DESCENT_KEEPUP: Number = 0.9;
/// #248: absolute runaway backstop. An iterate this large is reported
/// unbounded regardless of persistence. It sits at or below the default
/// `diverging_iterates_tol = 1e20`, so the default behaviour (fire the
/// instant `|x|` crosses the threshold) is preserved, while a low
/// user threshold no longer fires on the way to a finite optimum.
const DIVERGENCE_ABS_RUNAWAY: Number = 1e18;
/// #285: magnitude floor for the checked recession-ray unboundedness path.
/// Below this the (slightly more expensive) recession proof is not even
/// attempted, so it is inert on every normal, well-scaled solve. Above it,
/// unboundedness is only ever concluded through the full checked proof in
/// [`Self::curr_is_recession_ray`] — a genuinely *feasible* iterate of this
/// magnitude already witnesses an unbounded feasible region, and the proof
/// additionally certifies the escape direction. Sits far below the
/// `diverging_iterates_tol` (`1e20`) magnitude guard so a linearly-growing
/// ray (which never reaches `1e20` within `max_iter`) is still caught.
const RECESSION_MIN_NORM: Number = 1e10;
/// #285: consecutive growing, proof-passing iterations required before the
/// recession-ray path reports `DivergingIterates`. A bounded feasible
/// region cannot supply a *growing* sequence of feasible over-floor
/// iterates, so persistence is defense-in-depth against a lone numerical
/// fluke rather than a soundness requirement.
const RECESSION_PERSIST_ITERS: u32 = 4;
/// #285: relative feasibility bar for the recession proof. The current
/// iterate counts as feasible (hence a witness that the feasible region
/// reaches its magnitude) when its unscaled max-norm primal infeasibility
/// is at most this fraction of `|x|_∞`. The check is *relative* on purpose:
/// evaluating `A_eq x − b` at `|x| ~ 1e17` carries floating-point roundoff
/// that scales with `|x|`, while a genuinely infeasible excursion (e.g.
/// mid-restoration) has a residual comparable to `|x|` itself.
const RECESSION_FEAS_REL: Number = 1e-6;
/// #285: relative bar for "the escape direction lies in `null(A_eq)`".
/// `‖J_c x‖_∞ ≤ this · |x|_∞` certifies that moving along `d ≈ x` preserves
/// the (linearized) equality constraints — `A_eq d ≈ 0`.
const RECESSION_DIR_TOL: Number = 1e-6;
/// #285: relative descent bar. The objective must strictly decrease along
/// the escape direction with a real margin — `∇f·x ≤ −this · ‖∇f‖ ‖x‖` —
/// so a variable drifting orthogonally to the objective (`∇f·x ≈ 0`) can
/// never be mistaken for a recession ray driving `f → −∞`.
const RECESSION_DESC_REL: Number = 1e-6;
/// Update the divergence-persistence state for the current iterate and
/// return whether `DivergingIterates` should be reported now (issues
/// #248 / #252). `amax` is `max_i |x_i|`; `structural_free` is the result
/// of [`Self::divergence_is_true_unboundedness`] (already gated on
/// `amax > diverging_iterates_tol`); `f` is the (minimized, internally
/// scaled) objective at the current iterate, supplied only while
/// `structural_free` holds.
///
/// A large `|x|` is reported as unbounded only when it is heading to an
/// unbounded side (`structural_free`) *and* the divergence looks like a
/// genuine recession ray: the iterate keeps *growing* while the objective
/// keeps *descending toward `−∞` without decelerating* — the per-step drop
/// holds up as `|x|` grows geometrically — for
/// [`Self::DIVERGENCE_PERSIST_ITERS`] consecutive iterations (or it has
/// blown past the absolute runaway backstop). Two failure modes are thereby
/// left to the normal convergence machinery instead of being mislabelled
/// `UNBOUNDED`:
///
/// * #248 — a transient ill-scaling excursion that peaks in `|x|` and
/// recedes never sustains the growth streak.
/// * #252 — an excursion that *keeps* growing in `|x|` toward an unbounded
/// box side (a jit1 B&B node subproblem with `ub = +∞`), lowering `f` as
/// it goes, but with a per-step objective drop that *decelerates* toward
/// zero: it is settling onto a finite optimum, not riding a recession
/// ray. The descent must keep up (not merely exist), so this no longer
/// accumulates the streak.
fn update_divergence_verdict(
&mut self,
amax: Option<Number>,
structural_free: bool,
f: Option<Number>,
) -> bool {
let over = matches!(amax, Some(a) if a > self.diverging_iterates_tol) && structural_free;
if !over {
self.divergence_streak = 0;
self.divergence_prev_amax = 0.0;
self.divergence_prev_f = Number::INFINITY;
self.divergence_prev_decrease = Number::NAN;
return false;
}
let a = amax.expect("over implies amax is Some");
// A recession ray in an interior-point method grows the iterate
// geometrically *and* drives the objective down without bound, with a
// per-step drop that keeps up as `|x|` grows. A finite-optimum
// excursion may grow `|x|` and even lower `f` for a few steps, but its
// per-step objective drop decelerates toward zero as it settles onto
// the finite floor. Require all three — growth, descent, and
// non-decelerating descent — before a step counts toward the streak.
let growing = a >= self.divergence_prev_amax * Self::DIVERGENCE_GROWTH_FACTOR;
// `f` is `None` only when `structural_free` is false, already handled
// by the `!over` branch; treat a missing value as non-descending so a
// run can never accumulate without objective evidence.
let fv = f.unwrap_or(Number::INFINITY);
let decrease = self.divergence_prev_f - fv;
let descending = decrease > 0.0;
// Non-decelerating: the drop must be at least a fixed fraction of the
// previous step's drop. Bootstrapped `true` until a first finite
// decrease has been recorded (`divergence_prev_decrease` non-finite),
// so the run's opening steps are admitted on growth + descent alone.
let keeping_up = !self.divergence_prev_decrease.is_finite()
|| decrease >= self.divergence_prev_decrease * Self::DIVERGENCE_DESCENT_KEEPUP;
if growing && descending && keeping_up {
self.divergence_streak += 1;
} else {
// Over the threshold on an unbounded side, but the divergence is
// not sustaining a recession ray's growth-and-accelerating-descent
// profile — the hallmark of a scaling excursion toward a finite
// optimum. Drop the streak; a genuine ray re-accumulates it on its
// next qualifying step (or trips the absolute runaway backstop).
self.divergence_streak = 0;
}
self.divergence_prev_amax = a;
self.divergence_prev_f = fv;
// Record the baseline for the next step's keep-up comparison only from
// a finite, real decrease; skip the `+∞` opening step and reset the
// baseline whenever the objective stops descending.
self.divergence_prev_decrease = if decrease.is_finite() && descending {
decrease
} else {
Number::NAN
};
a >= Self::DIVERGENCE_ABS_RUNAWAY
|| self.divergence_streak >= Self::DIVERGENCE_PERSIST_ITERS
}
fn divergence_is_true_unboundedness(&self, x: &dyn Vector) -> bool {
self.free_to_escape_over(x, self.diverging_iterates_tol)
}
/// Shared core of the free-variable structural check: returns `true` when
/// some component of `x` with magnitude exceeding `thresh` is heading
/// toward a side (positive → upper, negative → lower) that carries *no*
/// finite bound, so it is free to escape to infinity. Parameterized on the
/// magnitude threshold so both the `diverging_iterates_tol` (`1e20`)
/// divergence guard and the lower `RECESSION_MIN_NORM` recession-ray path
/// (#285) share one implementation.
fn free_to_escape_over(&self, x: &dyn Vector, thresh: Number) -> bool {
use pounce_linalg::DenseVector;
let cq = self.cq.borrow();
let nlp = cq.nlp().borrow();
// Full-length 0/1 indicators of finite lower / upper bounds,
// built by scattering ones through the bound expansion matrices.
let mut ones_l = nlp.x_l().make_new();
ones_l.set(1.0);
let mut has_lb = x.make_new();
nlp.px_l().mult_vector(1.0, &*ones_l, 0.0, &mut *has_lb);
let mut ones_u = nlp.x_u().make_new();
ones_u.set(1.0);
let mut has_ub = x.make_new();
nlp.px_u().mult_vector(1.0, &*ones_u, 0.0, &mut *has_ub);
let downcast = |v: &dyn Vector| -> Option<Vec<Number>> {
v.as_any()
.downcast_ref::<DenseVector>()
.map(|d| d.expanded_values())
};
// POUNCE is dense-only; if a backing is unexpectedly non-dense we
// cannot prove the divergence is spurious, so fall back to the
// original (magnitude-only) verdict to avoid changing behaviour.
let (Some(xv), Some(lb), Some(ub)) = (downcast(x), downcast(&*has_lb), downcast(&*has_ub))
else {
return true;
};
for i in 0..xv.len() {
if xv[i].abs() > thresh {
let free_to_diverge = if xv[i] > 0.0 {
ub[i] == 0.0
} else {
lb[i] == 0.0
};
if free_to_diverge {
return true;
}
}
}
false
}
/// #285: checked recession-ray unboundedness proof at the current iterate.
///
/// Returns `true` only when the current iterate `x` (with `|x|_∞ = amax`,
/// already known `> RECESSION_MIN_NORM` by the caller) *proves* the
/// problem is unbounded below via a genuine recession ray — the same
/// standard the LP/symmetric path holds itself to, not a magnitude
/// heuristic. All of the following must hold:
///
/// 1. **Feasible witness.** The iterate's unscaled primal infeasibility is
/// at most `RECESSION_FEAS_REL · amax`. A genuinely feasible iterate of
/// norm `≥ 1e10` witnesses that the feasible region reaches that far —
/// a *bounded* region cannot contain it. (Relative bar: the residual of
/// `A_eq x − b` carries roundoff that scales with `|x|`.)
/// 2. **Free to escape.** Some over-floor component heads toward a side
/// with no finite variable bound ([`Self::free_to_escape_over`] at
/// `RECESSION_MIN_NORM`).
/// 3. **Direction in `null(A_eq)`.** `‖J_c x‖_∞ ≤ RECESSION_DIR_TOL · amax`
/// — moving along `d ≈ x` preserves the equality constraints.
/// 4. **Inequalities not blocking.** No finitely-bounded inequality row is
/// driven toward its bound along `d ≈ x`
/// ([`Self::recession_blocked_by_inequality`]).
/// 5. **Objective descending.** `∇f·x ≤ −RECESSION_DESC_REL · ‖∇f‖ ‖x‖` —
/// the objective strictly decreases along the escape direction with a
/// real (non-orthogonal) margin, so `f → −∞` along the ray.
///
/// On a *bounded* problem at least one of (1)/(2)/(3)/(4)/(5) fails, so
/// this can never manufacture a spurious `DivergingIterates`.
fn curr_is_recession_ray(&self, x: &dyn Vector, amax: Number) -> bool {
// (1) Feasible witness (relative bar).
let primal_inf = self.cq.borrow().curr_unscaled_primal_infeasibility_max();
if !(primal_inf.is_finite() && primal_inf <= Self::RECESSION_FEAS_REL * amax) {
return false;
}
// (2) Some over-floor component free to escape to infinity.
if !self.free_to_escape_over(x, Self::RECESSION_MIN_NORM) {
return false;
}
// (3) Escape direction lies in the equality null space. A non-finite
// (NaN) residual is treated as failing, so the direction is only
// accepted on a genuinely small, finite `‖J_c x‖∞`.
let jc_x_amax = self.cq.borrow().curr_jac_c_times_vec(x).amax();
if !jc_x_amax.is_finite() || jc_x_amax > Self::RECESSION_DIR_TOL * amax {
return false;
}
// (4) No finitely-bounded inequality blocks the direction.
if self.recession_blocked_by_inequality(x, amax) {
return false;
}
// (5) Objective strictly descending along the escape direction.
let (dot, gnorm, xnorm) = {
let cq = self.cq.borrow();
let g = cq.curr_grad_f();
(g.dot(x), g.nrm2(), x.nrm2())
};
if !(dot < 0.0 && dot <= -Self::RECESSION_DESC_REL * gnorm * xnorm) {
return false;
}
true
}
/// #285: does any *finitely-bounded* inequality constraint block motion
/// along the escape direction `d ≈ x`? For each inequality row the
/// constraint value `d(x)` changes at rate `(J_d x)_j` per unit of the
/// direction; if that row has a finite upper bound and the rate is
/// positive (or a finite lower bound and the rate is negative) beyond a
/// relative tolerance, moving out along `d` would eventually violate it,
/// so it is not a feasible recession direction. Bounds are detected via
/// the `Pd_L / Pd_U` expansion matrices exactly as the variable-bound
/// check uses `Px_L / Px_U`.
fn recession_blocked_by_inequality(&self, x: &dyn Vector, amax: Number) -> bool {
use pounce_linalg::DenseVector;
let cq = self.cq.borrow();
// Rate of change of each inequality value along d ≈ x (length m_ineq).
// Compute first so the internal `nlp.borrow_mut()` is released before
// the immutable borrow below.
let jd_x = cq.curr_jac_d_times_vec(x);
let (has_dlb, has_dub) = {
let nlp = cq.nlp().borrow();
let mut ones_dl = nlp.d_l().make_new();
ones_dl.set(1.0);
let mut has_dlb = jd_x.make_new();
nlp.pd_l().mult_vector(1.0, &*ones_dl, 0.0, &mut *has_dlb);
let mut ones_du = nlp.d_u().make_new();
ones_du.set(1.0);
let mut has_dub = jd_x.make_new();
nlp.pd_u().mult_vector(1.0, &*ones_du, 0.0, &mut *has_dub);
// Order matters: bind `(has_dlb, has_dub)` in that exact order so
// the finite-lower / finite-upper indicators are not transposed.
// #314: this pair was returned swapped, inverting the bound
// semantics below — a ray *increasing* a lower-bounded row (moving
// deeper into the feasible set, slack growing) was wrongly treated
// as blocked, so a genuine inequality-slack recession ray was never
// proven unbounded.
(has_dlb, has_dub)
};
let downcast = |v: &dyn Vector| -> Option<Vec<Number>> {
v.as_any()
.downcast_ref::<DenseVector>()
.map(|d| d.expanded_values())
};
// Dense-only fallback: if we cannot inspect the rows, conservatively
// treat the direction as blocked (no spurious unbounded verdict).
let (Some(jd), Some(dlb), Some(dub)) =
(downcast(&*jd_x), downcast(&*has_dlb), downcast(&*has_dub))
else {
return true;
};
let tol = Self::RECESSION_DIR_TOL * amax;
for j in 0..jd.len() {
// Increasing a row that has a finite upper bound, or decreasing a
// row that has a finite lower bound, would leave the feasible set.
if (jd[j] > tol && dub[j] != 0.0) || (jd[j] < -tol && dlb[j] != 0.0) {
return true;
}
}
false
}
/// #285: update the recession-ray persistence state and return whether
/// `DivergingIterates` should be reported now. `amax` is `|x|_∞`;
/// `is_ray` is the result of [`Self::curr_is_recession_ray`]. The verdict
/// fires once the checked proof has held for
/// [`Self::RECESSION_PERSIST_ITERS`] consecutive *growing* iterations — a
/// bounded region cannot supply a growing sequence of feasible over-floor
/// iterates, so this is impossible to satisfy on a bounded problem.
fn update_recession_verdict(&mut self, amax: Number, is_ray: bool) -> bool {
if !is_ray {
self.recession_streak = 0;
self.recession_prev_amax = 0.0;
return false;
}
if amax > self.recession_prev_amax {
self.recession_streak += 1;
} else {
// Proof holds but the iterate is not growing (a stalled or rejected
// step). Restart the run at the current witness rather than firing
// on a plateau; a genuine ray resumes growing next step.
self.recession_streak = 1;
}
self.recession_prev_amax = amax;
self.recession_streak >= Self::RECESSION_PERSIST_ITERS
}
/// Honour a certificate the masked-scale veto refused, when the run that
/// was allowed to continue did not end in one of its own (gh #200).
///
/// The veto's bargain is "never worse off": it refuses a point that had
/// *already passed the strict test*, betting that continuing reaches a
/// better one. This is the losing side of that bet — so hand back exactly
/// what would have been returned without the veto, point and status both.
///
/// Two details make that guarantee real rather than approximate:
///
/// - It runs on **every** non-success exit, applied once where the driver
/// loop's result is finalized. Wiring individual termination sites was
/// tried and is not safe: there are sixteen, and the ones easiest to
/// overlook are the ones most likely to fire here — the veto's extra
/// iterations are exactly what pushes a run past `max_cpu_time`.
/// - It restores the **refused iterate itself** (`vetoed`), not the last
/// acceptable snapshot. `store_acceptable_point` overwrites
/// unconditionally, so after the veto the stored point drifts to whatever
/// the continued run last touched — which may be worse than the point
/// that was refused.
///
/// "Better" is **status-dominant lexicographic**: the reported status first,
/// and the objective only to break a tie *within equal status*. Both halves
/// matter and the order between them is not cosmetic — see the `Success`
/// branch, where reading it as a plain objective comparison costs a status.
fn honour_refused_certificate(&mut self, result: SolverReturn) -> SolverReturn {
if matches!(result, SolverReturn::Success) {
// The continued run produced a certificate of its own — but not
// necessarily a better *outcome*.
//
// This is what makes "never worse" hold even when the bet loses in a
// way that still converges: on a non-convex problem the extra travel
// can reach a different, worse stationary point, and the budget cap
// (`VETO_MAX_EXTRA_ITERS`) can also hand back a late-but-converged
// one. Neither may silently replace a better answer the solver
// already had in hand.
//
// The comparison is NOT objective-only. That was the original bug
// here: both points passed `passes_component_tols`, which looked
// like a licence to treat them as equally valid certificates and
// just take the lower objective. They are not equally valid when
// `kkt_fidelity_tol` is set — `apply_kkt_fidelity_gate` re-grades a
// `Success` on the unscaled KKT error afterwards, on a strictly
// finer criterion than the convergence test. Taking a 3-ulp
// objective win at a point whose unscaled error is 5x worse traded
// `Solve_Succeeded` for `Solved_To_Acceptable_Level`: a status
// regression against baseline, which is the strongest form of the
// guarantee breaking. So rank by the status each point will actually
// be *reported* under, and only then by objective.
let Some((refused, refused_status)) = self.baseline_outcome() else {
return result;
};
self.assert_comparable_scale(&refused);
let (curr_f, curr_kkt) = self.curr_obj_and_unscaled_kkt();
// Rank each candidate by the status it will actually be *reported*
// under, which for a `Success` means after the fidelity gate has had
// its say.
let continued_success = self.survives_fidelity_gate(curr_kkt);
let refused_success = matches!(refused_status, SolverReturn::Success)
&& self.survives_fidelity_gate(refused.unscaled_kkt);
let keep_refused = match (continued_success, refused_success) {
// Equal reported status: the objective breaks the tie, which is
// legitimate because both points are feasible to tolerance.
//
// Negated `<=`, not `>`: they differ at NaN, and the difference
// matters. A `Converged` exit at an iterate whose objective is
// NaN but whose residuals are finite and tiny is reachable (the
// convergence test never inspects `f`), and `NaN > x` is false,
// which would keep the NaN point over a finite refused one.
// Phrased as a negated `<=`, an incomparable objective fails to
// justify keeping the continued point and the refused one wins.
(true, true) | (false, false) => !(curr_f <= refused.obj),
// The refused point keeps a status the continued one loses.
(false, true) => true,
(true, false) => false,
};
if !keep_refused {
return result;
}
self.restore_snapshot(&refused);
// The restored point's own status, which is what the baseline
// reported for it. For a strict refusal that is `Success` even when
// it fails the fidelity gate — the gate re-grades the restored point
// downstream, exactly as it would have re-graded the baseline's. For
// an acceptable-level refusal it is `StopAtAcceptablePoint`, since
// claiming `Success` for a point that only ever qualified at the
// acceptable level would over-report.
return refused_status;
}
// The continued run did not certify — but its final point can still be a
// *better* would-be certificate than the one the baseline stopped at, and
// restoring the chronologically-first refusal unconditionally throws it
// away (gh #327). The masking veto keeps refusing at the true optimum too
// (its unscaled error stays above `acceptable_tol` under an extreme
// objective scale), so a run that actually reaches the optimum never gets
// to certify there and instead exits non-`Success` — typically on a tiny
// step once it settles. Rolling straight back to the first refusal then
// hands back the point the baseline stopped at, which can be far worse:
// on `min 1/x` over `[1e-12, 10]` the solve reaches x≈10 (f≈0.1) but was
// rolled back to the first refusal at x≈2.84 (f≈0.35) and reported
// success there.
//
// The extra candidate is admitted *narrowly*, and the gate is
// load-bearing: the continued point may displace the refused snapshot
// only if it itself passes the strict per-component tolerances — i.e. it
// is a would-be strict certificate the veto refused solely because of
// masking. That is precisely what tells the settled true optimum apart
// from a merely lower objective reached on an unbounded ray (e.g.
// `A(x−a)⁴ − K·√(1+y²)`, unbounded below in y): the diverging iterate
// never passes the strict test, so it can never win here, and those runs
// stay bit-for-bit as before. When the gate does open, keep whichever
// point ranks better under the same feasibility-aware key the dual-guard
// fallback uses, and report the baseline's restored status either way —
// never worse than baseline on status, never worse (often better) on the
// point.
let Some((refused, restored_status)) = self.baseline_outcome() else {
return result;
};
self.assert_comparable_scale(&refused);
let curr_nlp_err = self.cq.borrow().curr_nlp_error();
let curr_passes_strict =
self.bundle
.conv_check
.current_passes_strict(curr_nlp_err, &self.data, &self.cq);
let curr_f = self.cq.borrow().curr_f();
let curr_viol = self.cq.borrow().curr_unscaled_primal_infeasibility_max();
// The second admissible candidate: a continued run that ends *at the
// acceptable level itself* (gh #533). The `curr_passes_strict` gate
// exists to tell a settled optimum from a diverging ray, and on this
// exit the exit itself already answers that — `StopAtAcceptablePoint` is
// only reachable at a point that passed the acceptable per-component
// tolerances, either by qualifying here or by being the stashed
// acceptable iterate a rollback restored. A diverging iterate cannot
// produce it.
//
// This matters because the gh #533 progress refusal is frequently paid
// off by a *better acceptable point* rather than by a strict
// certificate: the streak refuses while the solve is still descending,
// the solve descends, and then settles somewhere better but still short
// of `tol`. Without this the refused point is restored and the entire
// continuation is discarded — never worse than baseline, but never
// better either, which for that whole class is pure cost.
//
// Gated on the *restored* status also being `StopAtAcceptablePoint`, so
// a strict refusal's `Success` is never reported at a point that only
// ever qualified at the acceptable level.
let continued_is_acceptable_exit = matches!(result, SolverReturn::StopAtAcceptablePoint)
&& matches!(restored_status, SolverReturn::StopAtAcceptablePoint);
// Keep the continued point in place only when it is an admissible
// candidate that also ranks strictly better; otherwise restore the
// refused snapshot exactly as before. `ranks_better` treats a non-finite
// continued objective as worst, so a NaN-objective continuation never
// displaces a finite refused point (the NaN-loses convention the
// `Success` branch relies on).
let keep_continued = (curr_passes_strict || continued_is_acceptable_exit)
&& self.ranks_better(curr_f, curr_viol, refused.obj, refused.constr_viol);
if !keep_continued {
self.restore_snapshot(&refused);
}
if self.cq.borrow().curr_f().is_finite() {
restored_status
} else {
result
}
}
/// What the baseline — the same solve with the veto disabled — would have
/// returned, as (point, status), or `None` if nothing was ever refused.
///
/// The **chronologically first** refusal, not the strictest one. Both arms
/// follow the same trajectory until the first refusal, so that iterate is
/// where the baseline stopped and what it reported. A refusal recorded later
/// sits on the continued trajectory, which the baseline never walked — its
/// point was never on offer, and restoring it would neither reproduce the
/// baseline nor be comparable to it.
///
/// Both kinds do occur, and in either order: an acceptable-level refusal
/// needs `acceptable_iter` consecutive qualifying iterates, so a strict
/// refusal can precede it, while a run that first drifts through the
/// acceptable band can refuse there and only later pass the strict test.
/// Preferring `Success` unconditionally was wrong for exactly the second
/// case — it compared against a strict point from iteration 50-odd when the
/// baseline had already stopped and reported acceptable at iteration 43.
fn baseline_outcome(&self) -> Option<(VetoSnapshot, SolverReturn)> {
// A refusal that was seen but not captured makes the baseline
// unidentifiable, so decline rather than guess. Without this, a failed
// strict capture alongside a successful acceptable one would present the
// acceptable snapshot as the baseline outcome — but that snapshot sits
// on the continued trajectory, so this would silently reintroduce the
// very misidentification the chronological rule exists to prevent.
// Declining loses the restore; misidentifying reports a wrong point
// under a confident status.
//
// Unreachable today (`data.curr` is always `Some` inside `iterate()`, so
// `snapshot_current` cannot fail), but the latches make the state
// representable, and it must not be handled by accident.
if (self.vetoed_seen && self.vetoed.is_none())
|| (self.vetoed_acceptable_seen && self.vetoed_acceptable.is_none())
{
return None;
}
match (&self.vetoed, &self.vetoed_acceptable) {
// Ties go to the strict refusal, and the tie is reachable: both can
// arm in the same call when the acceptable streak crosses on the
// same iterate a strict certificate is refused. Strict is correct
// there because of the baseline's own branch order — the `Converged`
// gate (`opt_error.rs`, in `check_convergence_with_state`) precedes
// `note_acceptable`, so the baseline returned `Converged` at that
// iterate. Reordering those two branches would invert this.
(Some(strict), Some(acc)) => Some(if strict.iter <= acc.iter {
(strict.clone(), SolverReturn::Success)
} else {
(acc.clone(), SolverReturn::StopAtAcceptablePoint)
}),
(Some(strict), None) => Some((strict.clone(), SolverReturn::Success)),
(None, Some(acc)) => Some((acc.clone(), SolverReturn::StopAtAcceptablePoint)),
(None, None) => None,
}
}
/// Capture the current iterate as a veto snapshot, or `None` if there is no
/// current iterate to capture.
///
/// All-or-nothing by construction — see [`VetoSnapshot`].
fn snapshot_current(&self, iter: Index) -> Option<VetoSnapshot> {
let iterate = self.data.borrow().curr.as_ref().cloned()?;
let cq = self.cq.borrow();
Some(VetoSnapshot {
iterate,
iter,
obj: cq.curr_f(),
mu: self.data.borrow().curr_mu,
unscaled_kkt: cq.curr_unscaled_nlp_error(),
constr_viol: cq.curr_unscaled_primal_infeasibility_max(),
obj_scale: cq.obj_scaling_factor(),
})
}
/// Current objective and max-norm unscaled KKT error, read together so the
/// pair cannot describe different iterates.
fn curr_obj_and_unscaled_kkt(&self) -> (Number, Number) {
let cq = self.cq.borrow();
(cq.curr_f(), cq.curr_unscaled_nlp_error())
}
/// Guard the precondition of every scaled-objective comparison in
/// [`Self::honour_refused_certificate`]: the factor must not have moved
/// between the refusal and now, or the two numbers are not comparable.
fn assert_comparable_scale(&self, snap: &VetoSnapshot) {
debug_assert_eq!(
snap.obj_scale,
self.cq.borrow().obj_scaling_factor(),
"objective scaling factor moved during the solve; the refused and \
continued objectives are scaled differently and cannot be compared \
(gh #200)"
);
}
/// Whether a point with this unscaled KKT error would keep `Solve_Succeeded`
/// through [`IpoptApplication::apply_kkt_fidelity_gate`].
///
/// Mirrors that gate rather than approximating it: same quantity
/// (`final_unscaled_kkt_error`), same strict comparison, same "non-positive
/// tolerance disables". With the default `kkt_fidelity_tol = 0` this is
/// always `true`, so every caller collapses to the plain objective
/// comparison and the mechanism's behaviour is unchanged.
fn survives_fidelity_gate(&self, unscaled_kkt: Number) -> bool {
// Phrased as the negation of the gate's own `> tol` test rather than as
// `<= tol`, because the two disagree at NaN and the gate is the
// authority: it demotes only on `> tol`, so a NaN error keeps `Success`
// there and must keep it here. Written as `<= tol` this mirror said the
// opposite, which would rank a NaN-error continued point below a refused
// one. Benign in that direction — it restores the baseline point — but a
// mirror that disagrees with the thing it mirrors is a latent trap.
!(self.kkt_fidelity_tol > 0.0) || !(unscaled_kkt > self.kkt_fidelity_tol)
}
/// Record the current iterate as the best acceptable-quality point seen so
/// far in this solve (pounce#250 follow-up).
///
/// Recording runs on **every** acceptable iterate, not only after the
/// dual-divergence guard has fired. Gating it on the guard was the first
/// attempt and left a hole: the guard fires and returns to the driver
/// *before* this site is reached on that iteration (see the guard block in
/// [`Self::iterate`]), so nothing at or before the diversion was ever
/// captured. A diversion that wrecks the solve immediately — reaching no
/// acceptable point afterwards — therefore had nothing to hand back, which
/// is precisely the case the fallback exists for. `autocorr_bern55-06` hid
/// this, because its better point happens to arrive at iteration 86, well
/// after the guard fires at 23.
///
/// Recording always is still behaviour-neutral, because the record is only
/// ever *read* under `dual_guard_fired` — see
/// [`Self::honour_best_acceptable_after_dual_guard`]. A solve the guard
/// never touches computes a comparison per acceptable iterate and nothing
/// else.
///
/// The cost is one `f64` comparison per acceptable iterate; the iterate is
/// cloned only on an actual improvement, so this does not double the
/// per-iteration clone `store_acceptable_point` already pays.
///
/// "Best" is a feasibility-aware ranking, **not** the lowest objective:
/// candidates are ordered by [`Self::ranks_better`]'s `(feasible_enough,
/// objective)` key, so objective only decides among points already inside a
/// capped feasibility band. Being *bounded* by `acceptable_constr_viol_tol`
/// is not the same as *not trading* feasibility within it — that band is a
/// user option and can be widened to `1e1` or beyond. A pure-objective argmax
/// over it has no lower bound on the feasibility it will spend, and one
/// option-value away it returns a point `pounce verify` rejects under a
/// `Solved_To_Acceptable_Level` status (gh #267). Whether an early
/// low-objective iterate is even a candidate is the user's
/// `acceptable_constr_viol_tol`; the capped feasibility key is what keeps a
/// grossly-infeasible one from winning even when the band admits it.
fn record_best_acceptable(&mut self, curr_f: Number) {
if !curr_f.is_finite() {
return;
}
// Same quantity the acceptable-point gate keys on, so the recorded
// feasibility matches the band the candidate just passed.
let curr_viol = self.cq.borrow().curr_unscaled_primal_infeasibility_max();
// Reject before cloning: only a strictly better candidate — by the
// feasibility-aware key, not objective alone — is worth a snapshot.
if let Some(best) = self.best_acceptable.as_ref() {
let (b_obj, b_viol) = (best.obj, best.constr_viol);
if !self.ranks_better(curr_f, curr_viol, b_obj, b_viol) {
return;
}
}
let iter = self.data.borrow().iter_count;
let Some(snap) = self.snapshot_current(iter) else {
return;
};
// Scaled objectives are only comparable under an unchanged factor; if it
// ever moved, keep the earlier point rather than compare noise.
if let Some(best) = self.best_acceptable.as_ref() {
if snap.obj_scale != best.obj_scale {
return;
}
}
self.best_acceptable = Some(snap);
}
/// Cap on the feasibility band [`Self::ranks_better`] admits, matching the
/// upstream default `acceptable_constr_viol_tol`. The fallback treats a point
/// as "feasible enough to win on objective" only within this band, *however
/// loose the user made `acceptable_constr_viol_tol`*, so widening that option
/// cannot let the fallback trade feasibility for objective (gh #267).
const FEASIBLE_ENOUGH_CAP: Number = 1e-2;
/// Whether candidate `(a_obj, a_viol)` ranks strictly better than
/// `(b_obj, b_viol)` for the best-acceptable fallback (gh #267, gh #280).
///
/// The key is `(band_clamped_viol, objective)` compared lexicographically,
/// where each violation is clamped *up* to
/// `band = min(acceptable_constr_viol_tol, FEASIBLE_ENOUGH_CAP)` before it is
/// compared. Inside the band every point clamps to `band`, so they tie on
/// feasibility and objective decides — objective still rules *only among
/// points already feasible-enough*. Outside the band the actual violation
/// decides, so the less-infeasible point always wins and a
/// strictly-more-infeasible point can never rank better (gh #280 — the
/// earlier `feasible_enough` partition fell through to objective-only once
/// both points were outside the band). The cap keeps the band no looser than
/// the upstream default: `acceptable_constr_viol_tol` is user-widenable, and
/// admitting a wide band into the *objective-decides* region would let a
/// grossly-infeasible low-objective iterate win. Capping the band bounds that.
///
/// At default (or tighter) tolerances this is behaviour-neutral: every
/// recorded point already passed the `acceptable_constr_viol_tol` gate, so
/// with that band at or below the cap every candidate clamps to `band` and
/// objective alone decides, exactly as before. The feasibility ordering only
/// bites once the user loosens `acceptable_constr_viol_tol` past its default
/// and two candidates both sit outside the cap.
///
/// A non-finite objective ranks worst and can never win — feasibility never
/// rescues a `NaN`/`Inf` `f`. This mirrors the `NaN`-loses convention the
/// gh #200 comparisons already rely on, and it keeps a `NaN`-objective
/// returned point losing to a finite recorded one in
/// [`Self::honour_best_acceptable_after_dual_guard`].
///
/// The ranking itself lives in the pure [`ranks_better_within_band`] so its
/// never-worse-off guarantee can be proven by deterministic unit tests rather
/// than inferred from a host-dependent end-to-end objective comparison (see
/// gh #267, which flagged an earlier CLI test for measuring the wrong,
/// host-varying property). This method only resolves the admitted band.
fn ranks_better(&self, a_obj: Number, a_viol: Number, b_obj: Number, b_viol: Number) -> bool {
let band = self
.bundle
.conv_check
.acceptable_constr_viol_tol_or_default()
.min(Self::FEASIBLE_ENOUGH_CAP);
ranks_better_within_band(a_obj, a_viol, b_obj, b_viol, band)
}
/// Make the dual-divergence guard's diversion non-destructive (pounce#250
/// follow-up).
///
/// The guard bets that routing to restoration beats grinding on, and nothing
/// made losing that bet safe: it could return a materially worse point than
/// the solve already had, under a status that does not admit it.
///
/// WHAT THIS DOES AND DOES NOT GUARANTEE. It guarantees the diverted run
/// never returns worse than the best acceptable-quality point **that same
/// run visited**. It does *not* guarantee the diverted run is no worse than
/// not diverting at all — that counterfactual solve never happened, and its
/// points were never on offer to compare against. The distinction is not
/// academic: on the Linux CI host `deb7` returns 97.56 with the guard off and
/// 127.87 with it on at streak 15, and this fallback cannot close that gap,
/// because 127.87 is the best acceptable point the diverted run ever reached.
/// Bounding the diversion's damage is a weaker property than making the
/// diversion harmless, and only the weaker one is available from inside a
/// single solve. It is a large part of why the guard is off by default.
///
/// The observed case is `autocorr_bern55-06`. The guard fires at iteration
/// 23, the diverted run reaches the true optimum (-2304.0000278, matching
/// Ipopt to 12 significant figures) and holds it from iteration 57 to 86 —
/// but the dual residual sawtooths between 1e-8 and 2e-1 there, so it never
/// strings together the `acceptable_iter` consecutive qualifying iterates
/// that would stop the solve. It then enters restoration a second time,
/// wanders into a worse basin, and terminates `StopAtAcceptablePoint` at
/// -2263.46 — 1.8 % worse, with an overall NLP error of 1.0. The better
/// point was *visited and passed the acceptable test*; it was simply
/// overwritten, because `store_acceptable_point` keeps the latest rather
/// than the best.
///
/// So: on a non-`Success` exit, if the best acceptable-quality iterate seen
/// anywhere in the solve beats the point being returned, hand that back
/// instead. This is the same "never worse off" bargain the gh #200 veto
/// makes, applied to the other bet in the algorithm.
///
/// "Beats" is the feasibility-aware ranking in [`Self::ranks_better`], not a
/// bare objective comparison: the recorded point wins only if it is
/// feasible-enough while the returned point is not, or both are in the same
/// feasibility class and it has a lower objective. Ranking by objective alone
/// let a widened `acceptable_constr_viol_tol` band trade feasibility for
/// objective here — restoring a lower-objective point that `pounce verify`
/// rejects, under a success-mapped status (gh #267). The key prevents that:
/// objective can only win among points already inside the capped acceptable
/// feasibility band.
///
/// Note "anywhere in the solve", not "since the guard fired":
/// [`Self::record_best_acceptable`] runs unconditionally and explains why —
/// points at or before the diversion have to be on offer, or a diversion that
/// wrecks the solve immediately has nothing to hand back. Only this *read* is
/// gated on `dual_guard_fired`.
///
/// A strict `Success` is never overridden — that point carries a real
/// certificate, and a lower objective at a merely-acceptable point must not
/// displace it.
///
/// Tuning the guard's firing threshold was tried first and rejected: no
/// setting separates the models it helps from the ones it harms, and the
/// effect turned out to differ by host anyway (see the option help in
/// `upstream_options.rs`). Fixing the consequence is what remained available.
fn honour_best_acceptable_after_dual_guard(&mut self, result: SolverReturn) -> SolverReturn {
if !self.dual_guard_fired || matches!(result, SolverReturn::Success) {
return result;
}
let Some(best) = self.best_acceptable.clone() else {
return result;
};
let (curr_f, _) = self.curr_obj_and_unscaled_kkt();
let curr_viol = self.cq.borrow().curr_unscaled_primal_infeasibility_max();
let curr_scale = self.cq.borrow().obj_scaling_factor();
// Only comparable under the same factor, sign included.
if curr_scale != best.obj_scale {
return result;
}
// Restore only when the recorded point ranks strictly better under the
// feasibility-aware key — more feasible, or equally feasible at a lower
// objective. `ranks_better` also handles the `NaN` case the previous
// bare `!(curr_f <= best.obj)` did: a non-finite returned objective
// ranks worst, so a finite recorded point wins and is restored.
if self.ranks_better(best.obj, best.constr_viol, curr_f, curr_viol) {
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] dual-divergence diversion ended worse than a point already \
in hand (obj {:.10e} viol {:.3e} -> obj {:.10e} viol {:.3e}, iter {}); \
restoring it (pounce#250, gh#267).",
curr_f, curr_viol, best.obj, best.constr_viol, best.iter,
);
self.restore_snapshot(&best);
// Swap the *point*, but never let the swap erase why the solve
// stopped. A budget that was exhausted stays reported as exhausted:
// a caller polling for "did I run out of time" must not be told
// "solved to acceptable level" merely because a better point was
// recoverable. Only the outcomes that carry no such fact of their
// own are relabelled to describe what is now being returned.
return match result {
SolverReturn::MaxiterExceeded
| SolverReturn::CpuTimeExceeded
| SolverReturn::WallTimeExceeded
| SolverReturn::UserRequestedStop => result,
_ => SolverReturn::StopAtAcceptablePoint,
};
}
result
}
/// Make a refused snapshot the current iterate again.
fn restore_snapshot(&mut self, snap: &VetoSnapshot) {
let mut d = self.data.borrow_mut();
d.set_trial(snap.iterate.clone());
d.accept_trial_point();
// The restored point's own barrier parameter, not the continued run's —
// see `VetoSnapshot::mu`.
d.curr_mu = snap.mu;
}
/// Decide whether the acceptable-point restoration decline may be deferred
/// this once (gh #534), and arm the bookkeeping that bounds the bet.
///
/// Four conditions, all required:
///
/// * the option leaves deferrals available at all
/// (`resto_decline_deferrals`, `0` = pre-#534 behaviour);
/// * the budget is not already spent;
/// * the NLP error has contracted on every one of the last
/// [`DECLINE_PROGRESS_SAMPLES`]` - 1` iterations
/// ([`Self::nlp_err_contracting`]) — the progress test the guard lacked;
/// * the iteration budget has room for a continuation, and the entry point
/// can actually be captured. Without a floor there is nothing to fall
/// back to, and a bet with no floor is exactly what must not be placed.
///
/// The deadline is clamped below `max_iter` so a lost bet can never turn a
/// reportable `StopAtAcceptablePoint` into `Maximum_Iterations_Exceeded`:
/// the continuation is always cut before the iteration budget runs out. A
/// *time* budget is not clamped the same way — elapsed time is an external
/// fact and the deadline cannot predict it — so a solve that expires inside
/// the continuation window still reports the time limit, at the floor
/// iterate rather than at whatever the continuation last touched.
fn may_defer_acceptable_decline(&mut self) -> bool {
if self.decline_deferrals_used >= self.resto_decline_deferrals {
return false;
}
if !self.nlp_err_contracting() {
return false;
}
let iter = self.data.borrow().iter_count;
// No room to continue: the deadline below would fire on the very next
// iteration, so the deferral would buy nothing and cost a restoration.
if iter.saturating_add(1) >= self.max_iter {
return false;
}
if self.decline_floor.is_none() {
let Some(snap) = self.snapshot_current(iter) else {
return false;
};
self.decline_floor = Some(snap);
}
self.decline_deferrals_used += 1;
self.decline_deadline_iter = Some(
iter.saturating_add(DECLINE_CONTINUATION_BUDGET)
.min(self.max_iter.saturating_sub(1)),
);
true
}
/// The deferred continuation ran out of budget without a strict certificate
/// (gh #534). Report the floor — the point the pre-#534 guard would have
/// returned — unless the continuation is standing somewhere at least as
/// good.
fn terminate_at_decline_floor(&mut self) -> IterateOutcome {
let Some(floor) = self.decline_floor.clone() else {
// Unreachable in practice: the deadline is only ever set after a
// floor is captured. Stopping at the current point is still the
// right thing if it somehow is not — the point passed the
// acceptable-level triplet when the deferral was taken.
return IterateOutcome::Terminate(SolverReturn::StopAtAcceptablePoint);
};
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] deferred restoration decline expired at iter {} without a strict \
certificate; falling back to the floor from iter {} (gh #534).",
self.data.borrow().iter_count, floor.iter,
);
if !self.continuation_outranks(&floor) {
self.restore_snapshot(&floor);
}
IterateOutcome::Terminate(SolverReturn::StopAtAcceptablePoint)
}
/// Whether the current iterate is a *better* answer than the gh #534 floor.
///
/// Two gates, in order. The current point must itself pass the
/// acceptable-level triplet — the floor is going to be reported under
/// `Solved_To_Acceptable_Level`, and a continuation that wandered off is not
/// entitled to that status however attractive its objective looks. Only then
/// does [`Self::ranks_better`]'s feasibility-first key decide, and only under
/// an unmoved objective scaling factor, since the two objectives are
/// otherwise not comparable.
fn continuation_outranks(&self, floor: &VetoSnapshot) -> bool {
let (curr_f, _) = self.curr_obj_and_unscaled_kkt();
if !curr_f.is_finite() {
return false;
}
let nlp_err = self.cq.borrow().curr_nlp_error();
if !self
.bundle
.conv_check
.current_is_acceptable_with_state(nlp_err, &self.data, &self.cq)
{
return false;
}
let (curr_viol, curr_scale) = {
let cq = self.cq.borrow();
(
cq.curr_unscaled_primal_infeasibility_max(),
cq.obj_scaling_factor(),
)
};
if curr_scale != floor.obj_scale {
return false;
}
!self.ranks_better(floor.obj, floor.constr_viol, curr_f, curr_viol)
}
/// Make a deferred restoration decline non-destructive (gh #534).
///
/// The deferral is a bet that a contracting endgame is three iterations from
/// a certificate. This is what makes losing it cost only those iterations:
/// whatever the continued run ends up returning, if it is not at least as
/// good an answer as the floor — the point the pre-#534 guard would have
/// reported — the floor is restored and reported instead.
///
/// Applied once, in [`Self::optimize`], for the same reason the gh #200 and
/// pounce#250 hooks are: the driver loop has many `return`s and this must
/// see all of them.
///
/// A strict `Success` is never overridden — that is the bet paying off, and
/// a real certificate outranks any acceptable-level point by construction.
/// The budget statuses keep their own status, as they do in
/// [`Self::honour_best_acceptable_after_dual_guard`]: a caller polling for
/// "did I run out of time" must be told so, even while the point it gets
/// back is swapped for the better one.
fn honour_decline_floor(&mut self, result: SolverReturn) -> SolverReturn {
if matches!(result, SolverReturn::Success) {
if self.decline_floor.is_some() {
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] the deferred restoration decline paid off: the continuation \
reached a strict certificate (gh #534).",
);
}
return result;
}
let Some(floor) = self.decline_floor.clone() else {
return result;
};
if self.continuation_outranks(&floor) {
return result;
}
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] the deferred restoration decline did not pay off; restoring the \
floor from iter {} (obj {:.10e} viol {:.3e}) and reporting it (gh #534).",
floor.iter, floor.obj, floor.constr_viol,
);
self.restore_snapshot(&floor);
match result {
SolverReturn::MaxiterExceeded
| SolverReturn::CpuTimeExceeded
| SolverReturn::WallTimeExceeded
| SolverReturn::UserRequestedStop => result,
_ => SolverReturn::StopAtAcceptablePoint,
}
}
/// Terminal fallback for a near-feasible numerical breakdown (a
/// restoration cycle or a failed step computation). If a finite
/// acceptable iterate was recorded earlier in the solve, roll back
/// to it and stop at [`SolverReturn::StopAtAcceptablePoint`] (mapped
/// by the application layer to `Solved_To_Acceptable_Level`) rather
/// than surfacing the hard `fallback` error. This mirrors upstream
/// `IpBacktrackingLineSearch`'s `ACCEPTABLE_POINT_REACHED`
/// precedence: when the line search exhausts but an acceptable point
/// was stored, that point is returned instead of the failure. With
/// no snapshot — or if the restored objective is non-finite — the
/// original `fallback` status is surfaced unchanged, so genuinely
/// failed/infeasible solves keep their honest status. Catches
/// degenerate LPs (kleemin8, nsir2) whose μ-endgame reaches the
/// optimum, then destabilizes on the ill-conditioned vertex and
/// cycles in restoration instead of stopping at the acceptable
/// iterate it already passed through.
fn terminate_acceptable_or(&mut self, fallback: SolverReturn) -> IterateOutcome {
if self.restore_acceptable_point() && self.cq.borrow().curr_f().is_finite() {
IterateOutcome::Terminate(SolverReturn::StopAtAcceptablePoint)
} else {
IterateOutcome::Terminate(fallback)
}
}
/// The single place this module turns a local-infeasibility conclusion
/// into a returned status (gh #505).
///
/// Three separate routes reach that verdict — the conv-check's rapid
/// detection, restoration layer 2, and the slow-cycle exits — and the same
/// defect was found in two of them independently: returning the hard
/// verdict without consulting the acceptable-point stash, so a solve that
/// had already passed through an acceptable iterate discarded it. Only the
/// cycle exits got it right, and nothing structural said the other two were
/// wrong.
///
/// That is the shape of a defect that comes back. The route a solve takes
/// to the verdict is an internal detail — the user sees one status either
/// way — so the *decision* about what that status means must not live at
/// each route. It lives here, and
/// [`no_route_concludes_local_infeasibility_alone`] is a tripwire against
/// a new site rebuilding the outcome inline.
///
/// The cycle exits are not routed through here because their fallback is
/// chosen between `LocalInfeasibility` and `ErrorInStepComputation` at the
/// call site; they already reach `terminate_acceptable_or`, which is the
/// behaviour this guarantees.
///
/// Scope: this governs how *this module* returns the verdict. Other layers
/// name `SolverReturn::LocalInfeasibility` for their own reasons — the SQP
/// status map and the ℓ₁ elastic path in `application.rs`, for instance —
/// and are outside both this funnel and its tripwire.
fn terminate_local_infeasibility(&mut self) -> IterateOutcome {
self.terminate_acceptable_or(SolverReturn::LocalInfeasibility)
}
pub fn with_nlp(mut self, nlp: Rc<RefCell<dyn IpoptNlp>>) -> Self {
self.nlp = Some(nlp);
self
}
/// Install a user-facing TNLP handle. Enables per-iteration
/// `TNLP::intermediate_callback` invocation from `optimize()`.
pub fn with_tnlp(mut self, tnlp: Rc<RefCell<dyn TNLP>>) -> Self {
self.tnlp = Some(tnlp);
self
}
/// Build an [`IterStats`] payload from the current `IpoptData` /
/// `IpoptCq` state. Mirrors the field set the upstream Ipopt main
/// loop hands to `IntermediateCallback` after each `AcceptTrialPoint`.
fn build_iter_stats(&self) -> IterStats {
let d = self.data.borrow();
let c = self.cq.borrow();
let dnrm = match d.delta.as_ref() {
Some(delta) => delta.x.amax().max(delta.s.amax()),
None => 0.0,
};
IterStats {
// alg_mod tracking (regular vs restoration) is a follow-up;
// every callback fire from the outer loop reports RegularMode.
mode: AlgorithmMode::RegularMode,
iter: d.iter_count,
obj_value: c.curr_f(),
inf_pr: c.curr_primal_infeasibility_max(),
inf_du: c.curr_dual_infeasibility_max(),
mu: d.curr_mu,
d_norm: dnrm,
regularization_size: d.info_regu_x,
alpha_du: d.info_alpha_dual,
alpha_pr: d.info_alpha_primal,
ls_trials: d.info_ls_count,
}
}
/// Fire `TNLP::intermediate_callback` if a TNLP handle and NLP
/// handle are installed. Wraps the call in an [`IntermediateContext`]
/// guard so downstream inspector entry points (the C API's
/// `GetIpoptCurrent*`) can read live state for the duration. Returns
/// `true` to continue, `false` if the user requested termination.
fn fire_intermediate(&self) -> bool {
let Some(tnlp) = self.tnlp.as_ref() else {
return true;
};
let Some(nlp) = self.nlp.as_ref() else {
return true;
};
let stats = self.build_iter_stats();
let _guard = CtxGuard::install(IntermediateContext {
data: Rc::clone(&self.data),
cq: Rc::clone(&self.cq),
nlp: Rc::clone(nlp),
});
tnlp.borrow_mut().intermediate_callback(
stats,
&TnlpIpoptData::default(),
&TnlpIpoptCq::default(),
)
}
pub fn with_search_dir(mut self, sd: PdSearchDirCalc) -> Self {
self.search_dir = Some(sd);
self
}
pub fn with_restoration(mut self, resto: Box<dyn RestorationPhase>) -> Self {
self.restoration = Some(resto);
self
}
/// Install the shared diagnostics state. The state is propagated
/// to the augmented-system solver at the top of [`Self::optimize`]
/// so dump sites can consult per-iter gating.
pub fn with_diagnostics(mut self, diag: Rc<DiagnosticsState>) -> Self {
self.diagnostics = Some(diag);
self
}
/// Install an interactive debugger hook. Fired at each checkpoint
/// in [`Self::optimize`]; returning [`crate::debug::DebugAction::Stop`]
/// ends the solve with `SolverReturn::UserRequestedStop`.
pub fn with_debug_hook(mut self, hook: Rc<RefCell<dyn crate::debug::DebugHook>>) -> Self {
self.debug = Some(hook);
self
}
/// Shared handle to the installed debugger, if any — used to forward
/// it into the restoration inner IPM.
pub fn debug_hook(&self) -> Option<Rc<RefCell<dyn crate::debug::DebugHook>>> {
self.debug.as_ref().map(Rc::clone)
}
/// Fire the debugger hook (if installed) at `cp`, building a live
/// [`crate::debug::DebugCtx`] over cheap handle clones. Returns the
/// requested action, defaulting to `Resume` when no hook is set.
fn fire_debug(&mut self, cp: crate::debug::Checkpoint) -> crate::debug::DebugAction {
use crate::debug::{DebugAction, DebugCtx};
// Clone the Rc so the hook borrow is released before we touch
// `self.bundle` to apply any live option changes below.
let Some(hook) = self.debug.as_ref().map(Rc::clone) else {
return DebugAction::Resume;
};
let mut ctx = DebugCtx::new(Rc::clone(&self.data), Rc::clone(&self.cq), cp);
let action = hook.borrow_mut().at_checkpoint(&mut ctx);
// Drain any tolerances the hook asked to hot-swap and write them
// into the live convergence-check policy, so the next iteration's
// termination test uses the new value (no `resolve` needed).
for (name, value) in ctx.take_live_tolerances() {
self.bundle.conv_check.set_tolerance(&name, value);
}
action
}
/// Run the restoration phase, bracketed by the `PreRestoration` /
/// `PostRestoration` debug checkpoints so a debugger can inspect the
/// iterate just before entry and just after exit. With no debugger
/// installed this is exactly `invoke_restoration()`.
fn invoke_restoration_debugged(&mut self) -> IterateOutcome {
if let Some(o) = self.debug_stop(crate::debug::Checkpoint::PreRestoration) {
return o;
}
let outcome = self.invoke_restoration();
if let Some(o) = self.debug_stop(crate::debug::Checkpoint::PostRestoration) {
return o;
}
outcome
}
/// Fire a sub-iteration checkpoint from inside [`Self::iterate`].
/// Returns `Some(Terminate(UserRequestedStop))` if the debugger asked
/// to stop, so the caller can `return` it; `None` to continue.
fn debug_stop(&mut self, cp: crate::debug::Checkpoint) -> Option<IterateOutcome> {
if self.debug.is_none() {
return None;
}
if self.fire_debug(cp) == crate::debug::DebugAction::Stop {
Some(IterateOutcome::Terminate(SolverReturn::UserRequestedStop))
} else {
None
}
}
/// Fire the terminal post-mortem checkpoint (if a debugger is set),
/// carrying the solve outcome so the hook can decide whether to pause
/// at the final iterate. The action is advisory — the loop returns
/// `result` regardless — so the hook just gets a last look.
fn fire_debug_terminal(&mut self, result: SolverReturn) {
use crate::debug::{Checkpoint, DebugCtx};
let Some(hook) = self.debug.as_ref() else {
return;
};
let mut ctx = DebugCtx::new(
Rc::clone(&self.data),
Rc::clone(&self.cq),
Checkpoint::Terminated,
)
.with_status(format!("{result:?}"));
let _ = hook.borrow_mut().at_checkpoint(&mut ctx);
}
/// Cheap mid-iteration time-budget check (pounce#242). Returns the
/// terminal [`SolverReturn`] when the shared [`Deadline`] has been
/// crossed, so the caller can bail *within* an iteration — after the
/// KKT factorization, before the line search — rather than only at the
/// next outer-iteration convergence check. Returns `None` (never
/// terminating) when no deadline is installed, keeping the
/// direct-driver / unit-test paths on their `overall_alg`-based gate.
/// A `None` here is not "no budget" but "check it at the coarse site".
fn deadline_status(&self) -> Option<SolverReturn> {
let d = self.data.borrow();
let kind = d.deadline.as_ref()?.exceeded()?;
Some(match kind {
pounce_common::timing::DeadlineKind::Cpu => SolverReturn::CpuTimeExceeded,
pounce_common::timing::DeadlineKind::Wall => SolverReturn::WallTimeExceeded,
})
}
/// One iteration body — port of `Optimize()`'s inner loop.
/// Returns either `Continue` to keep iterating or a terminal
/// [`SolverReturn`] mirroring upstream's exception → return-code
/// translation table (see `MAIN_LOOP.md` §"Exception mapping").
fn iterate(&mut self) -> IterateOutcome {
// Shared timing accumulator — cheap Rc clone so each phase can
// bump its own counter without re-borrowing `data`.
let timing = self.data.borrow().timing.clone();
// Per-iteration span so every event emitted in this body (the
// structured iteration record, restoration/linear-solve spans)
// is tagged with the iteration index.
let _iter_span =
tracing::info_span!("iteration", iter = self.data.borrow().iter_count).entered();
// 1. Output iteration row. Header every 10 iters; the row itself
// is built plain by the strategy (so the column widths stay
// exact and unit-testable) and wrapped in a tiger/rust style
// at the print site (pounce#71). `anstream::stdout()` strips
// the escapes automatically when stdout is redirected or
// `NO_COLOR` is set, so non-TTY output is plain text.
//
// Print BEFORE `reset_info` so the row reflects the accepted
// step from the previous iteration (alphas, ls count,
// alpha_char), matching upstream's `IpIpoptAlgorithm::Optimize`
// ordering.
timing.output_iteration.start();
self.bundle.iter_output.write_output();
if self.print_iter_output {
use std::io::Write as _;
let (iter_count, alpha_pr, alpha_char) = {
let d = self.data.borrow();
(d.iter_count, d.info_alpha_primal, d.info_alpha_primal_char)
};
let row = self.bundle.iter_output.format_row(&self.data, &self.cq);
// Iteration 0 is the initial point — no step has been taken
// yet, so `alpha_primal` is 0; treat it as a full step
// (neutral black) rather than a stalling alarm (red).
let style_alpha = if iter_count == 0 { 1.0 } else { alpha_pr };
let style = pounce_common::style::iteration_row_style(style_alpha, alpha_char);
let mut out = anstream::stdout();
// Write errors (e.g. a closed pipe / `head` on the output)
// are deliberately ignored: a vanished terminal must not
// panic the solver, unlike the old `println!`.
if iter_count % 10 == 0 {
let _ = write!(out, "{}", crate::output::orig::OrigIterationOutput::HEADER);
}
let _ = writeln!(out, "{}{}{}", style.render(), row, style.render_reset());
}
timing.output_iteration.end();
// Structured per-iteration event (pounce#71) — the single source
// of truth for the per-iteration trajectory. The JSON log sink
// and the solve-report collector
// (`pounce_observability::IterCollectorLayer`) both derive from
// it. The text console layer filters this target out (its human
// form is the colored table above).
//
// Skipped entirely when nothing consumes it (no iter-history
// capture active and JSON logging off) so the default run pays
// no per-iteration field-evaluation / allocation cost.
if pounce_observability::iteration_event_wanted() {
let d = self.data.borrow();
let c = self.cq.borrow();
let alpha_char = d.info_alpha_primal_char;
let alpha_char_s = alpha_char.to_string();
let d_norm = match &d.delta {
Some(delta) => delta.x.amax().max(delta.s.amax()),
None => 0.0,
};
tracing::info!(
target: pounce_observability::ITER_TARGET,
iter = d.iter_count,
objective = c.unscaled_curr_f(),
inf_pr = c.curr_primal_infeasibility_max(),
inf_du = c.curr_dual_infeasibility_max(),
mu = d.curr_mu,
d_norm = d_norm,
regularization = d.info_regu_x,
alpha_dual = d.info_alpha_dual,
alpha_primal = d.info_alpha_primal,
ls_trials = d.info_ls_count,
alpha_char = alpha_char_s.as_str(),
resto_kind = pounce_common::style::resto_kind_str(alpha_char),
);
}
// Reset per-iteration info on data (after printing previous
// iter's accepted-step info; before the next line search).
self.data.borrow_mut().reset_info();
// 2. Convergence check.
timing.check_convergence.start();
let nlp_err = self.cq.borrow().curr_nlp_error();
let iter_count = self.data.borrow().iter_count;
if !nlp_err.is_finite() {
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::InvalidNumberDetected);
}
// gh #534 progress history. One sample per outer iteration, recorded
// before any of the guards below can divert, so the samples the
// restoration-decline test reads are consecutive by construction.
self.note_nlp_err(nlp_err);
// Divergence guard — port of upstream `IpIpoptAlg.cpp` post-
// AcceptTrialPoint check. When `max_i |x_i|` exceeds the
// registered `diverging_iterates_tol` (default `1e20`), exit
// cleanly with `DivergingIterates` rather than spiralling into
// a degenerate restoration whose inner sub-NLP can't recover
// (MESH: orig `f` already at -3.6e33 by iter 90, restoration
// entered too late to bound `x`).
//
// A large `|x|` alone does not prove unboundedness, though:
// `DivergingIterates` is Ipopt's *unboundedness* signal (it maps
// to the AMPL 300 "unbounded" range), and under severe objective
// ill-scaling the normal-mode IPM can take a large but transient
// excursion on a problem that is bounded below with a finite
// optimum (issue #248: MINLPLib `jit1`). Only conclude divergence
// when the growth is *structurally* consistent with an unbounded
// feasible region — some over-threshold component heading toward a
// side with no finite bound. If every large component is pinned by
// a finite bound (in particular, all variables boxed), the growth
// is a scaling artifact, so let the normal convergence / iteration
// machinery return the best iterate instead of a spurious
// `Unbounded`.
// Evaluate the structural check under an immutable borrow, then
// update the persistence state and take the verdict separately so
// the mutable field updates don't clash with the `data` borrow.
// Two independent unboundedness paths share this block:
// * the `diverging_iterates_tol` (`1e20`) magnitude guard, gated on
// the free-variable structural check + geometric-growth streak
// (issues #248 / #252); and
// * the #285 recession-ray path — a *checked proof*, active from a
// far lower magnitude floor, that catches a genuine recession ray
// in `null(A_eq)` over free variables whose `|x|` grows only
// linearly and so never reaches `1e20` within `max_iter`.
let (amax, structural_free, is_ray) = {
let data = self.data.borrow();
match data.curr.as_ref() {
Some(curr) => {
let amax = curr.x.amax();
let structural = amax > self.diverging_iterates_tol
&& self.divergence_is_true_unboundedness(&*curr.x);
let is_ray = amax > Self::RECESSION_MIN_NORM
&& self.curr_is_recession_ray(&*curr.x, amax);
(Some(amax), structural, is_ray)
}
None => (None, false, false),
}
};
// Evaluate the (scaled) objective only while a structural divergence
// is live — the streak's descent gate needs it, and it costs an
// objective evaluation, so skip it on the common non-diverging path.
let curr_f = structural_free.then(|| self.cq.borrow().curr_f());
// Evaluate both streak updates (no short-circuit) so each keeps its
// state current, then fire if either concludes divergence.
let fire_magnitude = self.update_divergence_verdict(amax, structural_free, curr_f);
let fire_recession = self.update_recession_verdict(amax.unwrap_or(0.0), is_ray);
if fire_magnitude || fire_recession {
if fire_recession && !fire_magnitude {
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] recession-ray guard fired at iter {} (|x|_inf={:.2e}); \
reporting DivergingIterates (pounce#285).",
self.data.borrow().iter_count,
amax.unwrap_or(f64::NAN),
);
}
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::DivergingIterates);
}
// Dual-divergence guard (pounce#246). The primal guard above only
// catches `|x|` blowing up; a bad warm start can instead send the
// *dual* infeasibility diverging — `inf_du` 1 -> 1e14, the inertia
// regularization -> 1e14, the barrier parameter frozen, full steps
// still accepted by the filter because primal feasibility inches
// down — while `|x|` stays bounded. `diverging_iterates_tol` never
// trips, restoration is never entered, and the solve grinds in
// ever-more-ill-conditioned KKT factorizations that each take
// seconds (the emfl050 warm-start overshoot: one 3.8 s factorization
// per iteration, forever). Detect a sustained streak of growing dual
// infeasibility in the elevated regime and route to restoration —
// the same recovery the least-square-multiplier init path reaches on
// its own — before the factorizations start choking. Gated on a
// large absolute `inf_du` so a well-behaved solve whose dual
// residual transiently rises (then falls) is never diverted:
// restoration is a heavier hammer than the guard should swing at a
// merely-bumpy-but-converging iterate.
//
// OFF BY DEFAULT (pounce#250 follow-up). The emfl050 overshoot above is
// how this was justified, and it did not reproduce: that measurement was
// caller-side JAX compilation, and the build predating the guard solves
// both emfl050 instances to the same optimum in the same time. What is
// left is an effect on four of 1284 MINLPLib models that is knife-edge
// and non-monotone in `dual_diverging_streak` — a better local optimum on
// deb7/deb9 at exactly 15, and pooling_rt2stp turning Solve_Succeeded
// into Maximum_Iterations_Exceeded at 10 and 15 only. Kept because it
// does help when it helps, but not imposed. Full account in the option
// help (`upstream_options.rs`).
//
// Two things to know before changing this:
//
// * `curr_dual_infeasibility_max` is the RAW ‖∇L‖∞, not divided by the
// `s_d` optimality scaling the convergence check applies, and this runs
// *before* `conv_check`. So the thresholds below are not on the same
// quantity the solver's own tolerances are on, and the claim that they
// are scale-robust holds only while `nlp_scaling_method != none`. No
// exploit is known; the margin is thinner than it looks.
// * The `DivergingIterates` fallback at the end is unreachable from every
// shipped front end — CLI, pounce-py and cinterface all wire a
// restoration provider, so the guard can only ever route to
// restoration. Do not assume it is dead code and delete the provider
// check; do not assume it is live and rely on the status either.
if self.dual_diverging_streak > 0 {
let inf_du = self.cq.borrow().curr_dual_infeasibility_max();
if inf_du.is_finite() && inf_du > self.dual_inf_prev && inf_du > DUAL_DIV_COUNT_FLOOR {
self.dual_growth_streak += 1;
} else {
self.dual_growth_streak = 0;
}
self.dual_inf_prev = inf_du;
if self.dual_growth_streak >= self.dual_diverging_streak && inf_du > DUAL_DIV_FIRE_TOL {
self.dual_growth_streak = 0;
self.dual_inf_prev = 0.0;
// Arm the "never worse off" bookkeeping for the bet about to be
// placed (pounce#250 follow-up).
self.dual_guard_fired = true;
timing.check_convergence.end();
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] dual-divergence guard fired at iter {} (inf_du={:.2e}); \
routing to restoration (pounce#246).",
self.data.borrow().iter_count, inf_du,
);
if self.restoration.is_some() {
return self.invoke_restoration_debugged();
}
return IterateOutcome::Terminate(SolverReturn::DivergingIterates);
}
}
let conv_status = self
.bundle
.conv_check
.check_convergence_with_state(nlp_err, iter_count, &self.data, &self.cq);
// Snapshot the *first* refused certificate. Baseline would have stopped
// and returned exactly this point, so keeping it — and only it — is what
// makes the "never worse" guarantee exact rather than approximate. A
// later refusal is also a valid certificate but not necessarily a
// better one, so it must not overwrite this.
if !self.vetoed_seen && self.bundle.conv_check.certificate_vetoed() {
// Latch on *seeing* the refusal, not on the snapshot being present:
// the veto flag is sticky, so keying off `vetoed.is_none()` would
// let a failed capture be completed at a later, arbitrary iterate.
// See `IpoptAlgorithm::vetoed_seen`.
self.vetoed_seen = true;
self.vetoed = self.snapshot_current(iter_count);
}
if !self.vetoed_acceptable_seen && self.bundle.conv_check.acceptable_certificate_vetoed() {
self.vetoed_acceptable_seen = true;
self.vetoed_acceptable = self.snapshot_current(iter_count);
}
match conv_status {
ConvergenceStatus::Continue => {}
ConvergenceStatus::Converged => {
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::Success);
}
ConvergenceStatus::ConvergedToAcceptable => {
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::StopAtAcceptablePoint);
}
ConvergenceStatus::MaxIterExceeded => {
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::MaxiterExceeded);
}
ConvergenceStatus::CpuTimeExceeded => {
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::CpuTimeExceeded);
}
ConvergenceStatus::WallTimeExceeded => {
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::WallTimeExceeded);
}
ConvergenceStatus::LocallyInfeasible => {
timing.check_convergence.end();
// gh #505: consult the acceptable-point stash, as the
// restoration-cycle exits below already do (`:2686`, `:2716`,
// both via `terminate_acceptable_or`). This arm used to return
// without it, so a solve that had passed through an acceptable
// iterate — stashed, un-vetoed, sitting there as a rollback
// target — discarded it and surfaced the hard verdict instead.
// The stashing code sits *after* this match, so the firing
// iteration returns before it would even consider stashing;
// only iterates from earlier in the solve are on offer, which
// is exactly what a rollback target is.
//
// This is about what to *return* once the verdict has fired,
// not about when it fires. Whether the rapid detector should
// have convicted this point at all is a separate question,
// answered by the violation floor in `OptErrorConvCheck`
// (gh #519).
//
// Inert on genuinely infeasible models: `store_acceptable_point`
// is gated on `current_is_acceptable_with_state`, which requires
// `acceptable_tol` *and* the unscaled violation against
// `acceptable_constr_viol_tol`, and the scale-relative veto
// blocks the stash outright for a row violated relative to its
// own magnitude. Nothing is stashed on such a model, so
// `terminate_acceptable_or` falls through to the verdict
// unchanged. `infeasible_models_are_never_reported_solved`
// (`infeasible_status_tol_invariance.rs`) is the standing guard.
return self.terminate_local_infeasibility();
}
ConvergenceStatus::Failed => {
timing.check_convergence.end();
return IterateOutcome::Terminate(SolverReturn::InternalError);
}
}
// Stash the iterate if it satisfies the per-component
// `acceptable_*_tol` triplet. Mirrors upstream
// `IpBacktrackingLineSearch.cpp:282-289` — checked at the top
// of every line-search call so the most recent acceptable
// iterate is always available as a rollback target if
// restoration later fails. The recorder feeds
// `acceptable_obj_change_tol`'s stability cross-check on
// subsequent iterates.
if self
.bundle
.conv_check
.current_is_acceptable_with_state(nlp_err, &self.data, &self.cq)
{
self.store_acceptable_point();
let curr_f = self.cq.borrow().curr_f();
self.bundle.conv_check.set_curr_acceptable_obj(curr_f);
// pounce#250 follow-up: keep the *best* acceptable iterate, not just
// the latest. `store_acceptable_point` overwrites unconditionally,
// so once the dual-divergence guard diverts a solve the rollback
// target drifts to whatever the diverted run last touched — which
// may be far worse than a point already in hand. Recorded on every
// acceptable iterate (including before any diversion) and read only
// when the guard fired; see `honour_best_acceptable_after_dual_guard`.
self.record_best_acceptable(curr_f);
}
timing.check_convergence.end();
// gh #534: a deferred restoration decline is a bet with a deadline.
// Checked *after* the convergence check, so a strict certificate the
// continuation reached in the meantime wins the bet rather than being
// pre-empted by its own expiry; and after the acceptable stash, so a
// continuation that ended somewhere better has been recorded before the
// floor comparison reads it.
if self.decline_deadline_iter.is_some_and(|d| iter_count > d) {
return self.terminate_at_decline_floor();
}
// 3. Hessian update. Must run BEFORE `update_barrier_parameter`
// so the adaptive-μ oracles (probing, quality-function) drive
// their affine/centering solves against `W(curr_N)`, not the
// stale `W(curr_{N-1})` left in `data.w` by the previous iter's
// tail-end Hessian update. Upstream calls `UpdateHessian()`
// first in every main-loop body (`IpIpoptAlg.cpp:386`); pounce
// previously reordered this to the tail, which made iters 1+
// pick μ from the prior iterate's Hessian on adaptive-mu +
// quality-function — visible on CRESC50 as a catastrophic
// early-iter divergence (theta=5.8e5 by iter 61 vs upstream
// never entering restoration).
timing.update_hessian.start();
let _ = self.bundle.hess.update_hessian(&self.data, &self.cq);
timing.update_hessian.end();
// 4. Barrier parameter. Pass nlp + search_dir through so the
// adaptive μ oracles (probing, quality-function) can drive
// their own affine-step solves; monotone ignores them.
// Snapshot the tiny-step flag (set by the previous iteration's
// tiny-step branch) and the entry mu — if μ can't reduce while
// the flag is on, upstream `IpMonotoneMuUpdate.cpp:158-161`
// throws TINY_STEP_DETECTED → STOP_AT_TINY_STEP, which we
// realise as a clean termination here.
//
// Both updates terminate, by different routes (pounce#512).
// Monotone has one throw site covering its whole update, so the
// μ-unchanged comparison below reconstructs it exactly, gated on
// `terminates_on_tiny_step()`. `IpAdaptiveMuUpdate.cpp` throws at
// two specific sites (`:330-333`, `:377-380`) and merely fixes μ
// and keeps iterating elsewhere, so the comparison would over-fire
// there — on the no-bounds short-circuit, which returns before
// upstream even reads the flag, and on a free-mode oracle that
// re-picks the current μ. The adaptive update therefore raises
// `request_tiny_step_stop` at its own two sites and opts out of
// the comparison. (An earlier comment here claimed the adaptive
// update never self-terminates; it does — `force_no_progress` is
// what happens on the iterations that do *not* throw.)
timing.update_barrier_parameter.start();
let tiny_at_entry = self.data.borrow().tiny_step_flag;
let mu_before = self.data.borrow().curr_mu;
let mu_terminates_on_tiny = self.bundle.mu_update.terminates_on_tiny_step();
let next_mu = self.bundle.mu_update.update_barrier_parameter(
&self.data,
&self.cq,
self.nlp.as_ref(),
self.search_dir.as_mut(),
);
self.data.borrow_mut().curr_mu = next_mu;
timing.update_barrier_parameter.end();
// pounce#510 — line-search reset. Upstream's μ updates own a
// `linesearch_` handle and call `linesearch_->Reset()` (which
// clears the filter via `FilterLSAcceptor::Reset`,
// `IpFilterLSAcceptor.cpp:524-532`) at four fixed points:
// `IpAdaptiveMuUpdate.cpp:339` (fixed-mode decrease), `:386`
// (free→fixed switch), `:431` (**unconditionally** on every
// free-mode iteration, μ moved or not), and
// `IpMonotoneMuUpdate.cpp:165` (after a monotone reduction).
// Pounce's `MuUpdate` trait has no line-search handle, so each
// update raises `request_ls_reset` at exactly those points and
// we honour it here — the same plumbing `request_resto` uses
// below.
//
// This used to be inferred from `next_mu != mu_before`. That
// proxy is right for the monotone update but wrong for the
// adaptive one, which resets every free-mode iteration
// regardless of μ: whenever μ stayed numerically put (the
// free-mode endgame, and any iteration after a restoration that
// returns at the same μ) the filter kept entries computed
// against a barrier parameter and an iterate the algorithm had
// already left. On #505's reproducer that rejected every trial
// step from α=2.4e-6 down to 1e-12 on the filter alone and
// forced a spurious restoration.
//
// Both flags are consumed here, but the tiny-step stop is
// answered first: at each of the two adaptive sites that raise
// it, upstream's `TINY_STEP_DETECTED` throw sits *above* the
// reset it would otherwise reach (`cpp:330-333` before `:339`,
// `:377-380` before `:386`), so a terminating iteration never
// resets the line search.
let (tiny_step_stop_requested, ls_reset) = {
let mut d = self.data.borrow_mut();
let flags = (d.request_tiny_step_stop, d.request_ls_reset);
d.request_tiny_step_stop = false;
d.request_ls_reset = false;
flags
};
if tiny_step_stop_requested
|| (tiny_at_entry
&& mu_terminates_on_tiny
&& (next_mu - mu_before).abs() < Number::EPSILON)
{
return IterateOutcome::Terminate(SolverReturn::StopAtTinyStep);
}
if ls_reset {
self.bundle.line_search.reset();
}
// pounce#58 — iterate-quality guard for the probing oracle.
// The μ-update layer sets `request_resto` when the input
// iterate is too corrupted for the probing rule to produce a
// sane μ (see `mu/adaptive.rs` Probing dispatch). Restoration
// re-initialises the multipliers and gives the outer loop a
// clean iterate to continue from. When no restoration phase
// is configured (embedded callers, tests), emit a one-line
// notice and continue with the current μ — the guard has
// already prevented the destabilising 4-order μ jump.
let request_resto = {
let mut d = self.data.borrow_mut();
let f = d.request_resto;
d.request_resto = false;
f
};
if request_resto {
if self.restoration.is_some() {
return self.invoke_restoration_debugged();
} else {
tracing::warn!(target: "pounce::algorithm",
"[POUNCE] probing-oracle iterate-quality guard fired \
at iter {}, but no restoration phase is configured; \
continuing with μ={:.3e}.",
self.data.borrow().iter_count,
next_mu,
);
}
}
// Sub-iteration checkpoint: μ has been updated for this iteration.
if let Some(o) = self.debug_stop(crate::debug::Checkpoint::AfterBarrierUpdate) {
return o;
}
// 5. Search direction. Skipped without an NLP + search_dir.
// (Hessian was updated in step 3 above before the barrier-μ
// oracle so that adaptive-μ uses W(curr_N), not stale W.)
if let (Some(nlp), Some(sd)) = (self.nlp.as_ref(), self.search_dir.as_mut()) {
timing.compute_search_direction.start();
// Fields are declared `Empty` and filled by the linear
// solver (matrix size, factor nnz, inertia, ordering — see
// `pounce_feral::record_factor_stats`) and below
// (regularization), so the `linear_solve` span carries the
// KKT-solve characteristics for the JSON sink (pounce#71).
let ls_span = tracing::info_span!(
target: "pounce::linsol",
"linear_solve",
n = tracing::field::Empty,
matrix_nnz = tracing::field::Empty,
factor_nnz = tracing::field::Empty,
inertia_neg = tracing::field::Empty,
fill_ratio = tracing::field::Empty,
ordering = tracing::field::Empty,
regularization = tracing::field::Empty,
);
let ls_enter = ls_span.enter();
let ok = sd.compute_search_direction(&self.data, &self.cq, nlp);
ls_span.record("regularization", self.data.borrow().info_regu_x);
// Within-span marker so the enriched `linear_solve` fields
// (filled by the solver above) surface to the JSON sink at
// debug level; off at the default `info` level.
tracing::debug!(target: "pounce::linsol", "kkt solve complete");
drop(ls_enter);
timing.compute_search_direction.end();
// Fine-grained time-budget gate (pounce#244). The KKT solve now
// checks the shared deadline *between* its major factorization
// steps (inertia correction / iterative refinement) and aborts
// cooperatively when the budget is crossed — bounding the
// overshoot to roughly one factorization instead of the whole
// multi-factorization sweep that #242's post-solve check let run
// to completion. Whether the solve returned a completed step or
// bailed mid-escalation, if the deadline tripped, stop here with
// the time-limit status *before* the `!ok` branch below would
// otherwise route a deadline-aborted solve into restoration.
// `data.curr` is untouched by the step computation, so it still
// holds the last accepted iterate.
if let Some(ret) = self.deadline_status() {
return IterateOutcome::Terminate(ret);
}
if !ok {
// Mirror upstream `IpIpoptAlg.cpp:417-430`: a failed
// step computation puts the algorithm in emergency
// mode, which calls `BacktrackingLineSearch::
// ActivateFallbackMechanism` (cpp:1312-1328). When a
// restoration phase is configured, the next pass of
// `ComputeAcceptableTrialPoint` sees `goto_resto` at
// cpp:299-306 and hands control to restoration. Only
// when neither restoration nor an acceptor-level
// fallback is available does upstream throw
// `STEP_COMPUTATION_FAILED`.
if self.restoration.is_some() {
return self.invoke_restoration_debugged();
}
return IterateOutcome::Terminate(SolverReturn::ErrorInStepComputation);
}
if std::env::var_os("POUNCE_DBG_DELTA").is_some() {
let d = self.data.borrow();
let it = d.iter_count;
if let Some(delta) = d.delta.as_ref() {
use crate::iterates_vector::IteratesVector;
use pounce_linalg::{Vector, compound_vector::CompoundVector};
let dv: &IteratesVector = delta;
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} mu={:.6e} dx_amax={:.6e} ds_amax={:.6e} dyc_amax={:.6e} dyd_amax={:.6e} dzL_amax={:.6e} dzU_amax={:.6e} dvL_amax={:.6e} dvU_amax={:.6e}",
it, d.curr_mu,
dv.x.amax(), dv.s.amax(), dv.y_c.amax(), dv.y_d.amax(),
dv.z_l.amax(), dv.z_u.amax(), dv.v_l.amax(), dv.v_u.amax()
);
if let Some(cdx) = dv.x.as_any().downcast_ref::<CompoundVector>() {
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} dx_blocks_amax: orig={:.6e} nc={:.6e} pc={:.6e} nd={:.6e} pd={:.6e}",
it,
cdx.comp(0).amax(),
cdx.comp(1).amax(),
cdx.comp(2).amax(),
cdx.comp(3).amax(),
cdx.comp(4).amax(),
);
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} dx_blocks_nrm2: orig={:.6e} nc={:.6e} pc={:.6e} nd={:.6e} pd={:.6e}",
it,
cdx.comp(0).nrm2(),
cdx.comp(1).nrm2(),
cdx.comp(2).nrm2(),
cdx.comp(3).nrm2(),
cdx.comp(4).nrm2(),
);
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} dx_blocks_asum: orig={:.6e} nc={:.6e} pc={:.6e} nd={:.6e} pd={:.6e}",
it,
cdx.comp(0).asum(),
cdx.comp(1).asum(),
cdx.comp(2).asum(),
cdx.comp(3).asum(),
cdx.comp(4).asum(),
);
// Argmax of orig block via dot with sign — print first few values.
if let Some(dv_orig) =
cdx.comp(0)
.as_any()
.downcast_ref::<pounce_linalg::dense_vector::DenseVector>()
{
let v = dv_orig.values();
let mut imax = 0usize;
let mut amax = 0.0f64;
for (i, &x) in v.iter().enumerate() {
if x.abs() > amax {
amax = x.abs();
imax = i;
}
}
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} dx_orig argmax: i={} v={:.17e} (n={})",
it,
imax,
v[imax],
v.len()
);
}
}
let p = &d.perturbations;
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} pert: dx={:.6e} ds={:.6e} dc={:.6e} dd={:.6e}",
it, p.delta_x, p.delta_s, p.delta_c, p.delta_d
);
drop(d);
let cq = self.cq.borrow();
let gf = cq.curr_grad_f();
let gl = cq.curr_grad_lag_x();
let cc = cq.curr_c();
let cd = cq.curr_d_minus_s();
let sx = cq.curr_sigma_x();
let ss = cq.curr_sigma_s();
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} cq: gradf_amax={:.6e} gradf_nrm2={:.6e} gradlag_amax={:.6e} gradlag_nrm2={:.6e} c_amax={:.6e} c_nrm2={:.6e} d_amax={:.6e} d_nrm2={:.6e} sigx_amax={:.6e} sigx_nrm2={:.6e} sigs_amax={:.6e} sigs_nrm2={:.6e}",
it,
gf.amax(), gf.nrm2(),
gl.amax(), gl.nrm2(),
cc.amax(), cc.nrm2(),
cd.amax(), cd.nrm2(),
sx.amax(), sx.nrm2(),
ss.amax(), ss.nrm2(),
);
if let Some(cgf) = gf.as_any().downcast_ref::<CompoundVector>() {
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} gradf_blocks_amax: orig={:.6e} nc={:.6e} pc={:.6e} nd={:.6e} pd={:.6e}",
it,
cgf.comp(0).amax(),
cgf.comp(1).amax(),
cgf.comp(2).amax(),
cgf.comp(3).amax(),
cgf.comp(4).amax(),
);
}
if let Some(curr) = self.data.borrow().curr.clone() {
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} bound_mults: zL_amax={:.6e} zU_amax={:.6e} vL_amax={:.6e} vU_amax={:.6e} s_amax={:.6e} s_nrm2={:.6e} x_amax={:.6e} x_nrm2={:.6e}",
it,
curr.z_l.amax(), curr.z_u.amax(),
curr.v_l.amax(), curr.v_u.amax(),
curr.s.amax(), curr.s.nrm2(),
curr.x.amax(), curr.x.nrm2(),
);
if let Some(czl) = curr.z_l.as_any().downcast_ref::<CompoundVector>() {
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} zL_blocks_amax: orig={:.6e} nc={:.6e} pc={:.6e} nd={:.6e} pd={:.6e}",
it,
czl.comp(0).amax(),
czl.comp(1).amax(),
czl.comp(2).amax(),
czl.comp(3).amax(),
czl.comp(4).amax(),
);
}
if let Some(czu) = curr.z_u.as_any().downcast_ref::<CompoundVector>() {
tracing::debug!(target: "pounce::algorithm", "[PN_DELTA] iter={} zU_ncomps={}", it, czu.n_comps());
for ic in 0..czu.n_comps() {
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} zU_block[{}]_amax={:.6e} dim={}",
it,
ic,
czu.comp(ic).amax(),
czu.comp(ic).dim()
);
}
}
}
if let Some(csx) = sx.as_any().downcast_ref::<CompoundVector>() {
tracing::debug!(target: "pounce::algorithm",
"[PN_DELTA] iter={} sigx_blocks_amax: orig={:.6e} nc={:.6e} pc={:.6e} nd={:.6e} pd={:.6e}",
it,
csx.comp(0).amax(),
csx.comp(1).amax(),
csx.comp(2).amax(),
csx.comp(3).amax(),
csx.comp(4).amax(),
);
}
drop(cq);
let d = self.data.borrow();
// Also dump curr.x_orig argmax
if let Some(curr) = d.curr.as_ref() {
if let Some(cx) = curr.x.as_any().downcast_ref::<CompoundVector>() {
if let Some(xo) =
cx.comp(0)
.as_any()
.downcast_ref::<pounce_linalg::dense_vector::DenseVector>()
{
let v = xo.values();
let mut imax = 0usize;
let mut amax = 0.0f64;
for (i, &x) in v.iter().enumerate() {
if x.abs() > amax {
amax = x.abs();
imax = i;
}
}
tracing::debug!(target: "pounce::algorithm", "[PN_DELTA] iter={} curr_x_orig argmax: i={} v={:.17e} amax={:.17e} nrm2={:.17e}",
it, imax, v[imax], xo.amax(), xo.nrm2());
}
}
}
}
}
}
// Capture KKT-factorization diagnostics for the debugger before
// the line search runs. Only when a debugger is installed. The
// inertia/status fields are cheap and always captured; the matrix
// triplets and `LDLᵀ` factor are O(nnz) assemblies, so they're
// captured only while the debugger is stepping (`wants_kkt_capture`)
// — a detached/free-running debugger drops them to keep the run
// cheap. `kkt_debug` is overwritten every iteration and never
// cleared at `iter_start`, so a stepping session always has the
// previous iteration's system to look back at via `viz kkt`/`viz L`.
if let Some(hook) = self.debug.as_ref() {
let capture_heavy = hook.borrow().wants_kkt_capture();
let captured_iter = self.data.borrow().iter_count;
let info = self.search_dir.as_ref().map(|sd| {
let pd = sd.pd_solver_mut();
let aug = pd.aug_solver();
let provides = aug.provides_inertia();
crate::ipopt_data::KktDebug {
iter: captured_iter,
dim: aug.system_dim(),
n_neg: if provides {
aug.number_of_neg_evals()
} else {
-1
},
provides_inertia: provides,
status: format!("{:?}", aug.last_solve_status()),
matrix: if capture_heavy {
aug.kkt_triplets()
} else {
None
},
l_factor: if capture_heavy {
aug.l_factor(true)
} else {
None
},
}
});
self.data.borrow_mut().kkt_debug = info;
}
// Sub-iteration checkpoint: the Newton step `δ` (data.delta) and
// the applied regularization are now available, before the line
// search consumes them.
if let Some(o) = self.debug_stop(crate::debug::Checkpoint::AfterSearchDirection) {
return o;
}
// Fine-grained time-budget gate (pounce#242). The KKT
// factorization (and any inertia-correction / quality-escalation
// refactorizations) is the single most expensive step of a large
// solve, and it has just finished. Check the deadline here so an
// over-budget solve returns its current best iterate *before*
// spending a line search and another whole iteration — bounding
// the overshoot to roughly one search-direction computation
// instead of a full outer iteration. `data.curr` is untouched by
// the step computation (the trial lives in `data.trial`), so it
// still holds the last accepted iterate.
if let Some(ret) = self.deadline_status() {
return IterateOutcome::Terminate(ret);
}
// 6. Acceptable trial point — run the line search if we have a
// primal/dual step on `data.delta`. Wrap in a guard so all
// early-return paths (ErrorInStepComputation, InternalError,
// restoration entry) still stop the timer.
let _ls_guard = timing.compute_acceptable_trial_point.guard();
let have_delta = self.data.borrow().delta.is_some();
if have_delta {
let delta = match self.data.borrow().delta.as_ref().cloned() {
Some(d) => d,
None => {
return IterateOutcome::Terminate(SolverReturn::ErrorInStepComputation);
}
};
// Cap alpha by the primal fraction-to-the-boundary so the
// first trial cannot push slacks past their bounds, and by
// the dual FTB so bound multipliers stay positive. Mirrors
// upstream `IpBacktrackingLineSearch::FindAcceptableTrialPoint`'s
// calls to `IpCq.primal_frac_to_the_bound` /
// `IpCq.dual_frac_to_the_bound` with τ = `curr_tau`.
let tau = self.data.borrow().curr_tau;
let alpha_p_max = self.cq.borrow().aff_step_alpha_primal_max(&delta, tau);
let alpha_d_max = self.cq.borrow().aff_step_alpha_dual_max(&delta, tau);
// Tiny-step gate — port of `IpBacktrackingLineSearch.cpp:363`
// and the handling block at lines 382-435. When the search
// direction is so small that any nonzero α would just
// bounce inside floating-point noise, take the FTB step
// unchecked and skip the line search; that's the only way
// to hit `STOP_AT_TINY_STEP` cleanly when the iterate is
// already at a converged point but `nlp_error > tol` due to
// scaling or unbounded duals.
if self.detect_tiny_step(&delta) {
let alpha_p = alpha_p_max;
let alpha_d = alpha_d_max;
let curr = match self.data.borrow().curr.clone() {
Some(c) => c,
None => return IterateOutcome::Terminate(SolverReturn::InternalError),
};
let trial_iv = scaled_step_unchecked(&curr, &delta, alpha_p, alpha_d);
{
let mut d = self.data.borrow_mut();
d.set_trial(trial_iv);
d.info_alpha_primal = alpha_p;
d.info_alpha_dual = alpha_d;
d.info_ls_count = 0;
if self.tiny_step_last_iteration {
d.info_alpha_primal_char = 'T';
d.tiny_step_flag = true;
} else {
d.info_alpha_primal_char = 't';
}
}
let dy_amax = delta.y_c.amax().max(delta.y_d.amax());
self.tiny_step_last_iteration = dy_amax < self.tiny_step_y_tol;
} else {
self.tiny_step_last_iteration = false;
let alpha_init = self.alpha_init.min(alpha_p_max);
let alpha_dual = self.alpha_init.min(alpha_d_max);
let outcome = self.bundle.line_search.find_acceptable_trial_point(
&self.data,
&self.cq,
&delta,
alpha_init,
alpha_dual,
self.nlp.as_ref(),
self.search_dir.as_mut(),
);
match outcome {
Outcome::Accepted => {
// A normal LS-accepted step breaks any in-flight
// restoration cycle — clear the cycle detector
// so the next resto entry starts fresh.
self.last_resto_entry_x = None;
self.last_resto_entry_s = None;
self.last_resto_recovery_x = None;
self.last_resto_recovery_s = None;
self.resto_no_outer_progress_count = 0;
// Intentionally *not* clearing
// `resto_near_feasible_count` here: DECONVBNE's
// cycle interleaves R-recoveries with 2-3
// LS-accepted 'f'/'h' steps (which return
// `Outcome::Accepted` but accomplish no real
// outer progress — alpha drops to 1e-6 and
// inf_du remains pinned at 1.9e7), so resetting
// on every accept would zero the counter every
// cycle and never fire. The counter persists
// for the duration of the run and trips after
// 3 cumulative near-feasible entries; legitimate
// solves enter resto at most once at near-
// feasibility (POLAK6, HAIFAM) and stay under
// the limit.
}
Outcome::TinyStep | Outcome::Failed => {
// Debugger stop: the line search rejected the step
// (tiny-step floor or all backtracks failed), before
// we fall into restoration. Lets a "why did the line
// search give up?" inspection happen at the failing
// point distinctly from the restoration entry.
if let Some(o) = self.debug_stop(crate::debug::Checkpoint::StepRejected) {
return o;
}
// Upstream `IpBacktrackingLineSearch.cpp` raises
// `LINE_SEARCH_FAILED` when α drops below
// `alpha_min` or all retries reject, which in
// turn triggers `ActivateLineSearch` →
// restoration.
return self.invoke_restoration_debugged();
}
Outcome::Deadline => {
// The time budget was crossed inside the line
// search (pounce#242). No trial was promoted, so
// `data.curr` still holds the best iterate; stop
// with the matching time-limit status. Re-derive
// wall vs CPU from the deadline (it can only still
// be exceeded — time is monotonic).
return IterateOutcome::Terminate(
self.deadline_status()
.unwrap_or(SolverReturn::WallTimeExceeded),
);
}
}
}
}
// End the line-search/trial timer here so the bookkeeping in
// steps 7-8 below is attributed to `accept_trial_point` (which
// mirrors upstream's split: filter update and FTB reset are
// accept-side, not line-search-side).
_ls_guard.stop();
// 7. Accept trial point (promotes `trial` to `curr` if set).
// The acceptor's filter has already been augmented (when
// appropriate) inside `find_acceptable_trial_point` via
// `update_for_next_iteration`, mirroring upstream's call
// chain in `IpBacktrackingLineSearch.cpp:839`.
let _accept_guard = timing.accept_trial_point.guard();
// 7a. Safe-slack bound adjustment. Before promoting `trial`, move
// any `x_L/x_U/d_L/d_U` whose trial slack fell below
// `eps*min(1,mu)` so the slack becomes representable (port of
// the bound-adjustment block in
// `IpoptAlgorithm::AcceptTrialPoint`, `IpIpoptAlg.cpp:664-706`).
self.adjust_variable_bounds_for_small_slacks();
self.data.borrow_mut().accept_trial_point();
// 8. Bound multiplier kappa_sigma reset.
self.correct_bound_multiplier();
// Sub-iteration checkpoint: the trial point was accepted; α and
// the new iterate are in place (before the loop's iter bookkeeping
// and the next `IterStart`).
drop(_accept_guard);
if let Some(o) = self.debug_stop(crate::debug::Checkpoint::AfterStep) {
return o;
}
IterateOutcome::Continue
}
/// Port of `IpBacktrackingLineSearch::DetectTinyStep`
/// (`IpBacktrackingLineSearch.cpp:1219-1278`). Returns true iff
/// `max_i |δx_i|/(1+|x_i|) ≤ tiny_step_tol`,
/// `max_i |δs_i|/(1+|s_i|) ≤ tiny_step_tol`, AND
/// `curr_constraint_violation ≤ 1e-4`. Disabled when
/// `tiny_step_tol == 0`.
fn detect_tiny_step(&self, delta: &crate::iterates_vector::IteratesVector) -> bool {
if self.tiny_step_tol == 0.0 {
return false;
}
let curr = match self.data.borrow().curr.clone() {
Some(c) => c,
None => return false,
};
// |x_i|+1
let mut tmp = curr.x.make_new_copy();
tmp.element_wise_abs();
tmp.add_scalar(1.0);
// |δx_i|/(|x_i|+1) ; checked via Amax of (δx ./ (|x|+1)).
let mut tmp2 = delta.x.make_new_copy();
tmp2.element_wise_divide(&*tmp);
if tmp2.amax() > self.tiny_step_tol {
return false;
}
if curr.s.dim() > 0 {
let mut tmp = curr.s.make_new_copy();
tmp.element_wise_abs();
tmp.add_scalar(1.0);
let mut tmp2 = delta.s.make_new_copy();
tmp2.element_wise_divide(&*tmp);
if tmp2.amax() > self.tiny_step_tol {
return false;
}
}
let cviol = self.cq.borrow().curr_constraint_violation();
if cviol > 1e-4 {
return false;
}
true
}
/// Drive the restoration phase after a line-search failure.
/// Returns `IterateOutcome::Continue` if the restoration driver
/// recovered (the algorithm carries on from the recovered iterate);
/// otherwise terminates with [`SolverReturn::RestorationFailure`].
/// Mirrors upstream's
/// `IpBacktrackingLineSearch::ActivateLineSearch` → `PerformRestoration`
/// chain.
fn invoke_restoration(&mut self) -> IterateOutcome {
// Snapshot the outer reference iterate's `(theta, barr)` and
// build the orig-progress callback the inner IPM will consult
// at every iteration (mirrors upstream
// `IpRestoFilterConvCheck::SetOrigLSAcceptor` plus
// `IpFilterLSAcceptor::Reset`'s `reference_*_` snapshot).
let reference_theta = self.cq.borrow().curr_constraint_violation();
let reference_barr = self.cq.borrow().curr_barrier_obj();
if std::env::var("POUNCE_DBG_RESTO").is_ok() {
let iter = self.data.borrow().iter_count;
tracing::debug!(target: "pounce::algorithm",
"RESTO_ENTRY iter={} theta={:.6e} barr={:.6e} near_feas_ct={}",
iter, reference_theta, reference_barr, self.resto_near_feasible_count,
);
}
// Port gap: upstream refuses to enter restoration from an acceptable
// point, and this was missing. `IpBacktrackingLineSearch.cpp:557-570`,
// in the `if (!accept)` arm that hands off to restoration:
//
// if( CurrentIsAcceptable() )
// {
// THROW_EXCEPTION(ACCEPTABLE_POINT_REACHED,
// "Restoration phase called at acceptable point.");
// }
//
// The rationale is the obvious one: restoration reduces the constraint
// violation, so from a point that already passes the acceptable-level
// tolerances it has nothing to reduce, and entering can only risk a
// reportable solution.
//
// What the gap cost, measured on mittelmann `qcqp1000-1nc` (n=1000):
// the line search fails at iteration 187 on a point carrying the
// published optimum (`-2.6628866e+07`, matching ipopt-ma57 to 9
// significant figures) with overall NLP error `6.0e-8` — two orders
// inside `acceptable_tol`. Restoration walked it to `theta 5e-3` and
// ground out 2780 further iterations without recovering, so a solved
// problem reported a failure.
//
// The predicate is upstream's, unmodified: acceptability alone. A
// strict `constr_viol_tol` gate was tried on top and is both a
// deviation and useless — at their restoration entries `qcqp1000-1nc`
// sits at `theta = 6.0e-8`, `csfi2` at `1.5e-7`, `eigena2` at
// `2.1e-10`, all strictly feasible, one by six orders. Nothing
// observable at the doorway separates a restoration that recovers from
// one that does not, which is why upstream does not try to.
//
// Placed ahead of the cycle detectors below rather than beside
// upstream's `PrepareRestoPhaseStart()`: those detectors are a
// pounce-side addition, and an acceptable point should be reported
// regardless of cycle state. Filter augmentation is skipped on this
// path, which is immaterial — the run stops here.
//
// `current_is_acceptable_with_state` is the full triplet, never
// `theta` alone: gh #274, a perfectly feasible point can be
// arbitrarily far from stationary (`min -exp(x) s.t. x >= 0` reaches
// here with `inf_pr = 1.7e-10` and `inf_du = 8.8e+47`), and the
// triplet carries `acceptable_dual_inf_tol` to reject it. The
// finiteness check mirrors the one below (CUTE `himmelbj` reaches a
// near-feasible point where `f` evaluates to NaN) and matches
// upstream's own `curr_f` precondition for acceptability.
let (entry_f_finite, entry_nlp_err) = {
let cq = self.cq.borrow();
(cq.curr_f().is_finite(), cq.curr_nlp_error())
};
//
// What the guard still did not ask is whether the solve was *converging*
// (gh #534). It reads the entry point and nothing about the trajectory
// that reached it, so it stops a contracting endgame and a dead stall
// with equal confidence. On `eigena2` it fires while the dual
// infeasibility is quartering every iteration on unit steps
// (`1.19e-5 → 2.96e-6 → 7.38e-7 → 1.84e-7`), three iterations short of a
// strict certificate that costs nothing but those three iterations.
// [`Self::may_defer_acceptable_decline`] adds that missing question,
// and only that: when the answer is no — `eigenb2`'s tail rises, and
// `csfi2`'s last two iterations are flat to three digits — the guard
// fires exactly as before.
if entry_f_finite
&& self.bundle.conv_check.current_is_acceptable_with_state(
entry_nlp_err,
&self.data,
&self.cq,
)
{
if self.may_defer_acceptable_decline() {
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] deferring the restoration decline at theta {:.3e}: the entry \
point passes the acceptable-level tolerances (nlp_err {:.3e}) but the \
NLP error has contracted every iteration over the last {} \
({:.3e} -> {:.3e}); continuing for up to {} iterations, with that point \
held as the floor (gh #534).",
reference_theta, entry_nlp_err, DECLINE_PROGRESS_SAMPLES - 1,
self.nlp_err_recent[0], entry_nlp_err, DECLINE_CONTINUATION_BUDGET,
);
} else {
// The window is on the line because "why did the guard not
// defer?" is the first question anyone reading this trace has
// (gh #534), and reconstructing it from the iteration table
// means recomputing the scaled aggregate by hand.
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] declining restoration at theta {:.3e}: the entry point already \
passes the acceptable-level tolerances (nlp_err {:.3e}); reporting it \
rather than risking it in restoration. Recent NLP errors {} \
(contracting: {}).",
reference_theta, entry_nlp_err,
self.nlp_err_window_str(), self.nlp_err_contracting(),
);
return IterateOutcome::Terminate(SolverReturn::StopAtAcceptablePoint);
}
}
// No-progress restoration cycle detector. Two layered checks
// surface as `ErrorInStepComputation` instead of cycling to
// `max_iter` exhaustion (mirrors the *intent* of upstream
// `IpBacktrackingLineSearch.cpp:580-600`'s almost-feasible
// resto guard):
//
// 1. *Static cycle*: entry-to-entry — when the curr `(x, s)`
// at this entry is essentially identical to the snapshot
// from the previous entry, the inner resto-IPM is
// returning recovered iterates indistinguishable from
// entry, AND the outer didn't move either. Fires
// immediately. Catches QCNEW, EQC, MESH, POLAK6, S365,
// S365MOD, SIPOW2M, PFIT4.
//
// 2. *Slow-progress cycle*: recovery-to-entry — when curr at
// this entry is essentially identical to the *recovery*
// iterate from the previous resto, the outer made no
// progress between resto invocations even though resto's
// inner moved substantively. Counted, fires after 5
// consecutive entries. Catches ACOPR14, ACOPR30, TRO3X3
// while letting MAKELA3, HAIFAM, HALDMADS, ROBOT,
// TENBARS2 — which need 2-3 productive resto entries
// before LS accepts — pass through.
//
// A productive single-restoration sequence (BT8, HIMMELBJ,
// LINSPANH, LSNNODOC, ODFITS, OET3) clears both snapshots via
// `Outcome::Accepted` between entries and is unaffected.
let curr = self
.data
.borrow()
.curr
.as_ref()
.expect("curr set before invoke_restoration")
.clone();
// Helper: when the cycle detector fires and the orig cv is a
// violation the *user* calls a violation (e.g. PFIT1's 2.73e-2),
// the outer is stuck at a feasibility-stationary point and the
// honest exit is `LocalInfeasibility`. Below that threshold the
// iterate is primal-feasible by the user's own declaration, so there
// is no infeasibility to certify — the failure is numerical, not
// algorithmic, and `ErrorInStepComputation` is retained.
//
// The threshold is `constr_viol_tol`, and *only* `constr_viol_tol`
// (gh #508). The question this ternary asks — "is this violation
// real?" — is a question about the constraint violation, so it has to
// be asked with the option that declares what a violated constraint
// is. The previous form, `max(100·tol, 1e-4)`, was built from `tol`, a
// tolerance on the **KKT error**: different quantity, different units,
// and it never consulted `constr_viol_tol` at all. Two consequences,
// both measured on `min (x-5)² s.t. x²+δ = 0` (infeasible for every
// δ>0, reported violation exactly δ):
//
// * sweeping `constr_viol_tol` over four orders moved the boundary
// not at all — at `constr_viol_tol = 1e-3` a violation of `1e-4`,
// comfortably inside the user's declared feasibility tolerance,
// still exited 500;
// * sweeping `tol` moved it a great deal, and in the wrong
// direction: at `tol = 1e-4` the `1e-2` threshold swallowed every
// δ from `3e-4` to `1e-2` — a model infeasible by a full percent
// answered "your solver broke". Loosening `tol` is the standard
// user reaction to a struggling solve, so the failure widened
// exactly when the user tried to help.
//
// No `infeas_viol_kappa` margin on top, unlike the rapid-infeasibility
// pre-filter in `conv_check`. That detector fires *during* the solve
// off a streak heuristic and needs the margin to avoid convicting an
// iterate that is still converging; here restoration has already
// demonstrably cycled, so the certainty comes from the cycle evidence
// rather than from extra violation headroom. Widening to
// `kappa·constr_viol_tol` would move the default threshold from `1e-4`
// to `1e-2` and hand back 500 on the whole band in between.
//
// The comparison is `>=`, not `>`. A violation landing exactly on the
// threshold is a violation at the user's declared tolerance, and the
// reproducer above hits the boundary to the digit (`δ = 1e-4` at the
// default `constr_viol_tol`), where `>` returned 500 for a model
// infeasible by precisely the amount the user said was too much.
//
// The violation is measured **unscaled**. `reference_theta` is the
// row-scaled residual, but the floor below is an absolute, user-facing
// magnitude, so comparing the two mixes unit systems — and on a problem
// whose rows are scaled down the scaled residual can never clear it.
// `infeasible_equalities.nl` is the worked example: a square 2x2 system
// with a true violation of 2.0 that NLP scaling reports as 6.67e-7, so
// this test read `6.67e-7 > 1e-4` = false and a blatantly infeasible
// model exited `Error_In_Step_Computation` (AMPL 500, Pyomo
// `internalSolverError`). Square problems have no restoration-side
// locally-infeasible gate — `strict` carves them out so the outer gets
// another shot — so this cycle exit *is* their safety net, and it was
// disabled by the unit mismatch. Same user-visible family as gh #372.
//
// Note this also moves from a 1-norm (`curr_constraint_violation`) to a
// max-norm. Max-norm <= 1-norm, so the test is marginally stricter
// about declaring infeasibility on an unscaled problem — the safe
// direction for a verdict this consequential.
//
// `theta > 0` in front of the `>=` is not redundant: the options layer
// registers `constr_viol_tol` with a *strict* lower bound of zero, but
// a library embedder setting `ConvCheckOptions` directly is not bound
// by that, and `0 >= 0` would turn an exactly-feasible iterate into an
// infeasibility certificate. A zero violation never proves anything.
let cycle_viol_tol = self.bundle.conv_check.constr_viol_tol_or_default();
let reference_theta_unscaled = self.cq.borrow().curr_unscaled_primal_infeasibility_max();
let cycle_exit =
if reference_theta_unscaled > 0.0 && reference_theta_unscaled >= cycle_viol_tol {
SolverReturn::LocalInfeasibility
} else {
SolverReturn::ErrorInStepComputation
};
let static_cycle = if let (Some(prev_x), Some(prev_s)) = (
self.last_resto_entry_x.as_ref(),
self.last_resto_entry_s.as_ref(),
) {
let dx_rel = relative_distance(&*curr.x, &**prev_x);
let ds_rel = relative_distance(&*curr.s, &**prev_s);
if std::env::var_os("POUNCE_DBG_RESTO_CYCLE").is_some() {
tracing::debug!(target: "pounce::algorithm",
"[PN_RESTO_CYCLE] entry-vs-entry dx_rel={:.6e} ds_rel={:.6e}",
dx_rel, ds_rel
);
}
dx_rel <= 1e-10 && ds_rel <= 1e-10
} else {
false
};
if static_cycle {
// Prefer the last acceptable point over the cycle error —
// the borrows above are released, so the `&mut self` helper
// is free to roll back.
return self.terminate_acceptable_or(cycle_exit);
}
let recovery_cycle = if let (Some(prev_x), Some(prev_s)) = (
self.last_resto_recovery_x.as_ref(),
self.last_resto_recovery_s.as_ref(),
) {
let dx_rel = relative_distance(&*curr.x, &**prev_x);
let ds_rel = relative_distance(&*curr.s, &**prev_s);
if std::env::var_os("POUNCE_DBG_RESTO_CYCLE").is_some() {
tracing::debug!(target: "pounce::algorithm",
"[PN_RESTO_CYCLE] entry-vs-recovery dx_rel={:.6e} ds_rel={:.6e} count={}",
dx_rel, ds_rel, self.resto_no_outer_progress_count
);
}
dx_rel <= 1e-10 && ds_rel <= 1e-10
} else {
false
};
if recovery_cycle {
self.resto_no_outer_progress_count =
self.resto_no_outer_progress_count.saturating_add(1);
// 10-strike limit: tuned to give OET7-style traces room
// to break through (inner inf_pr still decreasing across
// strikes) while still bounding DECONVBNE-style cycles
// (which need a guard but tolerate a wider window —
// ~3 outer steps per cycle, so 10 strikes ≈ 30 outer
// iters, well below the 2987-iter pathological run).
if self.resto_no_outer_progress_count >= 10 {
// Prefer the last acceptable point over the cycle error;
// borrows are released, so the `&mut self` helper is free.
return self.terminate_acceptable_or(cycle_exit);
}
} else {
self.resto_no_outer_progress_count = 0;
}
// Near-feasible resto re-entry detector — matches the *intent*
// of upstream `IpBacktrackingLineSearch.cpp:580-600`'s almost-
// feasible-resto guard with a looser cv threshold. When the
// outer enters restoration with the constraint violation
// already at or below `tol`, the resto sub-IPM will produce a
// recovered iterate that's at most marginally more feasible,
// and any post-recovery σ-blowup from the next outer KKT solve
// will re-trigger resto on the next iteration. Counting these
// entries surfaces the cycle as `StopAtAcceptablePoint` —
// primal feasibility is already met, only the dual residual
// remains. Catches DECONVBNE: pounce ran 2987 iters before
// this guard (cycle of ~30-inner-resto + 3 outer per cycle);
// upstream solves in 505 iters via a different x trajectory.
// Single-entry productive restos (BT8, HIMMELBJ, ODFITS) and
// sub-tol-but-recoverable starts pass through under the 3-
// strike limit.
let outer_tol = self.bundle.conv_check.tol_or_default();
if reference_theta <= outer_tol {
self.resto_near_feasible_count = self.resto_near_feasible_count.saturating_add(1);
if self.resto_near_feasible_count >= 3 {
// Constraint feasibility is met, but a near-feasible iterate is
// only "acceptable" if its objective is finite. CUTE `himmelbj`
// reaches a point with cv ≈ 2e-9 where f evaluates to NaN; that
// must surface as Invalid_Number_Detected rather than be
// reported as Solved_To_Acceptable_Level with a `nan` objective.
if !self.cq.borrow().curr_f().is_finite() {
return IterateOutcome::Terminate(SolverReturn::InvalidNumberDetected);
}
// Constraint feasibility alone does not make a point
// acceptable. `reference_theta` measures only the *primal*
// residual, so a perfectly feasible iterate can still be
// arbitrarily far from stationary — which is exactly what an
// unbounded objective looks like from here: the constraints
// stay satisfied while the iterates run off toward -inf.
//
// `min -exp(x) s.t. x >= 0` re-enters restoration with
// `inf_pr = 1.7e-10` and `inf_du = 8.8e+47`; before gh #274
// the finiteness check was the only gate, `-8.8e47` is
// finite, and the solve was reported as
// `Solved_To_Acceptable_Level` with `solve_result_num = 100`.
// Pyomo maps that into the *solved* family and loads the
// diverging iterate as an optimal solution.
//
// So require the point to pass the full acceptable-level
// triplet (which includes `acceptable_dual_inf_tol`) before
// claiming acceptability. When it does not, surface
// `cycle_exit` — the same honest status the other two
// restoration-cycle exits in this function use.
let nlp_err = self.cq.borrow().curr_nlp_error();
if !self
.bundle
.conv_check
.current_is_acceptable_with_state(nlp_err, &self.data, &self.cq)
{
tracing::debug!(target: "pounce::algorithm",
"[POUNCE] near-feasible restoration re-entry at theta {:.3e} \
but the point fails the acceptable-level tolerances \
(nlp_err {:.3e}); reporting {:?} rather than \
Solved_To_Acceptable_Level (gh#274).",
reference_theta, nlp_err, cycle_exit,
);
return IterateOutcome::Terminate(cycle_exit);
}
return IterateOutcome::Terminate(SolverReturn::StopAtAcceptablePoint);
}
} else {
self.resto_near_feasible_count = 0;
}
self.last_resto_entry_x = Some(curr.x.make_new_copy());
self.last_resto_entry_s = Some(curr.s.make_new_copy());
// Augment the outer's filter with the resto-entry envelope —
// mirrors upstream `IpBacktrackingLineSearch.cpp:566`:
// `acceptor_->PrepareRestoPhaseStart()`. Adds
// `((1-γ_θ)·θ_entry, φ_entry - γ_φ·θ_entry)` to the filter so
// that after restoration recovers, the outer's Newton step is
// forced by the filter to make real progress vs the entry
// point. Without this, the outer accepts null-progress 'h'
// steps and re-enters restoration on the next iteration (root
// cause of DECONVBNE's 323 R-accepts vs ipopt's 21).
self.bundle
.line_search
.acceptor_mut()
.prepare_resto_phase_start(reference_theta, reference_barr);
let orig_progress_cb = self.bundle.line_search.acceptor().make_orig_progress_check(
reference_theta,
reference_barr,
5.0,
);
let (Some(nlp), Some(sd), Some(resto)) = (
self.nlp.as_ref(),
self.search_dir.as_mut(),
self.restoration.as_mut(),
) else {
return IterateOutcome::Terminate(SolverReturn::RestorationFailure);
};
resto.set_orig_progress_check(orig_progress_cb);
// Forward the shared debugger so it can step the inner solve.
resto.set_debug_hook(self.debug.as_ref().map(Rc::clone));
let mut pd_guard = sd.pd_solver_mut();
let aug = pd_guard.aug_solver_mut();
// Audit counters (pounce#12). Increment call count + outer-iter
// count (one outer iter is consumed per restoration call) and
// wall-time around the inner call. Inner iter count is read
// after via the trait accessor.
self.resto_calls = self.resto_calls.saturating_add(1);
self.resto_outer_iters = self.resto_outer_iters.saturating_add(1);
let resto_t0 = std::time::Instant::now();
let outcome = resto.perform_restoration(&self.data, &self.cq, nlp, aug);
drop(pd_guard);
self.resto_wall_secs += resto_t0.elapsed().as_secs_f64();
self.resto_inner_iters = self
.resto_inner_iters
.saturating_add(resto.last_inner_iter_count());
// pounce#244: the restoration inner IPM shares the outer solve's
// `Deadline` (both its convergence check and — post-#244 — its KKT
// solves consult it), so a budget crossing inside restoration
// terminates the inner solve with a time-limit status. Surface that
// as the time limit directly instead of letting the `Failed` arm map
// it onto `RestorationFailure` / `StopAtAcceptablePoint`. `data.curr`
// is the last accepted outer iterate — restoration stages its
// recovered point onto `trial`, not `curr`, and we return before
// promoting it — so this hands back a valid iterate.
if let Some(ret) = self.deadline_status() {
return IterateOutcome::Terminate(ret);
}
match outcome {
RestorationOutcome::Recovered => {
// Mirror upstream `IpBacktrackingLineSearch.cpp:624-631`:
// a successful restoration clears the line search's
// cross-iteration globalization counters. Upstream runs
// restoration inside `FindAcceptableTrialPoint` so those
// assignments are inline; pounce runs it here, so the
// reset has to be driven from here. Without it
// `watchdog_shortened_iter` survives a restoration
// episode and runs of shortened steps on either side of
// one accumulate as if consecutive, arming the watchdog
// where upstream would not. See
// `BacktrackingLineSearch::reset_after_restoration`.
self.bundle.line_search.reset_after_restoration();
// The driver has staged the recovered point on
// `data.trial`; apply the safe-slack bound adjustment
// (as the main accept path does), then promote it and
// continue iterating.
self.adjust_variable_bounds_for_small_slacks();
self.data.borrow_mut().accept_trial_point();
// Snapshot the recovery iterate for the slow-cycle
// detector at the top of the next `invoke_restoration`.
// Compared against next-entry curr, dx_rel ≈ ‖α·d‖ —
// measures purely the outer step. See header comment
// on the cycle detector above.
let recovered = self
.data
.borrow()
.curr
.as_ref()
.expect("accept_trial_point sets curr")
.clone();
self.last_resto_recovery_x = Some(recovered.x.make_new_copy());
self.last_resto_recovery_s = Some(recovered.s.make_new_copy());
// Mirror upstream `IpoptAlgorithm::AcceptTrialPoint`
// (`IpIpoptAlg.cpp:917-963`): kappa_sigma clamp on the
// four bound-multiplier vectors. Upstream applies this
// unconditionally inside AcceptTrialPoint, so the
// post-restoration path inherits it; pounce factored
// the clamp out of the data swap so we must call it
// explicitly here. Without it the all-1 multiplier
// reset (`bound_mult_reset_threshold`) leaves z*s far
// from mu at the recovered iterate, blowing up the
// next KKT solve's σ = z/s diagonal.
self.correct_bound_multiplier();
IterateOutcome::Continue
}
RestorationOutcome::Failed => {
// Mirrors upstream `IpBacktrackingLineSearch.cpp:611-623`:
// when `PerformRestoration` returns false, attempt to
// roll back to the most recent acceptable iterate before
// surfacing failure. If a snapshot is available we exit
// cleanly with `StopAtAcceptablePoint` (mapped by the
// application layer to `Solved_To_Acceptable_Level`),
// matching the upstream `ACCEPTABLE_POINT_REACHED`
// throw. Without a snapshot we surface
// `RestorationFailure` — unless the restoration left the
// iterate diverging (`|x|_∞ > diverging_iterates_tol`), in
// which case we surface `DivergingIterates` to mirror the
// outcome upstream produces on pathological problems like
// MESH (where ipopt reports `Diverging_Iterates` and
// pounce previously reported `Restoration_Failed` with an
// obj of −3.6e+33). As in the running guard above, a large
// `|x|` is only reported as unbounded when it is
// structurally consistent with an unbounded feasible region
// and the divergence is genuine — either it has persisted
// (the running guard's growth-and-descent streak, which only
// accumulates on a real recession ray; issues #248 / #252) or
// blown past the absolute runaway backstop; otherwise the
// failure is a plain `RestorationFailure`, never a spurious
// `Unbounded`.
if self.restore_acceptable_point() {
IterateOutcome::Terminate(SolverReturn::StopAtAcceptablePoint)
} else {
let diverging = {
let data = self.data.borrow();
match data.curr.as_ref() {
Some(curr) => {
let amax = curr.x.amax();
amax > self.diverging_iterates_tol
&& self.divergence_is_true_unboundedness(&*curr.x)
&& (amax >= Self::DIVERGENCE_ABS_RUNAWAY
|| self.divergence_streak >= Self::DIVERGENCE_PERSIST_ITERS)
}
None => false,
}
};
if diverging {
IterateOutcome::Terminate(SolverReturn::DivergingIterates)
} else {
IterateOutcome::Terminate(SolverReturn::RestorationFailure)
}
}
}
RestorationOutcome::LocallyInfeasible => {
// Mirrors upstream's catch of `LOCALLY_INFEASIBLE` thrown
// from `IpRestoConvCheck.cpp:240` — the resto sub-IPM
// settled at a stationary point of `||c(x)||_1` whose
// residual is still well above `tol`. Without this
// detection the outer would re-enter restoration on the
// unchanged iterate forever.
//
// gh #505: consult the acceptable-point stash, for the same
// reason the conv-check arm above does and the cycle exits
// already did. This is the *third* site that produced
// `LocalInfeasibility`, and the only one not gated on
// `infeas_max_streak` — which matters, because on the reported
// instance raising that knob to 15 did not move the run by a
// single iteration, so the verdict there is not the outer
// detector's. Whichever route reaches it, a solve that passed
// through an acceptable iterate must not discard it.
//
// Inert on genuinely infeasible models by the same argument as
// the other two: nothing is stashed unless the whole acceptable
// triplet passed, so `terminate_acceptable_or` falls through to
// the verdict unchanged.
self.terminate_local_infeasibility()
}
}
}
/// Safe-slack bound adjustment, applied to the staged `trial`
/// iterate before it is promoted to `curr`. When one or more trial
/// slacks fell below `eps*min(1,mu)`, [`IpoptCalculatedQuantities::
/// adjusted_trial_bounds`] returns the moved `x_L/x_U/d_L/d_U`; we
/// install them on the NLP so the slack becomes representable. Port
/// of the bound-adjustment block in `IpoptAlgorithm::AcceptTrialPoint`
/// (`IpIpoptAlg.cpp:664-706`).
fn adjust_variable_bounds_for_small_slacks(&mut self) {
// Compute the moved bounds (releases the CQ/NLP borrows on return).
let adjusted = {
let trial_set = self.data.borrow().trial.is_some();
if !trial_set {
return;
}
self.cq.borrow().adjusted_trial_bounds()
};
let Some(bounds) = adjusted else {
return;
};
tracing::debug!(
target: "pounce::algorithm",
"slack_move: {} slack(s) too small, adjusting variable bound(s) at iter {}",
bounds.adjusted,
self.data.borrow().iter_count,
);
let nlp = Rc::clone(self.cq.borrow().nlp());
nlp.borrow_mut().adjust_variable_bounds(
&*bounds.x_l,
&*bounds.x_u,
&*bounds.d_l,
&*bounds.d_u,
);
}
/// Port of `IpIpoptAlg::correct_bound_multiplier`
/// (`IpIpoptAlg.cpp:1055-1134`). Clamp each bound multiplier
/// component into `[mu/(kappa_sigma * s_i), kappa_sigma * mu / s_i]`
/// for all four bound-multiplier vectors.
fn correct_bound_multiplier(&mut self) {
if self.kappa_sigma < 1.0 {
return;
}
let mu = self.data.borrow().curr_mu;
let curr = match self.data.borrow().curr.clone() {
Some(c) => c,
None => return,
};
let cq = self.cq.borrow();
let z_l_new = clamp_against_slack(&*curr.z_l, &*cq.curr_slack_x_l(), mu, self.kappa_sigma);
let z_u_new = clamp_against_slack(&*curr.z_u, &*cq.curr_slack_x_u(), mu, self.kappa_sigma);
let v_l_new = clamp_against_slack(&*curr.v_l, &*cq.curr_slack_s_l(), mu, self.kappa_sigma);
let v_u_new = clamp_against_slack(&*curr.v_u, &*cq.curr_slack_s_u(), mu, self.kappa_sigma);
drop(cq);
let new_iv = crate::iterates_vector::IteratesVector::new(
curr.x.clone(),
curr.s.clone(),
curr.y_c.clone(),
curr.y_d.clone(),
z_l_new,
z_u_new,
v_l_new,
v_u_new,
);
self.data.borrow_mut().set_curr(new_iv);
}
/// Outer entry point — port of `IpoptAlgorithm::Optimize()`. Calls
/// the iterate-initializer once, then loops `iterate()` until a
/// terminal status. The exception → SolverReturn mapping
/// (TINY_STEP_DETECTED → STEP_BECOMES_TINY,
/// RESTORATION_FAILED → RESTORATION_FAILURE, etc.) lands in
/// Phase 9 alongside the restoration phase.
/// Run the solve and finalize its result.
///
/// A thin wrapper on purpose. The gh #200 fallback must see **every** exit
/// of the driver loop, and wiring it into individual termination sites was
/// tried and failed — there are sixteen, and the ones easiest to overlook
/// are the ones most likely to matter. Keeping the loop in a separate
/// function means every `return` inside it, present or future, flows through
/// [`Self::honour_refused_certificate`] by construction rather than by the
/// author remembering to.
///
/// This got more important once the fallback started changing the status in
/// *both* directions: it can now hand back `StopAtAcceptablePoint` for a
/// `Success` it was given. Anything reading `result` before the hook is
/// reading a status that is not the one reported.
pub fn optimize(&mut self) -> SolverReturn {
let result = self.optimize_inner();
// gh #200: a refused certificate outranks any non-success verdict the
// continued run reached, and an earlier refusal can outrank the
// continued run's own certificate. Applied here, once.
let result = self.honour_refused_certificate(result);
// pounce#250 follow-up: the dual-divergence guard's diversion to
// restoration is a bet, and a lost bet must not return a worse point
// than the solve already had in hand. Applied here, once, for the same
// reason the #200 hook is — every `return` in the loop flows through
// this point by construction.
let result = self.honour_best_acceptable_after_dual_guard(result);
// gh #534: deferring the acceptable-point restoration decline is also a
// bet, and this is the net under it — a continuation that did not beat
// the point the guard would have returned hands that point back. Last of
// the three, so it compares against whatever the hooks above settled on.
let result = self.honour_decline_floor(result);
// Terminal post-mortem checkpoint. Skipped when the user already
// asked to stop (they were just at a prompt); otherwise the
// debugger gets a last look at the final/failing iterate.
if !matches!(result, SolverReturn::UserRequestedStop) {
self.fire_debug_terminal(result);
}
result
}
fn optimize_inner(&mut self) -> SolverReturn {
// Top-level span for the whole solve; every iteration / linear
// solve / restoration event nests under it (pounce#71).
let _solve_span = tracing::info_span!("solve").entered();
// Shared timing accumulator — every phase below records into it.
let timing = self.data.borrow().timing.clone();
// Install the shared accumulator on the augmented-system solver
// so its factor / back-solve calls are attributed to
// `linear_system_factorization` / `linear_system_back_solve`.
// Same pattern for the diagnostics state when present, so KKT
// dump sites can consult per-iter gating.
if let Some(sd) = self.search_dir.as_mut() {
sd.pd_solver_mut()
.aug_solver_mut()
.set_timing_stats(std::rc::Rc::clone(&timing));
if let Some(diag) = self.diagnostics.as_ref() {
sd.pd_solver_mut()
.aug_solver_mut()
.set_diagnostics(Rc::clone(diag));
}
}
// 0a. Strategy initialization — port of upstream's
// `IpoptAlgorithm::InitializeImpl` calls. The mu update needs
// `data.curr_mu`/`curr_tau` seeded before the iterate
// initializer runs (`CalculateSafeSlack` reads them).
self.bundle.mu_update.initialize(&self.data);
// 0b. Iterate initializer. Requires NLP; without one the caller
// must have populated `data.curr` themselves.
if let Some(nlp) = self.nlp.as_ref() {
// The initializer needs an aug-system solver for the
// least-square multiplier branch; until that's wired we
// route through whatever the search-direction calculator
// owns when present. For the stub flow we skip the LSM
// path by giving the initializer a dummy solver only if
// the search_dir is present (otherwise the init function
// is responsible for not consulting it).
if let Some(sd) = self.search_dir.as_mut() {
timing.initialize_iterates.start();
let mut pd_guard = sd.pd_solver_mut();
let aug_solver = pd_guard.aug_solver_mut();
let ok = self
.bundle
.init
.set_initial_iterates(&self.data, &self.cq, nlp, aug_solver);
drop(pd_guard);
timing.initialize_iterates.end();
if !ok {
return SolverReturn::InvalidProblemDefinition;
}
}
}
// 0c. Seed `IpoptData::w` with the initial-iterate Hessian.
// Redundant with the iter-body `update_hessian` call (which
// now runs BEFORE `update_barrier_parameter`) but kept to
// cover any code path that consults `data.w` between
// `set_initial_iterates` and the first `iterate()` call
// (e.g. the iter-0 trace dump below).
if self.data.borrow().curr.is_some() {
timing.update_hessian.start();
let _ = self.bundle.hess.update_hessian(&self.data, &self.cq);
timing.update_hessian.end();
}
// Track-A iterate-trace dumper. Activated by
// `IPOPT_ITER_DUMP_PATH`; otherwise no-op. See `iter_dump.rs`.
let mut dumper = IterDumper::from_env();
// Iter 0 record — captures the initialised iterate before any
// step. Mirrors upstream's "after InitializeIterates(), before
// the loop" emission point.
if let Some(d) = dumper.as_mut() {
d.write_record(&self.data, &self.cq);
}
// Advance the diagnostics iter counter so the first `iterate()`
// body reports as iter 0 (matches `data.iter_count`). Subsequent
// bumps live at the bottom of the loop alongside the iter_count
// bookkeeping.
if let Some(diag) = self.diagnostics.as_ref() {
diag.bump_iter();
// Iter-0 iterate row (issue #68). Same hook point as
// the binary IterDumper above; emits only when
// `--dump iterates:*` is configured.
emit_iterate_record(diag.as_ref(), &self.data, &self.cq);
}
// Iter 0 intermediate callback — upstream fires once after
// `InitializeIterates` before the loop body starts so users
// observe the initial point.
if !self.fire_intermediate() {
return SolverReturn::UserRequestedStop;
}
if self.fire_debug(crate::debug::Checkpoint::IterStart) == crate::debug::DebugAction::Stop {
return SolverReturn::UserRequestedStop;
}
// pounce#246: bound the initialization / restoration-entry window.
// Everything above — `mu_update.initialize`, `set_initial_iterates`
// (which for a bad warm start can grind in its least-square /
// feasibility setup), and the initial `update_hessian` — runs
// *before* the first `iterate()`, whose convergence check and
// post-`compute_search_direction` gate are the earliest deadline
// checks (#242/#244/#245). A solve handed a poor warm start could
// therefore spend the whole budget here and only consult the
// deadline once it reached the first outer-iteration /
// KKT-factorization boundary. Consult it now, before the loop, so a
// bad-start init stall returns promptly with the time-limit status
// (best-so-far being the initialised iterate) instead of running to
// a multiple of the budget. This also bounds the *restoration
// entry*: the nested restoration IPM shares this `Deadline` and runs
// the same `optimize_inner`, so a budget already crossed by the time
// the inner solve starts up terminates it here rather than after its
// own first iterate.
if let Some(ret) = self.deadline_status() {
return ret;
}
let result = loop {
match self.iterate() {
IterateOutcome::Terminate(ret) => break ret,
IterateOutcome::Continue => {
// Source the local counter from `data.iter_count`
// each pass so a pre-seeded counter (e.g. the inner
// restoration IPM at `outer.iter + 1`, matching
// upstream `IpRestoMinC_1Nrm.cpp:181`) and any
// restoration step that set
// `data.iter_count = inner.iter_count - 1`
// (mirroring `IpRestoMinC_1Nrm.cpp:Set_iter_count`)
// are honored — without this the local counter
// would advance from its pre-restoration value,
// ignoring the inner-IPM iterations.
let mut iter_count: Index = self.data.borrow().iter_count;
iter_count += 1;
// Do NOT short-circuit to `MaxiterExceeded` here: bump the
// counter and loop, letting the next `iterate()` run its
// convergence check (`OptimalityErrorConvergenceCheck`,
// which tests the component tolerances *before* its own
// `iter_count >= max_iter` gate at
// `conv_check/opt_error.rs`). Breaking before that call
// skipped the convergence test on the iterate produced by
// the final permitted step, so a solve converging on
// exactly the `max_iter`-th iterate reported
// `Maximum_Iterations_Exceeded` where upstream Ipopt —
// which runs `CheckConvergence` at the top of its loop,
// convergence-first — reports success. The check is
// guaranteed to terminate the loop: once `iter_count`
// reaches `max_iter`, `check_convergence_with_state`
// returns either `Converged`/`ConvergedToAcceptable` or
// `MaxIterExceeded`, never `Continue` (L1).
self.data.borrow_mut().iter_count = iter_count;
// Keep the diagnostics counter in lock-step with
// `data.iter_count` so KKT-dump gating reflects the
// about-to-execute iteration.
if let Some(diag) = self.diagnostics.as_ref() {
diag.bump_iter();
// Per-iter iterate row (issue #68). Mirrors
// the binary IterDumper hook below.
emit_iterate_record(diag.as_ref(), &self.data, &self.cq);
}
// Per-iteration record — emitted after the
// iter_count bump so the recorded `iter` field
// matches `IpData().iter_count()` at the moment of
// emission, identical to upstream's writer.
if let Some(d) = dumper.as_mut() {
d.write_record(&self.data, &self.cq);
}
// Per-iteration intermediate callback — fired with
// an `IntermediateContext` guard so downstream
// inspector entry points (the C API
// `GetIpoptCurrent*` family) see live state for the
// duration of the user callback.
if !self.fire_intermediate() {
break SolverReturn::UserRequestedStop;
}
if self.fire_debug(crate::debug::Checkpoint::IterStart)
== crate::debug::DebugAction::Stop
{
break SolverReturn::UserRequestedStop;
}
}
}
};
result
}
}
/// A termination certificate the masked-scale veto refused (gh #200), with
/// everything the fallback needs to undo the refusal verbatim.
///
/// One struct rather than a field per component. The fallback is only correct if
/// these all describe *the same iterate*, and parallel `Option`s make
/// "objective recorded, iterate missing" representable — which was reachable:
/// the iterate is cloned out of `data.curr` and can come back `None`, while the
/// objective and barrier parameter were written unconditionally. Capture is now
/// all-or-nothing, so the disagreement cannot be constructed.
#[derive(Clone)]
struct VetoSnapshot {
/// The refused iterate itself.
iterate: crate::iterates_vector::IteratesVector,
/// Iteration at which the refusal happened.
///
/// Needed to identify which refusal is the *baseline-equivalent* one. The
/// baseline stops at the first iterate where it would terminate, so when
/// both a strict and an acceptable-level refusal are on record it is the
/// chronologically earlier one that says what the baseline returned — not
/// the stricter one. The later refusal sits on the continued trajectory,
/// which the baseline never walked, so comparing against it compares
/// against a point that was never on offer.
iter: Index,
/// Scaled objective there, so the refused point can be compared against
/// whatever the continued run reached without re-evaluating it.
obj: Number,
/// Barrier parameter there.
///
/// `curr_mu` lives on `IpoptData` rather than in the `IteratesVector`, so
/// restoring the iterate does not rewind it, and `stats.final_mu` is read
/// after the restore — leaving the continued run's barrier parameter
/// reported next to the refused run's `x`. That pair feeds a warm-started
/// corrector's `mu_init` and reaches callers as `info["mu"]`, so it must
/// describe the point actually returned. (Not currently observable: `mu` has
/// bottomed out at its floor in every fallback case reachable so far, making
/// the two values coincide. Kept correct rather than left to depend on that.)
mu: Number,
/// Max-norm unscaled KKT error there, so the tiebreak can see what
/// `apply_kkt_fidelity_gate` will see. Recorded at refusal time because the
/// gate runs post-solve, long after this iterate is gone.
unscaled_kkt: Number,
/// Unscaled max-norm constraint violation there — the same quantity the
/// `acceptable_constr_viol_tol` gate is defined against
/// (`curr_unscaled_primal_infeasibility_max`, cf. gh #261). The
/// best-acceptable fallback ranks candidates by `(feasible_enough,
/// objective)` rather than objective alone, so a point outside a capped
/// feasibility band can never displace one inside it on objective grounds;
/// without this field the ranking has no feasibility term and, under a
/// user-widened `acceptable_constr_viol_tol`, will trade feasibility for
/// objective and hand back a verifiably infeasible point under a success
/// status (gh #267). Unused by the gh #200 masked-scale paths, which key on
/// objective only.
constr_viol: Number,
/// Objective scaling factor in force when `obj` was recorded.
///
/// `obj` is a *scaled* objective, so comparing it against the continued
/// run's is only meaningful under the same factor, sign included. Held so
/// that assumption is asserted rather than trusted: periodic or adaptive
/// rescaling is a natural thing to add for exactly the ill-scaled problems
/// this mechanism targets, and it would silently turn the comparison into
/// noise.
obj_scale: Number,
}
/// Internal result of one [`IpoptAlgorithm::iterate`] call. Mirrors the
/// upstream try/catch around `IpoptAlg::Optimize` — anything that's not
/// `Continue` carries the [`SolverReturn`] that the outer loop will
/// surface to `IpoptApplication`.
enum IterateOutcome {
Continue,
Terminate(SolverReturn),
}
/// Feasibility-aware ranking core for the best-acceptable fallback (gh #267).
///
/// `true` iff candidate `(a_obj, a_viol)` ranks **strictly** better than
/// `(b_obj, b_viol)` under the `(band_clamped_viol, objective)` key, where each
/// violation is clamped up to `band` before it is compared. Lexicographic: the
/// point with the smaller clamped violation wins outright; only when the clamped
/// violations tie does the lower objective decide. A non-finite objective ranks
/// worst (never wins, always loses to a finite one); a non-finite violation is
/// treated as infinitely infeasible.
///
/// The clamp is what makes this a **total order** rather than a two-class
/// partition, and it is the whole gh #280 fix. Clamping the violation *up* to
/// `band` collapses every point inside the feasibility band to the single value
/// `band`, so within the band those points tie on feasibility and objective
/// decides — the intended, gh #267-preserving behaviour. Outside the band the
/// clamp is the identity, so the *actual* violation decides and the
/// less-infeasible point always wins. The earlier `(feasible_enough, objective)`
/// key was a two-class partition: once **both** points sat outside the band it
/// fell through to a bare `a_obj < b_obj`, reading neither violation — the exact
/// pre-#267 objective-only rule, which lets a strictly-more-infeasible point win
/// on objective (gh #280). Under the clamped key a strictly-more-infeasible
/// point can never rank better, at any band.
///
/// Pure and total, so the fallback's "never worse off" guarantee is a theorem
/// this function's unit tests prove by cases — host-independent by construction,
/// unlike an end-to-end objective comparison across two live nonconvex solves
/// (the trap gh #267 caught). [`IpoptAlgorithm::ranks_better`] supplies `band`
/// as `min(acceptable_constr_viol_tol, FEASIBLE_ENOUGH_CAP)`; both the record
/// and the read side route through here, so they cannot disagree.
/// Append `value` to a fixed-capacity oldest-first window, dropping the oldest
/// sample once the window is full (gh #534).
fn push_sample(buf: &mut [Number; DECLINE_PROGRESS_SAMPLES], len: &mut usize, value: Number) {
if *len < DECLINE_PROGRESS_SAMPLES {
buf[*len] = value;
*len += 1;
} else {
buf.rotate_left(1);
buf[DECLINE_PROGRESS_SAMPLES - 1] = value;
}
}
/// Whether every consecutive pair in `samples` (oldest first) contracted by at
/// least `ratio` — the gh #534 progress test, as a pure function.
///
/// A sample that is not finite, or a predecessor that is not strictly positive,
/// fails the window: neither is evidence of progress, and a zero predecessor
/// makes the ratio meaningless. A `ratio` of `1` admits any non-increasing
/// window, and a large one admits every finite window — which is how
/// `resto_decline_progress_ratio` doubles as the "drop the progress
/// requirement" switch.
///
/// Pure and total for the same reason [`ranks_better_within_band`] is: the two
/// traces the issue records — `eigena2` quartering and `eigenb2` rising — decide
/// what this must do, and a unit test can hold it to them exactly.
fn window_is_contracting(samples: &[Number], ratio: Number) -> bool {
samples.windows(2).all(|w| {
let (prev, next) = (w[0], w[1]);
prev.is_finite() && prev > 0.0 && next.is_finite() && next <= ratio * prev
})
}
fn ranks_better_within_band(
a_obj: Number,
a_viol: Number,
b_obj: Number,
b_viol: Number,
band: Number,
) -> bool {
if !a_obj.is_finite() {
return false;
}
if !b_obj.is_finite() {
return true;
}
// Clamp each violation up to `band`: everything inside the feasibility band
// maps to the single value `band` (so objective decides there), while outside
// it the actual violation is kept (so the less-infeasible point strictly
// wins). A non-finite violation is infinitely infeasible. This is a total
// order — a strictly-more-infeasible point can never rank better (gh #280).
let clamped = |v: Number| {
if v.is_finite() {
v.max(band)
} else {
Number::INFINITY
}
};
let (a_key, b_key) = (clamped(a_viol), clamped(b_viol));
if a_key != b_key {
// The less-infeasible point wins outright, whatever the objectives.
return a_key < b_key;
}
// Same clamped feasibility (both inside the band, or an exact tie outside it):
// lower objective wins (the original within-band behaviour).
a_obj < b_obj
}
/// `||a - b||_2 / (1 + ||b||_2)`. Used by the restoration cycle
/// detector in [`IpoptAlgorithm::invoke_restoration`] to test whether
/// the outer iterate has moved between two consecutive restoration
/// entries.
fn relative_distance(a: &dyn Vector, b: &dyn Vector) -> Number {
if a.dim() == 0 {
return 0.0;
}
let mut diff = a.make_new_copy();
diff.axpy(-1.0, b);
diff.nrm2() / (1.0 + b.nrm2())
}
/// `out = curr + α_p · δ` for the primal/equality blocks and
/// `out = curr + α_d · δ` for the bound multipliers, returned as a
/// fresh frozen `IteratesVector`. Mirrors `scaled_step` in the line
/// search; duplicated here for the tiny-step branch which bypasses
/// the line-search driver.
fn scaled_step_unchecked(
curr: &crate::iterates_vector::IteratesVector,
delta: &crate::iterates_vector::IteratesVector,
alpha_primal: Number,
alpha_dual: Number,
) -> crate::iterates_vector::IteratesVector {
let mut out = curr.make_new_zeroed();
out.add_one_vector(1.0, curr, 0.0);
out.x.axpy(alpha_primal, &*delta.x);
out.s.axpy(alpha_primal, &*delta.s);
out.y_c.axpy(alpha_primal, &*delta.y_c);
out.y_d.axpy(alpha_primal, &*delta.y_d);
out.z_l.axpy(alpha_dual, &*delta.z_l);
out.z_u.axpy(alpha_dual, &*delta.z_u);
out.v_l.axpy(alpha_dual, &*delta.v_l);
out.v_u.axpy(alpha_dual, &*delta.v_u);
out.freeze()
}
/// Allocate a fresh `Rc<dyn Vector>` with `kappa_sigma_clamp`
/// applied component-wise against the supplied `slack`. Inputs are
/// borrowed; the original `z` is never mutated. Ports the per-vector
/// piece of `IpIpoptAlg.cpp:1080-1133`.
fn clamp_against_slack(
z: &dyn Vector,
slack: &dyn Vector,
mu: Number,
kappa_sigma: Number,
) -> Rc<dyn Vector> {
debug_assert_eq!(z.dim(), slack.dim());
let n = z.dim() as usize;
// Flatten both z and slack into contiguous slices so the
// elementwise clamp doesn't care whether the inputs are
// [`DenseVector`] (regular IPM path) or [`CompoundVector`]
// (resto IPM path). The result is reconstructed into a
// same-shape Vector via `Vector::make_new` + a flat-write
// helper so the caller sees a vector with the same blocking as
// its input.
let mut buf = vec![0.0_f64; n];
flat_read_into(z, &mut buf);
let s_vals = flat_read_owned(slack);
let _ = kappa_sigma_clamp(&mut buf, &s_vals, mu, kappa_sigma);
let mut out: Box<dyn Vector> = z.make_new();
flat_write_into(&mut *out, &buf);
Rc::from(out)
}
pub(crate) fn flat_read_into(v: &dyn Vector, dst: &mut [Number]) {
if let Some(dv) = v
.as_any()
.downcast_ref::<pounce_linalg::dense_vector::DenseVector>()
{
let vs = dv.expanded_values();
dst.copy_from_slice(&vs);
return;
}
if let Some(cv) = v.as_any().downcast_ref::<pounce_linalg::CompoundVector>() {
let mut off = 0usize;
for k in 0..cv.n_comps() {
let blk = cv.comp(k);
let dim = blk.dim() as usize;
let dblk = blk
.as_any()
.downcast_ref::<pounce_linalg::dense_vector::DenseVector>()
.expect("clamp_against_slack: CompoundVector blocks must be DenseVectors");
let vs = dblk.expanded_values();
dst[off..off + dim].copy_from_slice(&vs);
off += dim;
}
return;
}
panic!("clamp_against_slack: unsupported Vector kind");
}
pub(crate) fn flat_read_owned(v: &dyn Vector) -> Vec<Number> {
let mut out = vec![0.0; v.dim() as usize];
flat_read_into(v, &mut out);
out
}
pub(crate) fn flat_write_into(v: &mut dyn Vector, src: &[Number]) {
if let Some(dv) = v
.as_any_mut()
.downcast_mut::<pounce_linalg::dense_vector::DenseVector>()
{
dv.set_values(src);
return;
}
if let Some(cv) = v
.as_any_mut()
.downcast_mut::<pounce_linalg::CompoundVector>()
{
let mut off = 0usize;
for k in 0..cv.n_comps() {
let blk = cv.comp_mut(k);
let dim = blk.dim() as usize;
let dblk = blk
.as_any_mut()
.downcast_mut::<pounce_linalg::dense_vector::DenseVector>()
.expect("clamp_against_slack: CompoundVector blocks must be DenseVectors");
dblk.set_values(&src[off..off + dim]);
off += dim;
}
return;
}
panic!("clamp_against_slack: unsupported Vector kind");
}
/// Per-element kappa-sigma clamp — the elementwise arithmetic at the
/// heart of `IpIpoptAlg.cpp:correct_bound_multiplier` (lines
/// 1090-1133). For each index `i`:
///
/// ```text
/// slack_i = max(slack_i, tiny_double) // avoid /0
/// z_lo_i = mu / (kappa_sigma * slack_i)
/// z_hi_i = kappa_sigma * mu / slack_i
/// z_i ← clamp(z_i, z_lo_i, z_hi_i)
/// ```
///
/// Returns the maximum elementwise correction magnitude (matching
/// upstream's `Max(max_correction_up, max_correction_low)`).
///
/// `kappa_sigma < 1` short-circuits to the identity per upstream's
/// guard at line 1065.
pub fn kappa_sigma_clamp(
z: &mut [Number],
slack: &[Number],
mu: Number,
kappa_sigma: Number,
) -> Number {
debug_assert_eq!(z.len(), slack.len());
if kappa_sigma < 1.0 {
return 0.0;
}
let mut max_correction = 0.0_f64;
for (zi, &si) in z.iter_mut().zip(slack.iter()) {
let s_safe = si.max(Number::MIN_POSITIVE);
let lo = mu / (kappa_sigma * s_safe);
let hi = kappa_sigma * mu / s_safe;
let clamped = zi.clamp(lo, hi);
let delta = (clamped - *zi).abs();
if delta > max_correction {
max_correction = delta;
}
*zi = clamped;
}
max_correction
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn kappa_sigma_below_one_is_identity() {
let mut z = vec![1.0, 2.0, 3.0];
let slack = [1.0, 1.0, 1.0];
let m = kappa_sigma_clamp(&mut z, &slack, 1.0, 0.5);
assert_eq!(m, 0.0);
assert_eq!(z, [1.0, 2.0, 3.0]);
}
#[test]
fn within_band_is_unchanged() {
// mu=1, kappa=10, slack=1 → band [0.1, 10]. z=1 → unchanged.
let mut z = vec![1.0];
let slack = [1.0];
let m = kappa_sigma_clamp(&mut z, &slack, 1.0, 10.0);
assert_eq!(m, 0.0);
assert_eq!(z, [1.0]);
}
#[test]
fn above_upper_clamped_down() {
// mu=1, kappa=10, slack=1 → upper = 10. z=100 → 10.
let mut z = vec![100.0];
let slack = [1.0];
let m = kappa_sigma_clamp(&mut z, &slack, 1.0, 10.0);
assert!((m - 90.0).abs() < 1e-13);
assert_eq!(z, [10.0]);
}
#[test]
fn below_lower_clamped_up() {
// mu=1, kappa=10, slack=1 → lower = 0.1. z=0.001 → 0.1.
let mut z = vec![0.001];
let slack = [1.0];
let m = kappa_sigma_clamp(&mut z, &slack, 1.0, 10.0);
assert!((m - 0.099).abs() < 1e-13);
assert!((z[0] - 0.1).abs() < 1e-15);
}
#[test]
fn returns_max_over_components() {
let mut z = vec![100.0, 0.001];
let slack = [1.0, 1.0];
let m = kappa_sigma_clamp(&mut z, &slack, 1.0, 10.0);
assert!((m - 90.0).abs() < 1e-13);
assert_eq!(z[0], 10.0);
assert!((z[1] - 0.1).abs() < 1e-15);
}
#[test]
fn slack_clamped_to_min_positive_avoids_division_by_zero() {
let mut z = vec![1e100];
let slack = [0.0];
let _ = kappa_sigma_clamp(&mut z, &slack, 1.0, 10.0);
assert!(z[0].is_finite() || z[0] == 1e100);
}
/// The restoration slot is exercised structurally:
/// `IpoptAlgorithm::with_restoration` accepts a
/// `Box<dyn RestorationPhase>` and the trait's default
/// `perform_restoration` returns `Failed`. End-to-end coverage
/// (iterate() → line-search-Failed → restoration → recovered)
/// lands in the Phase 9 integration suite alongside the nested
/// IPM driver.
struct _DummyResto;
impl RestorationPhase for _DummyResto {}
// --------------------------------------------------------------
// Best-acceptable fallback ranking (gh #267).
//
// These prove the "never worse off" guarantee host-independently, by
// cases, on the pure ranking core — the property the earlier end-to-end
// `hair_trigger_*` objective comparison could only *approximate* on one
// host's basin luck (gh #267's secondary finding). `band` here stands in
// for the resolved `min(acceptable_constr_viol_tol, FEASIBLE_ENOUGH_CAP)`.
// --------------------------------------------------------------
#[test]
fn ranks_better_is_a_strict_order_within_a_feasibility_class() {
let band = 1e-2;
// Both feasible: lower objective wins, strictly.
assert!(ranks_better_within_band(-2.0, 1e-4, -1.0, 1e-4, band));
assert!(!ranks_better_within_band(-1.0, 1e-4, -2.0, 1e-4, band));
// Ties are not "strictly better" in either direction — so an equal
// returned point is never displaced, matching the read side's
// keep-current-on-tie contract.
assert!(!ranks_better_within_band(-1.0, 1e-4, -1.0, 5e-3, band));
assert!(!ranks_better_within_band(-1.0, 5e-3, -1.0, 1e-4, band));
// Both infeasible: the less-infeasible point wins. Here it also has the
// lower objective, so this held under the old objective-only fall-through
// too — `ranks_better_puts_feasibility_first_among_two_infeasibles` is the
// case that separates the two rules (gh #280).
assert!(ranks_better_within_band(-2.0, 5.0, -1.0, 9.0, band));
}
#[test]
fn ranks_better_puts_feasibility_first_among_two_infeasibles() {
// The gh #280 hole: once BOTH points sit outside the (capped) band the
// old `(feasible_enough, objective)` partition read a_ok == b_ok == false
// and fell through to `a_obj < b_obj` — objective alone, the exact
// pre-#267 rule — so a strictly-MORE-infeasible point could win by having
// a better objective. This is the deb7 swap the fallback made: incumbent
// at viol 5.292e-1, recorded point at viol 9.951e-1 with a 36%-better
// objective. The less-infeasible point must win regardless of objective.
let band = 1e-2;
// Less-infeasible incumbent, WORSE objective — must still win.
assert!(ranks_better_within_band(
89.0, 5.292e-1, 56.9, 9.951e-1, band
));
// The more-infeasible, better-objective point must NOT win — the swap
// gh #280 forbids.
assert!(!ranks_better_within_band(
56.9, 9.951e-1, 89.0, 5.292e-1, band
));
// A strictly-more-infeasible point never replaces the incumbent even with
// an arbitrarily better objective.
assert!(!ranks_better_within_band(-1e12, 9.0, 0.0, 5.0, band));
assert!(ranks_better_within_band(0.0, 5.0, -1e12, 9.0, band));
}
#[test]
fn ranks_better_puts_feasibility_first_regardless_of_objective() {
let band = 1e-2;
// The gh #267 case in miniature: a feasible point outranks an
// arbitrarily-lower-objective infeasible one, and vice-versa.
assert!(ranks_better_within_band(0.0, 1e-4, -1e9, 9.94, band));
assert!(!ranks_better_within_band(-1e9, 9.94, 0.0, 1e-4, band));
// Exactly at the band is still feasible_enough; just past it is not.
assert!(ranks_better_within_band(
1.0,
band,
-1.0,
band * 1.000_001,
band
));
}
#[test]
fn ranks_better_never_lets_a_widened_band_matter_past_the_cap() {
// The band the method feeds is capped at FEASIBLE_ENOUGH_CAP, so a
// point beyond the cap is never feasible_enough however loose the
// user's `acceptable_constr_viol_tol`. Model that by passing the capped
// band: the near-optimal-but-mildly-infeasible endpoint (viol 1.13e-4,
// within the cap) must beat the grossly-infeasible lower-objective
// point (viol 9.94, past it) — the exact swap the fix forbids.
let band = IpoptAlgorithm::FEASIBLE_ENOUGH_CAP;
assert!(ranks_better_within_band(
-2303.99, 1.13e-4, -2307.32, 9.94, band
));
assert!(!ranks_better_within_band(
-2307.32, 9.94, -2303.99, 1.13e-4, band
));
}
#[test]
fn ranks_better_ranks_a_nonfinite_objective_worst() {
let band = 1e-2;
for bad in [f64::NAN, f64::INFINITY, f64::NEG_INFINITY] {
// A non-finite objective never ranks better than a finite one...
assert!(!ranks_better_within_band(bad, 0.0, 0.0, 9.9, band));
// ...and always loses to one, even on worse feasibility — so a
// finite recorded point is restored over a NaN-objective return,
// preserving the pre-fix `!(curr <= best)` NaN behaviour.
assert!(ranks_better_within_band(0.0, 9.9, bad, 0.0, band));
}
}
#[test]
fn ranks_better_treats_a_nonfinite_violation_as_infeasible() {
let band = 1e-2;
// A NaN violation is never feasible_enough, so a genuinely feasible
// point outranks it regardless of objective.
assert!(ranks_better_within_band(0.0, 0.0, -100.0, f64::NAN, band));
assert!(!ranks_better_within_band(-100.0, f64::NAN, 0.0, 0.0, band));
}
/// gh #534, the case the guard was stopping: `eigena2`'s dual infeasibility
/// quarters on unit steps for four straight iterations, three short of a
/// strict certificate. Quoted from the issue's own iteration table.
#[test]
fn eigena2_endgame_reads_as_contracting() {
let eigena2 = [1.19e-05, 2.96e-06, 7.38e-07, 1.84e-07];
assert!(window_is_contracting(
&eigena2,
DEFAULT_DECLINE_PROGRESS_RATIO
));
}
/// gh #534, the case the guard was right about: `eigenb2`'s tail *rises*
/// on heavily backtracked steps. The issue calls it a plausible genuine
/// stall, so the progress test must refuse it and leave the guard alone.
#[test]
fn eigenb2_stall_does_not_read_as_contracting() {
let eigenb2 = [1.88e-07, 2.69e-07, 2.89e-07, 2.93e-07];
assert!(!window_is_contracting(
&eigenb2,
DEFAULT_DECLINE_PROGRESS_RATIO
));
}
/// gh #534: `csfi2`'s window, measured on this build at the guard. Three
/// healthy contractions and then a flat step — the solve has stopped
/// moving, so the deferral must not fire however good the earlier ratios
/// look. This is the shape every live guard firing reachable from the
/// in-repo corpus has, which is why the whole window is tested and not
/// just its first ratios.
#[test]
fn csfi2_flat_final_step_does_not_read_as_contracting() {
let csfi2 = [3.267e0, 1.845e-6, 8.468e-8, 8.524e-8];
assert!(!window_is_contracting(
&csfi2,
DEFAULT_DECLINE_PROGRESS_RATIO
));
// ... and it is the *last* step that decides: drop it and the same
// trace passes, which is exactly the distinction the test exists for.
assert!(window_is_contracting(
&csfi2[..3],
DEFAULT_DECLINE_PROGRESS_RATIO
));
}
/// gh #534: a large ratio drops the progress requirement, so the decline is
/// deferred on any window. That is the "bypass the guard and see how far the
/// solve gets" switch the issue asks for. A ratio of exactly `1` is the
/// weaker "no backsliding" reading and still refuses `csfi2`, whose last
/// step rises.
#[test]
fn a_large_ratio_accepts_a_stalled_window() {
let csfi2 = [3.267e0, 1.845e-6, 8.468e-8, 8.524e-8];
assert!(!window_is_contracting(&csfi2, 1.0));
assert!(window_is_contracting(&[1e-8, 1e-8, 1e-8, 1e-8], 1.0));
assert!(window_is_contracting(&csfi2, 1e20));
// Still not a licence to read garbage as progress.
assert!(!window_is_contracting(
&[1.0, Number::NAN, 1e-9, 1e-12],
1e20
));
}
/// gh #534 edge cases: the ratio must never be evaluated against a
/// non-positive or non-finite predecessor.
#[test]
fn degenerate_windows_never_read_as_contracting() {
let r = DEFAULT_DECLINE_PROGRESS_RATIO;
// A zero predecessor makes the ratio meaningless (0 <= 0.5*0 would
// otherwise read as "contracting" forever).
assert!(!window_is_contracting(&[0.0, 0.0, 0.0, 0.0], r));
assert!(!window_is_contracting(&[1e-9, 0.0, 0.0, 0.0], r));
assert!(!window_is_contracting(
&[Number::INFINITY, 1e-3, 1e-6, 1e-9],
r
));
assert!(!window_is_contracting(&[1e-3, 1e-6, 1e-9, Number::NAN], r));
// A genuine run down to exactly zero is progress, not a degenerate
// window — the predecessor is positive at every step.
assert!(window_is_contracting(&[1e-3, 1e-6, 1e-9, 0.0], r));
}
/// gh #534: the window slides one sample per outer iteration and holds the
/// most recent [`DECLINE_PROGRESS_SAMPLES`]. A short history is never a full
/// window, which is what stops the first restoration entry of a solve from
/// being deferred on no evidence at all — `nlp_err_contracting` requires
/// `len == DECLINE_PROGRESS_SAMPLES` before it consults the samples.
#[test]
fn progress_window_slides_oldest_out() {
let mut buf = [Number::NAN; DECLINE_PROGRESS_SAMPLES];
let mut len = 0usize;
for e in [1e-1, 1e-2, 1e-3] {
push_sample(&mut buf, &mut len, e);
}
assert_eq!(len, 3);
push_sample(&mut buf, &mut len, 1e-4);
assert_eq!(len, DECLINE_PROGRESS_SAMPLES);
assert_eq!(buf, [1e-1, 1e-2, 1e-3, 1e-4]);
assert!(window_is_contracting(&buf, DEFAULT_DECLINE_PROGRESS_RATIO));
// One flat iteration slides the oldest sample out and withdraws the
// verdict.
push_sample(&mut buf, &mut len, 1e-4);
assert_eq!(len, DECLINE_PROGRESS_SAMPLES);
assert_eq!(buf, [1e-2, 1e-3, 1e-4, 1e-4]);
assert!(!window_is_contracting(&buf, DEFAULT_DECLINE_PROGRESS_RATIO));
}
/// gh #505: no route may conclude `LocalInfeasibility` on its own.
///
/// Three routes reach that verdict, and two of them independently shipped
/// the same defect — building the terminate outcome directly, so the
/// acceptable-point stash was never consulted and a good point the solve
/// already had in hand was discarded. They were found one at a time,
/// because nothing tied them together.
///
/// The route a solve takes is an internal detail; the user sees one status
/// either way. So what that status means is decided in one place — every
/// route goes through [`IpoptAlgorithm::terminate_local_infeasibility`],
/// or, for the cycle exits whose fallback is chosen between two statuses
/// at the call site, through `terminate_acceptable_or`. Both consult the
/// stash.
///
/// **This is a tripwire, not a proof.** It is a substring scan of this
/// file's source for the bare `IterateOutcome::Terminate(SolverReturn::
/// LocalInfeasibility)` construction. A rustfmt line break through that
/// expression, a `let` binding for the status, or a construction in
/// another module all evade it — `application.rs` names the same variant
/// on the SQP and ℓ₁ elastic paths and is deliberately out of scope. What
/// it does buy is that the *obvious* way to add a fourth bare exit here
/// fails loudly and points at the helper, which is the mistake that was
/// actually made twice.
///
/// The needle is assembled at runtime so this test's own source cannot
/// satisfy the pattern it is checking for; an earlier version counted its
/// own lines and failed against clean code.
#[test]
fn no_route_concludes_local_infeasibility_alone() {
let needle = format!(
"IterateOutcome::Terminate(SolverReturn::{})",
"LocalInfeasibility"
);
let offenders: Vec<usize> = include_str!("ipopt_alg.rs")
.lines()
.enumerate()
.filter(|(_, l)| {
let t = l.trim_start();
!t.starts_with("//") && !t.starts_with("///")
})
.filter(|(_, l)| l.contains(&needle))
.map(|(i, _)| i + 1)
.collect();
assert!(
offenders.is_empty(),
"line(s) {offenders:?} build the local-infeasibility verdict directly. \
Call `terminate_local_infeasibility()` instead — it consults the \
acceptable-point stash first, so a solve that already passed through an \
acceptable iterate returns that point rather than a hard failure. Two \
routes shipped this bug before the helper existed (gh #505)."
);
}
}