Skip to content

Commit f53a221

Browse files
committed
[docs] Merge documentation of MathMore and MathCore.
Since the documentation of both math groups share the same subgroups, doxygen fails to create a stable index that can be navigated. One gets thrown around between MathCore and MathMore in an unpredictable way. Here, groups such as probability density functions and smiliar are only listed in MathCore, and MathMore is moved as a subgroup into MathCore. It is explained what MathMore is, how it can be (de-)activated, and why it's separate from MathCore. Fix #7440
1 parent 5ba79a9 commit f53a221

File tree

7 files changed

+18
-41
lines changed

7 files changed

+18
-41
lines changed

math/mathcore/doc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\defgroup MathCore MathCore
1+
\defgroup MathCore Core Math Functionality (MathCore)
22
\ingroup Math
33
\brief The Core Mathematical Library of %ROOT.
44

math/mathcore/inc/Math/Integrator.h

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,14 @@
2626
#include <vector>
2727
#include <string>
2828

29-
3029
/**
3130
@defgroup NumAlgo Numerical Algorithms
3231
3332
Numerical Algorithm classes from the \ref MathCore and \ref MathMore libraries.
3433
3534
@ingroup MathCore
36-
@ingroup MathMore
37-
3835
*/
3936

40-
4137
/**
4238
4339
@defgroup Integration Numerical Integration

math/mathcore/inc/Math/Math.h

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,6 @@
4545
#define M_PI_4 0.78539816339744830961566084582 // Pi/4
4646
#endif
4747

48-
/**
49-
\namespace ROOT
50-
Namespace for new ROOT classes and functions
51-
*/
52-
5348
namespace ROOT {
5449

5550
/**

math/mathcore/inc/Math/PdfFuncMathCore.h

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
* *
99
**********************************************************************/
1010

11-
12-
1311
/**
1412
1513
Probability density functions, cumulative distribution functions
@@ -23,15 +21,11 @@ user must calculate the shift themselves if they wish.
2321
2422
MathCore provides the majority of the probability density functions, of the
2523
cumulative distributions and of the quantiles (inverses of the cumulatives).
26-
Additional distributions are also provided by the
27-
<A HREF="../../MathMore/html/group__StatFunc.html">MathMore</A> library.
24+
Additional distributions are also provided by the \ref MathMore library.
2825
2926
3027
@defgroup StatFunc Statistical functions
31-
3228
@ingroup MathCore
33-
@ingroup MathMore
34-
3529
*/
3630

3731
#ifndef ROOT_Math_PdfFuncMathCore
@@ -58,12 +52,11 @@ namespace Math {
5852
*
5953
*/
6054

61-
/** @name Probability Density Functions from MathCore
62-
* Additional PDF's are provided in the MathMore library
63-
* (see PDF functions from MathMore)
64-
*/
55+
/** @name Probability Density Functions from MathCore
56+
* Additional PDFs are provided in the MathMore library when the GSL is available.
57+
*/
6558

66-
//@{
59+
//@{
6760

6861
/**
6962

math/mathcore/inc/Math/SpecFuncMathCore.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
* *
99
**********************************************************************/
1010

11-
12-
1311
/**
1412
1513
Special mathematical functions.
@@ -23,7 +21,6 @@ N1687=04-0127, September 10, 2004</A>
2321
2422
@defgroup SpecFunc Special functions
2523
@ingroup MathCore
26-
@ingroup MathMore
2724
2825
*/
2926

math/mathmore/doc/index.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
\defgroup MathMore MathMore
2-
\ingroup Math
3-
\brief The Mathematical library providing some advanced functionality and based on GSL.
2+
\ingroup MathCore
3+
\brief The Mathematical library providing GSL extensions to MathCore.
44

55
**MathMore** provides an advanced collection of functions and C++ classes for HEP numerical
6-
computing. This is an extension of the functionality provided by the \ref MathCore. The
7-
current set includes classes and functions for:
6+
computing. This is an extension of the functionality provided by the \ref MathCore, which becomes
7+
available when a GSL library is found in the system. It can be enabled/disabled
8+
when configuring %ROOT using `cmake -Dmathmore=On/Off`.
9+
MathMore links with the GSL static libraries, so note that its license differs from ROOT's usual license,
10+
since the GPL is distributed under the GNU General Public License. On some platforms (like Linux x86-64), GSL
11+
needs to be compiled with the option `--with-pic`.
812

13+
MathMore provides extensions to the following MathCore groups:
914
* \ref SpecFunc, with all the major functions (Bessel functions, Legendre polynomial, etc..)
1015
* \ref StatFunc, Mathematical functions used in statistics such as probability density
1116
functions, cumulative distributions functions and their inverse (quantiles).
@@ -29,11 +34,4 @@ installed somewhere in your system. A version of GSL larger or equal 1.8 is requ
2934
file of GSL can be downloaded from the [GSL Web site](http://www.gnu.org/software/gsl/#downloading),
3035
or (for version 1.8) from [here](http://seal.web.cern.ch/seal/MathLibs/gsl-1.8.tar.gz).
3136
Windows binaries, compiled using Visual Studio 7.1 can be downloaded from
32-
[this location](http://seal.web.cern.ch/seal/MathLibs/GSL-1.8.zip).
33-
34-
MathMore (and its %ROOT CINT dictionary) can be built within %ROOT whenever a GSL library
35-
is found in the system. Optionally the GSL library and header file location can be specified
36-
in the %ROOT configure script with _configure --with-gsl-incdir=... --with-gsl-libdir=..._
37-
MathMore links with the GSL static libraries. On some platform (like Linux x86-64) GSL
38-
needs to be compiled with the option _--with-pic_.
39-
The source code of MathMore is distributed under the GNU General Public License
37+
[this location](http://seal.web.cern.ch/seal/MathLibs/GSL-1.8.zip).

math/mathmore/inc/Math/QuasiRandom.h

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,11 @@
3535

3636
/**
3737
@defgroup QuasiRandom QuasiRandom number generators and distributions
38-
Classes for generating QuasiRandom numbers and based on GSL
38+
Classes for generating QuasiRandom numbers and based on GSL.
39+
\note MathMore needs to be enabled for these integrator to be available.
3940
@ingroup Random
40-
@ingroup MathMore
4141
*/
4242

43-
44-
4543
namespace ROOT {
4644
namespace Math {
4745

0 commit comments

Comments
 (0)