Skip to content

Don't error on size-zero inputs to LKJ lpdf - #3347

Open
andrjohns wants to merge 2 commits into
developfrom
lkj-dim-zero
Open

Don't error on size-zero inputs to LKJ lpdf#3347
andrjohns wants to merge 2 commits into
developfrom
lkj-dim-zero

Conversation

@andrjohns

@andrjohns andrjohns commented Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

The validation check order for inputs to lkj_corr_cholesky_lpdf changed since Stan 2.32, so that cholesky factors of size zero now error and reject instead of just returning 0. This breaks downstream applications which conditionally set the size to zero to remove it from the likelihood ( the rmdcev R package relies on this).

This PR updates the check_cholesky_factor to allow size-zero inputs

Tests

Additional test added for size-zero handling

Side Effects

N/A

Release notes

lkj_corr_cholesky_lpdf returns 0 instead of error with size-zero inputs

Checklist

  • Copyright holder: Andrew Johnson

    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

@andrjohns

Copy link
Copy Markdown
Collaborator Author

Hmm looks like there's a bit of inconsistency between the tests and the code for some of the distributions

For example, the multi_student_t_cholesky_lpdf function has codepaths for size-zero location/df and size-zero cholesky factor, but the check_* functions error before those paths are reached and the tests expect errors for size-zero inputs

@SteveBronder

Copy link
Copy Markdown
Collaborator

I'll approve once the tests pass. imo I think we need a claude or a bot to sweep through our code and check everywhere we should allow zero sized vectors and matrices.

@SteveBronder SteveBronder self-assigned this Aug 26, 2026
@SteveBronder

Copy link
Copy Markdown
Collaborator

@andrjohns

I think this PR is good and we just need to update the tests to reflect what should be happening

[       OK ] ProbDistributionsInvWishartCholesky.inv_wishart_cholesky_pos_def (0 ms)
[ RUN      ] ProbDistributionsInvWishartCholesky.0x0
test/unit/math/prim/prob/inv_wishart_cholesky_test.cpp:63: Failure
Expected: stan::math::inv_wishart_cholesky_lpdf(Y, dof, Sigma) throws an exception of type std::domain_error.
  Actual: it throws nothing.
test/unit/math/prim/prob/inv_wishart_cholesky_test.cpp:67: Failure
Expected: stan::math::inv_wishart_cholesky_lpdf(Y, dof0, Sigma) throws an exception of type std::domain_error.
  Actual: it throws nothing.

@stan-buildbot

Copy link
Copy Markdown
Contributor
Name Old Result New Result Ratio Performance change( 1 - new / old )
stat_comp_benchmarks/benchmarks/gp_regr/gen_gp_data.stan 0.04 0.04 0.99 -0.7% slower
stat_comp_benchmarks/benchmarks/gp_regr/gp_regr.stan 0.16 0.17 0.99 -1.02% slower
stat_comp_benchmarks/benchmarks/garch/garch.stan 0.86 0.87 1.0 -0.46% slower
stat_comp_benchmarks/benchmarks/low_dim_corr_gauss/low_dim_corr_gauss.stan 0.02 0.02 0.98 -1.92% slower
stat_comp_benchmarks/benchmarks/eight_schools/eight_schools.stan 0.11 0.11 0.99 -0.51% slower
stat_comp_benchmarks/benchmarks/low_dim_gauss_mix/low_dim_gauss_mix.stan 8.32 8.41 0.99 -1.11% slower
stat_comp_benchmarks/benchmarks/gp_pois_regr/gp_pois_regr.stan 3.72 3.68 1.01 0.98% faster
stat_comp_benchmarks/benchmarks/pkpd/one_comp_mm_elim_abs.stan 32.7 34.06 0.96 -4.17% slower
stat_comp_benchmarks/benchmarks/pkpd/sim_one_comp_mm_elim_abs.stan 0.38 0.38 1.0 0.08% faster
stat_comp_benchmarks/benchmarks/irt_2pl/irt_2pl.stan 6.63 6.72 0.99 -1.29% slower
stat_comp_benchmarks/benchmarks/sir/sir.stan 135.9 138.5 0.98 -1.92% slower
stat_comp_benchmarks/benchmarks/arK/arK.stan 3.23 3.22 1.0 0.03% faster
stat_comp_benchmarks/benchmarks/arma/arma.stan 0.59 0.59 1.0 -0.18% slower
stat_comp_benchmarks/benchmarks/low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 24.98 25.09 1.0 -0.44% slower
performance.compilation 389.89 405.6 0.96 -4.03% slower
Mean result: 0.9892131624851447

Jenkins Console Log
Jenkins Build Stages
Commit hash: 7e5ee47a0634cc5f5f59c91e7e28b9f4519385fb

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:                           52 bits physical, 57 bits virtual
CPU(s):                                  192
On-line CPU(s) list:                     0-191
Thread(s) per core:                      2
Core(s) per socket:                      48
Socket(s):                               2
NUMA node(s):                            2
Vendor ID:                               AuthenticAMD
CPU family:                              25
Model:                                   17
Model name:                              AMD EPYC 9474F 48-Core Processor
Stepping:                                1
Frequency boost:                         enabled
CPU MHz:                                 1498.243
CPU max MHz:                             4114.4229
CPU min MHz:                             1500.0000
BogoMIPS:                                7189.04
Virtualization:                          AMD-V
L1d cache:                               3 MiB
L1i cache:                               3 MiB
L2 cache:                                96 MiB
L3 cache:                                512 MiB
NUMA node0 CPU(s):                       0-47,96-143
NUMA node1 CPU(s):                       48-95,144-191
Vulnerability Gather data sampling:      Not affected
Vulnerability Indirect target selection: Not affected
Vulnerability Itlb multihit:             Not affected
Vulnerability L1tf:                      Not affected
Vulnerability Mds:                       Not affected
Vulnerability Meltdown:                  Not affected
Vulnerability Mmio stale data:           Not affected
Vulnerability Reg file data sampling:    Not affected
Vulnerability Retbleed:                  Not affected
Vulnerability Spec rstack overflow:      Mitigation; Safe RET
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; STIBP always-on; PBRSB-eIBRS Not affected; BHI Not affected
Vulnerability Srbds:                     Not affected
Vulnerability Tsa:                       Mitigation; Clear CPU buffers
Vulnerability Tsx async abort:           Not affected
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 mmx fxsr sse sse2 ht syscall nx mmxext fxsr_opt pdpe1gb rdtscp lm constant_tsc rep_good amd_lbr_v2 nopl xtopology nonstop_tsc cpuid extd_apicid aperfmperf rapl pni pclmulqdq monitor ssse3 fma cx16 pcid sse4_1 sse4_2 x2apic movbe popcnt aes xsave avx f16c rdrand lahf_lm cmp_legacy svm extapic cr8_legacy abm sse4a misalignsse 3dnowprefetch osvw ibs skinit wdt tce topoext perfctr_core perfctr_nb bpext perfctr_llc mwaitx cpb cat_l3 cdp_l3 hw_pstate ssbd mba perfmon_v2 ibrs ibpb stibp ibrs_enhanced vmmcall fsgsbase bmi1 avx2 smep bmi2 erms invpcid cqm rdt_a avx512f avx512dq rdseed adx smap avx512ifma clflushopt clwb avx512cd sha_ni avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local user_shstk avx512_bf16 clzero irperf xsaveerptr rdpru wbnoinvd amd_ppin cppc arat npt lbrv svm_lock nrip_save tsc_scale vmcb_clean flushbyasid decodeassists pausefilter pfthreshold avic v_vmsave_vmload vgif x2avic v_spec_ctrl vnmi avx512vbmi umip pku ospke avx512_vbmi2 gfni vaes vpclmulqdq avx512_vnni avx512_bitalg avx512_vpopcntdq la57 rdpid overflow_recov succor smca fsrm flush_l1d debug_swap

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

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.

4 participants