cvxpy_ptr_solver
CVXPy-based convex subproblem solver for the penalized trust-region (PTR) SCP algorithm.
This module provides the default backend for :class:PTRSolver, using CVXPy's
modeling language and dispatching to any of its supported conic solvers
(QOCO, CLARABEL, ...). Optional code generation via cvxpygen is available
for improved per-iteration performance.
Companion backend: :class:openscvx.solvers.qpax_ptr_solver.QPAXPTRSolver,
which targets pure-JAX execution.
CVXPyPTRSolver
¶
Bases: PTRSolver
CVXPy-backed implementation of the PTR convex subproblem.
Builds the subproblem as a DCP program through CVXPy and dispatches it to one of CVXPy's supported conic solvers (QOCO by default, CLARABEL, etc.). Optional code generation via cvxpygen is available for improved per-iteration performance.
The solver builds the problem structure once during initialize(), using
CVXPy Parameters for values that change each iteration. The solve()
method then solves and returns a structured PTRSolveResult. The
JAX-pure entry point :meth:iteration_callback wraps that same solve in
:func:jax.pure_callback (vmap_method="sequential" — CVXPy cannot
batch) so the backend composes with jax.jit / jax.vmap alongside
the JAX-native QPAX and Moreau backends.
The cost and constraint formulations are defined in the cost() and
constraints() methods, which can be overridden in subclasses to
customize the convex subproblem. For example::
class MyPTRSolver(CVXPyPTRSolver):
def cost(self, settings, lowered):
c = super().cost(settings, lowered)
c += my_extra_term(self._ocp_vars)
return c
Example
Using CVXPyPTRSolver with the SCP framework::
solver = CVXPyPTRSolver()
solver.create_variables(N, x_unified, u_unified, jax_constraints)
solver.initialize(lowered, settings)
# Each iteration (parameter updates done by algorithm):
result = solver.solve()
x_sol = result.x # Unscaled state trajectory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cvx_solver
|
str
|
CVXPY solver backend name. Defaults to |
'QOCO'
|
solver_args
|
Optional[dict]
|
Keyword arguments forwarded to the CVXPY solver
(e.g. tolerances). Defaults to
|
None
|
cvxpygen
|
bool
|
Enable CVXPy code generation for faster solves.
Defaults to Warning Enabling cvxpygen currently disables sparse parameter declarations. cvxpygen does not yet support the N-D sparsity indices used by OpenSCvx's tiled parameters, so all parameters are created as dense when code generation is active. This may increase the generated solver's memory footprint and compile time but does not affect solution correctness. |
False
|
cvxpygen_override
|
bool
|
Overwrite existing generated solver directory
without prompting. Defaults to |
False
|
Attributes:
| Name | Type | Description |
|---|---|---|
ocp_vars |
CVXPyVariables
|
The CVXPy variables and parameters (available after create_variables()) |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
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 | |
exportable: bool
property
¶
CVXPy is not jax.export-serializable — see :attr:PTRSolver.exportable.
The JAX-pure :meth:iteration_callback wraps the host CVXPy solve in a
:func:jax.pure_callback, and jax.export cannot serialize host
callbacks. solve_batched(save_compiled=True) therefore refuses this
backend with a teaching error pointing at QPAX / Moreau rather than
silently falling back to an uncached in-process solve.
ocp_vars: CVXPyVariables
property
¶
The CVXPy variables and parameters.
Returns:
| Type | Description |
|---|---|
CVXPyVariables
|
The CVXPyVariables dataclass, or None if create_variables() not called. |
__init__(cvx_solver: str = 'QOCO', solver_args: Optional[dict] = None, cvxpygen: bool = False, cvxpygen_override: bool = False)
¶
Initialize CVXPyPTRSolver with solver configuration.
Call create_variables() then initialize() to build the problem structure.
Source code in openscvx/solvers/cvxpy_ptr_solver.py
citation() -> List[str]
¶
Return BibTeX citations for CVXPy.
Returns:
| Type | Description |
|---|---|
List[str]
|
List containing BibTeX entries for CVXPy and DCCP papers. |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
constraints(settings: Config, lowered: LoweredProblem) -> list
¶
Build the constraint list for the convex subproblem.
Constructs all PTR constraints including:
- Linearized nodal constraints (from JAX-lowered nonconvex constraints)
- Linearized cross-node constraints
- Convex constraints (already lowered to CVXPy)
- Boundary conditions (fixed initial/terminal states)
- Uniform time grid constraints
- State and control deviation definitions
- Linearized dynamics
- State and control box constraints
- CTCS constraints
Override this method in subclasses to customize the constraint
formulation. Use super().constraints(settings, lowered) to include
the standard PTR constraints and extend them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
settings
|
Config
|
Configuration object with solver settings |
required |
lowered
|
LoweredProblem
|
Lowered problem containing lowered constraints |
required |
Returns:
| Type | Description |
|---|---|
list
|
List of CVXPy constraints. |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
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 | |
cost(settings: Config, lowered: LoweredProblem) -> cp.Expression
¶
Build the cost expression for the convex subproblem.
Constructs the PTR objective function including:
- Boundary condition costs (Minimize/Maximize state components)
- Trust region penalty (deviation from linearization point)
- Virtual control penalty (dynamics defect relaxation)
- Virtual buffer penalty (nonconvex constraint violation relaxation)
Override this method in subclasses to customize the cost formulation.
Use super().cost(settings, lowered) to include the standard PTR
cost terms and add to them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
settings
|
Config
|
Configuration object with solver settings |
required |
lowered
|
LoweredProblem
|
Lowered problem containing constraint structure |
required |
Returns:
| Type | Description |
|---|---|
Expression
|
CVXPy expression representing the total cost to minimize. |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
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 | |
create_variables(N: int, x_unified: UnifiedState, u_unified: UnifiedControl, jax_constraints: LoweredJaxConstraints, dynamics_sparsity: Optional[tuple] = None, constraint_sparsity: Optional[list] = None) -> None
¶
Create CVXPy optimization variables.
Creates all CVXPy Variable and Parameter objects needed for the optimal control problem. This includes state/control variables, dynamics parameters, constraint linearization parameters, and scaling matrices.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
N
|
int
|
Number of discretization nodes |
required |
x_unified
|
UnifiedState
|
Unified state interface with dimensions and scaling bounds |
required |
u_unified
|
UnifiedControl
|
Unified control interface with dimensions and scaling bounds |
required |
jax_constraints
|
LoweredJaxConstraints
|
Lowered JAX constraints (for sizing linearization params) |
required |
dynamics_sparsity
|
Optional[tuple]
|
Optional tuple |
None
|
constraint_sparsity
|
Optional[list]
|
Optional list of |
None
|
Source code in openscvx/solvers/cvxpy_ptr_solver.py
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 | |
dynamics_biases(A_d: np.ndarray, B_d: np.ndarray, C_d: np.ndarray, x_bar: np.ndarray, u_bar: np.ndarray, x_prop: np.ndarray, x_prop_plus: np.ndarray | None = None, E_d: np.ndarray | None = None) -> None
¶
Update affine dynamics bias parameters for the current linearization.
Computes and stores
dyn_bias: per-step affine bias in linearized dynamicsx0_imp_bias: initial-node impulsive affine bias
Source code in openscvx/solvers/cvxpy_ptr_solver.py
get_stats() -> dict
¶
Get solver statistics for diagnostics and printing.
Returns:
| Type | Description |
|---|---|
dict
|
Dict containing:
- |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
initialize(lowered: LoweredProblem, settings: Config) -> None
¶
Build the CVXPy optimal control problem.
Constructs the complete optimization problem by calling cost() and
constraints() to build the objective and constraint formulations,
then assembles them into a CVXPy Problem.
If cvxpygen is enabled, generates compiled solver code for improved performance.
Note
create_variables() must be called before this method.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
lowered
|
LoweredProblem
|
Lowered problem containing:
- |
required |
settings
|
Config
|
Problem configuration (node count, scaling, etc.) |
required |
Raises:
| Type | Description |
|---|---|
RuntimeError
|
If create_variables() has not been called. |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
iteration_callback() -> Callable[..., SubproblemSolution]
¶
JAX-pure (state, SubproblemData) -> SubproblemSolution.
Wraps the existing NumPy solve() path in :func:jax.pure_callback
with vmap_method="sequential". CVXPy can't trace — it builds a DCP
graph and reaches into a backend solver through Python attribute
mutation — so the only JAX-friendly surface it can present is a host
callback. Under :func:jax.jit the callback fires once per call; under
:func:jax.vmap it fires B times serially (CVXPy can't ingest a
batched parameter set).
The closure unstacks :class:SubproblemData back to the per-constraint
dict layout :meth:update_constraint_linearizations expects, runs the
four update_* methods + :meth:solve, and packs the result into a
:class:SubproblemSolution whose nu_vb is collapsed to a stacked
(N, n_nodal) array (the list-of-arrays form on
:attr:PTRSolveResult.nu_vb is preserved for the NumPy path).
status_code is mapped via :func:status_str_to_code; CVXPy's
"optimal_inaccurate" / "solver_error" / ... labels collapse to
:attr:StatusCode.UNKNOWN — the SCP trust-region check is the
authoritative convergence gate.
The returned callable takes (state, data): state is the
:class:AlgorithmState pytree, accepted for cross-backend signature
uniformity but unused (CVXPy exposes no warm-start through
update_*); data is the :class:SubproblemData pytree carrying
the per-iteration linearization arrays, penalty weights, and boundary
conditions.
Source code in openscvx/solvers/cvxpy_ptr_solver.py
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 | |
lower_convex_constraints(constraints, parameters=None)
¶
Lower user .convex() constraints into CVXPy constraint objects.
Delegates to :func:openscvx.symbolic.lower.lower_cvxpy_constraints,
feeding it the unscaled-state and unscaled-control CVXPy expressions
built by :meth:create_variables.
Source code in openscvx/solvers/cvxpy_ptr_solver.py
proximal_cost_terms(lam_prox: np.ndarray, x_bar: np.ndarray, u_bar: np.ndarray) -> tuple[np.ndarray, np.ndarray]
¶
Compute linear and constant proximal cost terms.
Source code in openscvx/solvers/cvxpy_ptr_solver.py
solve() -> PTRSolveResult
¶
Solve the convex subproblem and return structured results.
Call update_dynamics_linearization(), update_constraint_linearizations(),
and update_penalties() before calling this method.
Returns:
| Type | Description |
|---|---|
PTRSolveResult
|
PTRSolveResult containing unscaled trajectories, slack variables, |
PTRSolveResult
|
cost, and solver status. |
Raises:
| Type | Description |
|---|---|
RuntimeError
|
If initialize() has not been called. |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
update_boundary_conditions(x_init: np.ndarray = None, x_term: np.ndarray = None) -> None
¶
Update boundary condition parameters.
Sets initial and/or terminal state constraints. Only sets parameters that exist in the problem (some problems may not have both).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_init
|
ndarray
|
Initial state vector, shape (n_states,). Optional. |
None
|
x_term
|
ndarray
|
Terminal state vector, shape (n_states,). Optional. |
None
|
Source code in openscvx/solvers/cvxpy_ptr_solver.py
update_constraint_linearizations(nodal: List[dict] = None, cross_node: List[dict] = None) -> None
¶
Update linearized constraint values and gradients.
Sets constraint function values and gradients at the current linearization point for both nodal and cross-node constraints.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
nodal
|
List[dict]
|
List of dicts for nodal constraints, each containing:
- |
None
|
cross_node
|
List[dict]
|
List of dicts for cross-node constraints, each containing:
- |
None
|
Source code in openscvx/solvers/cvxpy_ptr_solver.py
update_dynamics_linearization(x_bar: np.ndarray, u_bar: np.ndarray, A_d: np.ndarray, B_d: np.ndarray, C_d: np.ndarray, x_prop: np.ndarray, x_prop_plus: np.ndarray | None = None, D_d: np.ndarray | None = None, E_d: np.ndarray | None = None) -> None
¶
Update dynamics linearization point and matrices.
Sets the current linearization point (previous iterate) and the discretized dynamics matrices for the convex subproblem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x_bar
|
ndarray
|
Previous state trajectory, shape (N, n_states) |
required |
u_bar
|
ndarray
|
Previous control trajectory, shape (N, n_controls) |
required |
A_d
|
ndarray
|
Discretized state Jacobian, shape (N-1, n_states, n_states) |
required |
B_d
|
ndarray
|
Discretized control Jacobian (current node), shape (N-1, n_states, n_controls) |
required |
C_d
|
ndarray
|
Discretized control Jacobian (next node), shape (N-1, n_states, n_controls) |
required |
x_prop
|
ndarray
|
Propagated state from continuous dynamics, shape (N-1, n_states) |
required |
x_prop_plus
|
ndarray | None
|
Optional impulsive/discrete propagated state, shape (N, n_states) |
None
|
D_d
|
ndarray | None
|
Optional impulsive/discrete Jacobian wrt state, shape (N, n_states, n_states) |
None
|
E_d
|
ndarray | None
|
Optional impulsive/discrete Jacobian wrt control, shape (N, n_states, n_controls) |
None
|
Source code in openscvx/solvers/cvxpy_ptr_solver.py
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 | |
update_penalties(lam_prox: np.ndarray, lam_cost: Union[float, np.ndarray], lam_vc: np.ndarray, lam_vb_nodal: np.ndarray, lam_vb_cross: np.ndarray) -> None
¶
Update SCP penalty weights.
Sets the penalty weights that balance competing objectives in the PTR convex subproblem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
lam_prox
|
ndarray
|
Trust region weights, shape |
required |
lam_cost
|
Union[float, ndarray]
|
Cost function weight. Scalar or array of shape
|
required |
lam_vc
|
ndarray
|
Virtual control penalty weights, shape (N-1, n_states) |
required |
lam_vb_nodal
|
ndarray
|
Virtual buffer penalty weights for nodal constraints,
shape |
required |
lam_vb_cross
|
ndarray
|
Virtual buffer penalty weights for cross-node
constraints, shape |
required |
Source code in openscvx/solvers/cvxpy_ptr_solver.py
update_proximal_terms() -> None
¶
Update proximal expansion parameters from current references and weights.