Skip to content

Commit 6e3229b

Browse files
bodonoclaude
andcommitted
docs: mark QDLDL as the macOS AUTO default
Companion to bodono/scs-python#210, which switches the macOS branch of _resolve_auto to prefer the bundled QDLDL over Apple Accelerate. Accelerate remains available via LinearSolver.ACCELERATE. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 32db99c commit 6e3229b

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

docs/src/api/python.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ SCS uses. It accepts a :code:`scs.LinearSolver` enum value.
4949
The default is :code:`AUTO`, which selects the best available solver for
5050
the platform:
5151

52-
- **macOS**: Apple Accelerate if available, otherwise QDLDL
52+
- **macOS**: QDLDL (Apple Accelerate is available via :code:`LinearSolver.ACCELERATE`)
5353
- **Linux / Windows**: MKL Pardiso if available, otherwise QDLDL
5454

5555
.. list-table::

docs/src/install/python.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,9 @@ Apple Accelerate (macOS)
3939
On macOS the Apple Accelerate backend is built and included automatically —
4040
no extra install flags are needed. It uses the Accelerate framework's sparse
4141
LDL\ :sup:`T` solver, which is optimized for Apple hardware including Apple
42-
Silicon. When using the default :code:`linear_solver=scs.LinearSolver.AUTO`,
43-
Accelerate is selected automatically on macOS.
42+
Silicon. The default :code:`linear_solver=scs.LinearSolver.AUTO` selects the
43+
bundled QDLDL on macOS; opt in to Accelerate explicitly with
44+
:code:`linear_solver=scs.LinearSolver.ACCELERATE`.
4445

4546
MKL
4647
"""

docs/src/linear_solver/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ To build with CMake::
110110
cmake -DUSE_APPLE_ACCELERATE=ON ..
111111

112112
In Python, the Accelerate backend is included automatically on macOS
113-
(``pip install scs`` is sufficient). It is the default when using
114-
``linear_solver=scs.LinearSolver.AUTO`` on macOS. It can also be selected
115-
explicitly::
113+
(``pip install scs`` is sufficient). On macOS,
114+
``linear_solver=scs.LinearSolver.AUTO`` selects the bundled QDLDL; select
115+
Accelerate explicitly with::
116116

117117
solver = scs.SCS(data, cone, linear_solver=scs.LinearSolver.ACCELERATE)
118118

0 commit comments

Comments
 (0)