Update hypergeometric_pFq to delegate to specialisations where relevant by andrjohns · Pull Request #3167 · stan-dev/math · GitHub

Summary

This PR updates hypergeometric_pFq to delegate the existing specialisations (e.g., hypergeometric_2F1) to take advantage of their optimisations/reparameterisations.

For this I had to extract the actual call to Boost's hypergeometric_pFq into a standalone file to avoid recursive includes

Tests

N/A - tests should still pass

Side Effects

N/A

Release notes

Update hypergeometric_pFq to delegate to specialisations where relevant

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

Do we actually want to include this in prim/fun.hpp? Not fully sure what the implications of leaving it out would be

Name	Old Result	New Result	Ratio	Performance change( 1 - new / old )
arma/arma.stan	0.31	0.31	1.0	0.41% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan	0.01	0.01	1.04	4.16% faster
gp_regr/gen_gp_data.stan	0.02	0.02	1.06	5.7% faster
gp_regr/gp_regr.stan	0.09	0.09	0.98	-1.55% slower
sir/sir.stan	68.35	66.34	1.03	2.94% faster
irt_2pl/irt_2pl.stan	3.97	3.93	1.01	0.85% faster
eight_schools/eight_schools.stan	0.06	0.05	1.08	7.29% faster
pkpd/sim_one_comp_mm_elim_abs.stan	0.25	0.24	1.04	3.86% faster
pkpd/one_comp_mm_elim_abs.stan	18.95	19.22	0.99	-1.43% slower
garch/garch.stan	0.41	0.41	1.02	1.71% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan	2.66	2.64	1.01	0.82% faster
arK/arK.stan	1.78	1.72	1.04	3.75% faster
gp_pois_regr/gp_pois_regr.stan	2.77	2.7	1.02	2.29% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan	8.47	8.28	1.02	2.19% faster
performance.compilation	180.87	184.13	0.98	-1.8% slower
Mean result: 1.0219333973810245

Jenkins Console Log
Blue Ocean
Commit hash: 4adb4ac5420f16dca008d1b8a4c39b44dd6fea4d

Machine information No LSB modules are available. 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 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 2400.000
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.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 Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Reg file data sampling: Not affected
Vulnerability Retbleed: Mitigation; 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; IBRS; IBPB conditional; STIBP conditional; RSB filling; PBRSB-eIBRS Not affected; BHI Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
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 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm 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 pku ospke 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

Name	Old Result	New Result	Ratio	Performance change( 1 - new / old )
arma/arma.stan	0.34	0.31	1.09	8.53% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan	0.01	0.01	1.07	6.79% faster
gp_regr/gen_gp_data.stan	0.03	0.02	1.06	5.51% faster
gp_regr/gp_regr.stan	0.11	0.09	1.22	18.08% faster
sir/sir.stan	69.1	66.94	1.03	3.13% faster
irt_2pl/irt_2pl.stan	3.96	3.98	0.99	-0.53% slower
eight_schools/eight_schools.stan	0.05	0.05	1.01	1.32% faster
pkpd/sim_one_comp_mm_elim_abs.stan	0.24	0.24	1.02	2.02% faster
pkpd/one_comp_mm_elim_abs.stan	19.44	18.74	1.04	3.61% faster
garch/garch.stan	0.43	0.41	1.06	5.41% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan	2.78	2.61	1.07	6.12% faster
arK/arK.stan	1.79	1.73	1.03	3.18% faster
gp_pois_regr/gp_pois_regr.stan	2.8	2.74	1.02	2.13% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan	8.73	8.37	1.04	4.1% faster
performance.compilation	181.84	181.84	1.0	0.0% slower
Mean result: 1.050884395628699

Jenkins Console Log
Blue Ocean
Commit hash: 4adb4ac5420f16dca008d1b8a4c39b44dd6fea4d

Machine information No LSB modules are available. 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 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 1971.554
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.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 Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Reg file data sampling: Not affected
Vulnerability Retbleed: Mitigation; 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; IBRS; IBPB conditional; STIBP conditional; RSB filling; PBRSB-eIBRS Not affected; BHI Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
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 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm 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 pku ospke 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

Note: 0F0(;;z) = exp(z)

Just needs docs for the template parameters for the helper then I think this is good!

Needs docs for template parameters

Hi @andrjohns this just needs to docs for the template parameters then it is good to go. I can do that if you don't have the time

@andrjohns you think you can update those docs over the next 2 weeks?

we may also add something like:

if (a_ref.size() == 0 && b_ref.size() == 0) 
  return exp(z);

andrjohns and others added 3 commits March 22, 2025 19:15

Update hypergeometric_pFq to delegate to specialisations where relevant

2896f60

[Jenkins] auto-formatting by clang-format version 10.0.0-4ubuntu1

d61f515

Not 3F2 for now

22d4541

WardBrian reviewed Mar 22, 2025

View reviewed changes

Remove from central include

66cfe21

WardBrian approved these changes Mar 27, 2025

View reviewed changes

SteveBronder requested changes Apr 10, 2025

View reviewed changes

jachymb reviewed May 12, 2026

View reviewed changes

               #include <stan/math/prim/fun/hypergeometric_2F2.hpp>
               #include <stan/math/prim/fun/hypergeometric_3F2.hpp>
               #include <stan/math/prim/fun/hypergeometric_pFq.hpp>
+              #include <stan/math/prim/fun/hypergeometric_pFq_helper.hpp>

Update hypergeometric_pFq to delegate to specialisations where relevant by andrjohns · Pull Request #3167 · stan-dev/math · GitHub

Uh oh!

Uh oh!

Update hypergeometric_pFq to delegate to specialisations where relevant - #3167

Update hypergeometric_pFq to delegate to specialisations where relevant#3167
andrjohns wants to merge 4 commits into
developfrom
hypergeometric_pfq-delegate

andrjohns commented Mar 22, 2025

Uh oh!

WardBrian Mar 22, 2025

Uh oh!

stan-buildbot commented Mar 22, 2025

Uh oh!

stan-buildbot commented Mar 23, 2025

Uh oh!

jachymb commented Apr 9, 2025

Uh oh!

SteveBronder left a comment

Uh oh!

SteveBronder Apr 10, 2025

Uh oh!

SteveBronder Sep 23, 2025

Uh oh!

spinkney commented Apr 24, 2025

Uh oh!

jachymb May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

+               *
+               * This is declared separatel to avoid circular dependencies between the
+               * various hypergeometric functions.
+               *

                 plain_type_t<Ta> a_ref = a;
                 plain_type_t<Tb> b_ref = b;
+                if (a_ref.size() == 1 && b_ref.size() == 0) {

Update hypergeometric_pFq to delegate to specialisations where relevant by andrjohns · Pull Request #3167 · stan-dev/math · GitHub

Uh oh!

Uh oh!

Update hypergeometric_pFq to delegate to specialisations where relevant - #3167

Update hypergeometric_pFq to delegate to specialisations where relevant#3167andrjohns wants to merge 4 commits intodevelopstan-dev/math:developfrom hypergeometric_pfq-delegatestan-dev/math:hypergeometric_pfq-delegateCopy head branch name to clipboard

Conversation

andrjohns commented Mar 22, 2025

Summary

Tests

Side Effects

Release notes

Checklist

Uh oh!

WardBrian Mar 22, 2025

Choose a reason for hiding this comment

Uh oh!

stan-buildbot commented Mar 22, 2025

Uh oh!

stan-buildbot commented Mar 23, 2025

Uh oh!

jachymb commented Apr 9, 2025

Uh oh!

SteveBronder left a comment

Choose a reason for hiding this comment

Uh oh!

SteveBronder Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

SteveBronder Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

spinkney commented Apr 24, 2025

Uh oh!

jachymb May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Update hypergeometric_pFq to delegate to specialisations where relevant#3167
andrjohns wants to merge 4 commits into
developfrom
hypergeometric_pfq-delegate