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.

Sign up for GitHub

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

Miscellaneous comment and doc corrections. #1239

Merged
merged 4 commits into from
Jan 27, 2025
Merged

Miscellaneous comment and doc corrections. #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8146325
MAINT: Fix a repeated typo in a comment in several test files.
WarrenWeckesser Jan 25, 2025
242d36c
MAINT: Remove a comment about the number of distributions.
WarrenWeckesser Jan 25, 2025
dd02f22
DOC: Fix a typo in the example test driver program in special_tut.qbk.
WarrenWeckesser Jan 25, 2025
2fda707
MAINT: Remove an obsolete comment in skew_normal.hpp.
WarrenWeckesser Jan 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/background/special_tut.qbk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ Now we just need to write the test driver program, at it's most basic it looks s
std::cout << "<note>The long double tests have been disabled on this platform "
"either because the long double overloads of the usual math functions are "
"not available at all, or because they are too inaccurate for these tests "
"to pass.</note>" << std::cout;
"to pass.</note>" << std::endl;
#endif
}

Expand Down
2 changes: 0 additions & 2 deletions include/boost/math/distributions/fwd.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
#ifndef BOOST_MATH_DISTRIBUTIONS_FWD_HPP
#define BOOST_MATH_DISTRIBUTIONS_FWD_HPP

// 33 distributions at Boost 1.9.1 after adding hyperexpon and arcsine

namespace boost{ namespace math{

template <class RealType, class Policy>
Expand Down
2 changes: 1 addition & 1 deletion include/boost/math/distributions/skew_normal.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
// Azzalini, A. (1985). "A class of distributions which includes the normal ones".
// Scand. J. Statist. 12: 171-178.

#include <boost/math/distributions/fwd.hpp> // TODO add skew_normal distribution to fwd.hpp!
#include <boost/math/distributions/fwd.hpp>
#include <boost/math/special_functions/owens_t.hpp> // Owen's T function
#include <boost/math/distributions/complement.hpp>
#include <boost/math/distributions/normal.hpp>
Expand Down
14 changes: 7 additions & 7 deletions test/test_holtsmark.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ using boost::multiprecision::cpp_bin_float_quad;
template<class RealType, int N>
void do_test_holtsmark_pdf(){
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -228,7 +228,7 @@ void do_test_holtsmark_pdf(){
template<class RealType, int N>
void do_test_holtsmark_cdf() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -316,7 +316,7 @@ void do_test_holtsmark_cdf() {
template<class RealType, int N>
void do_test_holtsmark_ccdf() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -511,7 +511,7 @@ void do_test_holtsmark_ccdf() {
template<class RealType, int N>
void do_test_holtsmark_quantile_nearzero() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -669,7 +669,7 @@ void do_test_holtsmark_quantile_nearzero() {
template<class RealType, int N>
void do_test_holtsmark_quantile_lower() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -718,7 +718,7 @@ void do_test_holtsmark_quantile_lower() {
template<class RealType, int N>
void do_test_holtsmark_quantile_upper() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand All @@ -744,7 +744,7 @@ void do_test_holtsmark_quantile_upper() {
template<class RealType, int N>
void do_test_holtsmark_locscale_param() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//

Expand Down
14 changes: 7 additions & 7 deletions test/test_landau.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ using boost::math::landau_distribution;
template<class RealType, int N>
void do_test_landau_pdf(){
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -234,7 +234,7 @@ void do_test_landau_pdf(){
template<class RealType, int N>
void do_test_landau_cdf() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -329,7 +329,7 @@ void do_test_landau_cdf() {
template<class RealType, int N>
void do_test_landau_ccdf() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -515,7 +515,7 @@ void do_test_landau_ccdf() {
template<class RealType, int N>
void do_test_landau_quantile_nearzero() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -564,7 +564,7 @@ void do_test_landau_quantile_nearzero() {
template<class RealType, int N>
void do_test_landau_quantile_lower() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -634,7 +634,7 @@ void do_test_landau_quantile_lower() {
template<class RealType, int N>
void do_test_landau_quantile_upper() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -688,7 +688,7 @@ void do_test_landau_quantile_upper() {
template<class RealType, int N>
void do_test_landau_locscale_param() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//

Expand Down
14 changes: 7 additions & 7 deletions test/test_mapairy.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ using boost::multiprecision::cpp_bin_float_quad;
template<class RealType, int N>
void do_test_mapairy_pdf(){
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -266,7 +266,7 @@ void do_test_mapairy_pdf(){
template<class RealType, int N>
void do_test_mapairy_cdf() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -391,7 +391,7 @@ void do_test_mapairy_cdf() {
template<class RealType, int N>
void do_test_mapairy_ccdf() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -585,7 +585,7 @@ void do_test_mapairy_ccdf() {
template<class RealType, int N>
void do_test_mapairy_quantile_nearzero() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -634,7 +634,7 @@ void do_test_mapairy_quantile_nearzero() {
template<class RealType, int N>
void do_test_mapairy_quantile_lower() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -705,7 +705,7 @@ void do_test_mapairy_quantile_lower() {
template<class RealType, int N>
void do_test_mapairy_quantile_upper() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -767,7 +767,7 @@ void do_test_mapairy_quantile_upper() {
template<class RealType, int N>
void do_test_mapairy_locscale_param() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//

Expand Down
8 changes: 4 additions & 4 deletions test/test_saspoint5.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ using boost::multiprecision::cpp_bin_float_quad;
template<class RealType, int N>
void do_test_saspoint5_pdf(){
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -748,7 +748,7 @@ void do_test_saspoint5_quantile_nearzero() {
template<class RealType, int N>
void do_test_saspoint5_quantile_lower() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand Down Expand Up @@ -793,7 +793,7 @@ void do_test_saspoint5_quantile_lower() {
template<class RealType, int N>
void do_test_saspoint5_quantile_upper() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//
BOOST_MATH_STD_USING
Expand All @@ -819,7 +819,7 @@ void do_test_saspoint5_quantile_upper() {
template<class RealType, int N>
void do_test_saspoint5_locscale_param() {
//
// Basic sanity checks, tolerance is either 3 epsilon
// Basic sanity checks, tolerance is 3 epsilon
// expressed as a percentage:
//

Expand Down
Loading