Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify the formula for the CDF of the Cauchy distribution. #1234

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

WarrenWeckesser
Copy link
Contributor

The Cauchy CDF function may be expressed as atan2(1, -x)/pi.

The Cauchy CDF function may be expressed as atan2(1, -x)/pi.
Copy link
Member

@mborland mborland left a comment

Choose a reason for hiding this comment

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

This looks good to me. Thanks!. The only CI failure is an S390x runner failing to clone (which the CI manager is aware this has been occurring more frequently).

@mborland mborland merged commit 024a4fe into boostorg:develop Jan 17, 2025
77 of 78 checks passed
@WarrenWeckesser WarrenWeckesser deleted the simplify-cauchy-cdf branch January 17, 2025 13:25
@WarrenWeckesser
Copy link
Contributor Author

I should have also updated cauchy.qbk. I'll create a new PR to update the CDF "Implementation Notes" section.

Is there a guide or recipe somewhere for how to run quickbook to build the docs?

@mborland
Copy link
Member

I should have also updated cauchy.qbk. I'll create a new PR to update the CDF "Implementation Notes" section.

Is there a guide or recipe somewhere for how to run quickbook to build the docs?

There's a synopsis here: https://github.com/boostorg/math?tab=readme-ov-file#building-documentation. In practice you need some pretty old libraries and binaries to make it work so the CI will tell you if something is formatted incorrectly.

@jzmaddock
Copy link
Collaborator

There's a synopsis here: https://github.com/boostorg/math?tab=readme-ov-file#building-documentation. In practice you need some pretty old libraries and binaries to make it work so the CI will tell you if something is formatted incorrectly.

The markup is reasonably human readable - so what @mborland says, just commit, and we can always fix it up.

BTW you shouldn't actually need old binaries though - the only thing that is version-fixed is the document DTD - though I confess I haven't updated anything in a good while ;)

@WarrenWeckesser
Copy link
Contributor Author

WarrenWeckesser commented Jan 22, 2025

There's a synopsis here: ...

Argh, right there in the README file! Not sure how I missed that.

On my Linux machine, I had to install xsltproc (I guess I had all the other dependencies already installed), and I changed darwin to gcc in user-config.jam.

The HTML built successfully, and the change that I made looks OK. For a change like this, do I also commit all the updated HTML files as part of the PR, or should I only submit the change to cauchy.qbk?

@jzmaddock
Copy link
Collaborator

Just the .qbk file for the minute, we'll regenerate the docs prior to release (and the CI builds it too). Thanks!

@WarrenWeckesser
Copy link
Contributor Author

WarrenWeckesser commented Jan 22, 2025

If the only change is in cauchy.qbk, should I used [ci skip] in the commit message?

@jzmaddock
Copy link
Collaborator

No might as well let CI build as it checks the docs for validity.

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