tskit-dev / msprime

Simulate genealogical trees and genomic sequence data using population genetic models
GNU General Public License v3.0
170 stars 84 forks source link

Disallow unstable beta coalescents #2267

Closed JereKoskela closed 4 months ago

JereKoskela commented 4 months ago

Closes #2256 (again) by restricting the valid region of the Beta-coalescent alpha-parameter to 1 < alpha <= 1.991.

I can't make the timescale near alpha = 1 break even for values around 1 + 1e-15. So I've left that boundary case as it is, restricted only by alpha > 1. I'm amazed that it's so robust!

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (8886c85) 91.52% compared to head (f42e158) 91.52%.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267/graphs/tree.svg?width=650&height=150&src=pr&token=1uZQV1KMkU&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev)](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) ```diff @@ Coverage Diff @@ ## main #2267 +/- ## ======================================= Coverage 91.52% 91.52% ======================================= Files 20 20 Lines 11337 11337 Branches 2304 2304 ======================================= Hits 10376 10376 Misses 523 523 Partials 438 438 ``` | [Flag](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) | Coverage Δ | | |---|---|---| | [C](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) | `91.52% <100.00%> (ø)` | | | [python](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) | `98.70% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) | Coverage Δ | | |---|---|---| | [lib/msprime.c](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev#diff-bGliL21zcHJpbWUuYw==) | `86.12% <100.00%> (ø)` | | | [lib/util.c](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev#diff-bGliL3V0aWwuYw==) | `98.62% <100.00%> (ø)` | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev). Last update [8886c85...f42e158](https://app.codecov.io/gh/tskit-dev/msprime/pull/2267?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tskit-dev).
JereKoskela commented 4 months ago

This time I remembered the changelog.

JereKoskela commented 4 months ago

Ping @jeromekelleher & @Sendrowski. I think this is ready to be merged unless you have comments.

Sendrowski commented 4 months ago

It looks good to me!

jeromekelleher commented 4 months ago

I guess we should pop out another point release?