Skip to content

rename sylvester_solver to solve_sylvester - #3499

Merged
WardBrian merged 1 commit into
stan-dev:developfrom
stekien:rename/sylvester
Nov 4, 2026
Merged

WardBrian merged 1 commit into
stan-dev:developfrom
stekien:rename/sylvester

Conversation

@stekien

@stekien stekien commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Renames sylvester_solver to solve_sylvester, following the naming question raised in #3467. The new name matches SciPy's scipy.linalg.solve_sylvester and the solve_* style used elsewhere in Stan Math.

This is a rename only, with no change in behavior:

  • stan/math/{prim,fwd,rev}/fun/sylvester_solver.hpp → solve_sylvester.hpp, with updated include guards and includes in fun.hpp
  • The function name and the name used in error messages from check_square / check_size_match
  • test/unit/math/{prim,mix}/fun/sylvester_test.cpp → solve_sylvester_test.cpp, with renamed test cases and test namespace

No references to sylvester_solver remain in the repository.

Tests

No new tests. The existing prim and mix tests were renamed and now call solve_sylvester.

Side Effects

None. sylvester_solver was merged in #3467 but has not been in a release yet, so no deprecation path is needed.

Release notes

Renamed sylvester_solver to solve_sylvester. Since the function hasn't been released, the release note from #3467 should use the new name: "Added solve_sylvester(A, B, C), which solves the Sylvester equation AX + XB = C …"

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

    • unit tests pass (to run, use: ./runTests.py test/unit)
    • header checks pass, (make test-headers)
    • dependencies checks pass, (make test-math-dependencies)
    • docs build, (make doxygen)
    • code passes the built in C++ standards checks (make cpplint)
  • the code is written in idiomatic C++ and changes are documented in the doxygen

  • the new changes are tested

@WardBrian WardBrian left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@WardBrian
WardBrian enabled auto-merge November 3, 2026 17:47
@stekien stekien mentioned this pull request Nov 3, 2026
4 tasks done
@stan-buildbot

Copy link
Copy Markdown
Contributor
Name Old Result New Result Ratio Performance change( 1 - new / old )
stat_comp_benchmarks/benchmarks/low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 8.37 8.48 0.99 -1.27% slower
stat_comp_benchmarks/benchmarks/gp_pois_regr/gp_pois_regr.stan 2.26 2.29 0.99 -1.16% slower
stat_comp_benchmarks/benchmarks/eight_schools/eight_schools.stan 0.06 0.06 1.02 1.71% faster
stat_comp_benchmarks/benchmarks/irt_2pl/irt_2pl.stan 4.39 4.41 1.0 -0.26% slower
stat_comp_benchmarks/benchmarks/garch/garch.stan 0.44 0.44 1.02 1.78% faster
stat_comp_benchmarks/benchmarks/low_dim_gauss_mix/low_dim_gauss_mix.stan 2.71 2.68 1.01 0.8% faster
stat_comp_benchmarks/benchmarks/pkpd/sim_one_comp_mm_elim_abs.stan 0.23 0.23 0.99 -0.74% slower
stat_comp_benchmarks/benchmarks/pkpd/one_comp_mm_elim_abs.stan 18.05 18.17 0.99 -0.7% slower
stat_comp_benchmarks/benchmarks/gp_regr/gen_gp_data.stan 0.02 0.02 0.97 -2.89% slower
stat_comp_benchmarks/benchmarks/gp_regr/gp_regr.stan 0.1 0.1 1.0 0.17% faster
stat_comp_benchmarks/benchmarks/sir/sir.stan 83.34 104.44 0.8 -25.32% slower
stat_comp_benchmarks/benchmarks/arK/arK.stan 1.56 1.56 1.0 0.03% faster
stat_comp_benchmarks/benchmarks/low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 0.99 -1.14% slower
stat_comp_benchmarks/benchmarks/arma/arma.stan 0.3 0.29 1.03 2.95% faster
performance.compilation 233.85 232.53 1.01 0.56% faster
Mean result: 0.9866135502437444

Jenkins Console Log
Jenkins Build Stages
Commit hash: e7cab1646d71f360d212c6aecb8537bca67ebe6f

Machine information
Distributor ID:	Ubuntu
Description:	Ubuntu 20.04.3 LTS
Release:	20.04
Codename:	focal

CPU:

Architecture:                            x86_64
CPU op-mode(s):                          32-bit, 64-bit
Byte Order:                              Little Endian
Address sizes:                           46 bits physical, 48 bits virtual
CPU(s):                                  80
On-line CPU(s) list:                     0-79
Thread(s) per core:                      2
Core(s) per socket:                      20
Socket(s):                               2
NUMA node(s):                            2
Vendor ID:                               GenuineIntel
CPU family:                              6
Model:                                   85
Model name:                              Intel(R) Xeon(R) Gold 6248 CPU @ 2.50GHz
Stepping:                                7
CPU MHz:                                 1000.184
CPU max MHz:                             3900.0000
CPU min MHz:                             1000.0000
BogoMIPS:                                5000.00
Virtualization:                          VT-x
L1d cache:                               1.3 MiB
L1i cache:                               1.3 MiB
L2 cache:                                40 MiB
L3 cache:                                55 MiB
NUMA node0 CPU(s):                       0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78
NUMA node1 CPU(s):                       1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59,61,63,65,67,69,71,73,75,77,79
Vulnerability Gather data sampling:      Mitigation; Microcode
Vulnerability Indirect target selection: Mitigation; Aligned branch/return thunks
Vulnerability Itlb multihit:             KVM: Mitigation: Split huge pages
Vulnerability L1tf:                      Not affected
Vulnerability Mds:                       Not affected
Vulnerability Meltdown:                  Not affected
Vulnerability Mmio stale data:           Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Old microcode:             Not affected
Vulnerability Reg file data sampling:    Not affected
Vulnerability Retbleed:                  Mitigation; Enhanced IBRS
Vulnerability Spec rstack overflow:      Not affected
Vulnerability Spec store bypass:         Mitigation; Speculative Store Bypass disabled via prctl
Vulnerability Spectre v1:                Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2:                Mitigation; Enhanced / Automatic IBRS; IBPB conditional; PBRSB-eIBRS SW sequence; BHI SW loop, KVM SW loop
Vulnerability Srbds:                     Not affected
Vulnerability Tsa:                       Not affected
Vulnerability Tsx async abort:           Mitigation; TSX disabled
Vulnerability Vmscape:                   Mitigation; IBPB before exit to userspace
Flags:                                   fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 intel_ppin ssbd mba ibrs ibpb stibp ibrs_enhanced tpr_shadow flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invpcid cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req vnmi pku ospke avx512_vnni md_clear flush_l1d arch_capabilities

G++:

g++ (Ubuntu 9.4.0-1ubuntu1~20.04) 9.4.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Clang:

clang version 10.0.0-4ubuntu1 
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

@WardBrian
WardBrian merged commit aac5ec8 into stan-dev:develop Nov 4, 2026
34 checks passed
@stekien
stekien deleted the rename/sylvester branch November 4, 2026 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants