Repository navigation
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds$AX + XB = C$ for $X$ . Addresses #3396 (motivated by this Discourse thread).
sylvester_solver(A, B, C), which solves the Sylvester equationAis n x n,Bis m x m andCis n x m. Each argument can be real or complex, in any combination. The result is always a complex n x m matrix.Primitive ($A = USU^H$ and $B = VTV^H$ ($SY + YT = U^H C V$ with upper-triangular $S$ and $T$ , which is solved one column at a time by triangular back substitution. Then $X = UYV^H$ . The cost is $O(n^3 + m^3 + nm(n + m))$ . The scalar type is templated, so forward mode (
stan/math/prim/fun/sylvester_solver.hpp). Bartels–Stewart with complex Schur decompositionsEigen::ComplexSchur). This reduces the problem tofvar) goes through this implementation.Reverse mode ($G$ the adjoint of $X$ (adjoint of $\mathrm{Re},X$ plus $i$ times the adjoint of $\mathrm{Im},X$ ), the reverse pass solves the adjoint equation $A^H Z + Z B^H = G$ and accumulates
stan/math/rev/fun/sylvester_solver.hpp). The forward pass runs the same algorithm on values and keeps the Schur factors in the arena. WithThe derivation is in the issue thread (#3396). The adjoint equation reuses the forward-pass Schur factors: it becomes$S^H W + W T^H = U^H G V$ , solved column by column from last to first, so no second decomposition is needed. Complex inputs receive the real and imaginary parts of their gradient, and real inputs receive the real part. Inputs can be
Matrix<var>,var_value<Matrix>orMatrix<std::complex<var>>, mixed freely withdoubleinputs. The returnedMatrix<std::complex<var>>is copied out of the arena, so writing into the result does not change what the reverse pass reads.Lyapunov. The continuous Lyapunov equation$AX + XA^H = Q$ is the special case
sylvester_solver(A, A.adjoint(), Q). This PR does not add a separate function for it. I can add alyapunov_solverwrapper here or in a follow-up if that is preferred.Questions for reviewers
AandB. This is not checked. If it fails, the result containsinforNaNand no exception is thrown. Should the function check the diagonals of the shifted triangular systems and throw?sylvester_solver, or something closer to SciPy'ssolve_sylvester?This adds the function to the Math library only. Exposing it in the Stan language needs a separate stanc3 PR.
Tests
test/unit/math/prim/fun/sylvester_test.cppAandBagainst the closed formAand positive definiteQ: the solution is symmetric and positive definite.AorB, andCwith the wrong number of rows or columns, throwstd::invalid_argument.test/unit/math/mix/fun/sylvester_test.cppexpect_adwith real inputs (Ahas a complex eigenvalue pair), complex inputs, and mixed real and complex inputs. This checks values and derivatives in reverse, forward and mixed mode against finite differences.B = A^T, so the autodiff variables ofAenter twice.var_value<Matrix>inputs give the same value and adjoints asMatrix<var>inputs. (expect_ad_matvardoes not apply because the result hasstd::complex<var>scalars.)Side Effects
None for existing code. The PR adds two new headers and includes them in
stan/math/prim/fun.hppandstan/math/rev/fun.hpp.Release notes
Added
sylvester_solver(A, B, C), which solves the Sylvester equation AX + XB = C for real or complex matrices, with forward- and reverse-mode autodiff. The continuous Lyapunov equation AX + XA^H = Q can be solved assylvester_solver(A, A^H, Q).Checklist
Copyright holder: Simons Foundation
The copyright holder is typically you or your assignee, such as a university or company. By submitting this pull request, the copyright holder is agreeing to the license the submitted work under the following licenses:
- Code: BSD 3-clause (https://opensource.org/licenses/BSD-3-Clause)
- Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)
the basic tests are passing
./runTests.py test/unit)make test-headers)make test-math-dependencies)make doxygen)make cpplint)the code is written in idiomatic C++ and changes are documented in the doxygen
the new changes are tested