Bug fix of issue #3057 Allow zero total count for multinomial RNG

[chvandorp]

Summary

This PR fixes a small bug in multinomial_rng and multinomial_logit_rng. While the lpmf functions accept a zero count vector, the RNGs do not accept a zero total count. This is fixed by replacing check_positive with check_nonnegative for the parameter N. In addition the doc strings of multinomial_rng ad multinomial_logit_rng are updated to indicate which exceptions are thrown under what conditions.
I've also updated a comment in dirichlet_multinomial_rng, which was no longer relevant because of this bug fix.

Tests

For both multinomial_rng and multinomial_logit_rng a test is added (called RNGZero) to test that no exceptions are thrown when N == 0, and that the result is a zero count vector.

Side Effects

There should be no side effects

Release notes

The RNGs for the multinomial and multinomial_logit distributions now accept a zero total count, resulting in a zero integer vector.

Checklist

• Copyright holder: Christiaan H. van Dorp

  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

[stan-buildbot]

---

Name	Old Result	New Result	Ratio	Performance change( 1 - new / old )
arma/arma.stan	0.19	0.2	0.96	-4.08% slower
low_dim_corr_gauss/low_dim_corr_gauss.stan	0.01	0.01	1.02	1.91% faster
gp_regr/gen_gp_data.stan	0.02	0.02	0.99	-1.22% slower
gp_regr/gp_regr.stan	0.11	0.11	0.97	-2.99% slower
sir/sir.stan	79.42	80.42	0.99	-1.26% slower
irt_2pl/irt_2pl.stan	4.1	3.84	1.07	6.44% faster
eight_schools/eight_schools.stan	0.06	0.05	1.04	4.06% faster
pkpd/sim_one_comp_mm_elim_abs.stan	0.26	0.25	1.04	3.99% faster
pkpd/one_comp_mm_elim_abs.stan	18.41	17.81	1.03	3.26% faster
garch/garch.stan	0.47	0.45	1.04	3.94% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan	2.86	2.76	1.03	3.32% faster
arK/arK.stan	1.64	1.61	1.02	1.71% faster
gp_pois_regr/gp_pois_regr.stan	2.6	2.5	1.04	3.81% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan	9.15	9.09	1.01	0.62% faster
performance.compilation	180.85	186.07	0.97	-2.88% slower
Mean result: 1.0149077305597232

---

Jenkins Console Log
Blue Ocean
Commit hash: a336d9a814ea6e70dee68d8dbdc632f2e97dca52

---

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: 3253.903
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 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
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

[WardBrian]

Thank you!