Skip to content

Commit de1a79c

Browse files
author
Fernando Hueso González
committed
add TRandomBinary to docu
1 parent 3cdb66e commit de1a79c

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

documentation/users-guide/MathLibraries.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ which are provided in the `ROOT::Math` namespace are:
3434
for evaluating one-dimensional (`ROOT::Math::IBaseFunctiononeDim`) and multi-dimensional functions
3535
(`ROOT::Math::IBaseFunctionMultiDim`) and parametric function interfaces for evaluating functions with parameters in one
3636
(`ROOT::Math::IParametricFunctionOneDim`) or multi dimensions (`ROOT::Math::IParametricFunctionMultiDim`).
37-
A set of user convenient wrapper classes, such as `ROOT::Math::Functor` is provided for wrapping user-classes in the needed interface,
38-
required to use the algorithms of the `ROOT` Mathematical libraries.
37+
A set of user convenient wrapper classes, such as `ROOT::Math::Functor` is provided for wrapping user-classes in the needed interface,
38+
required to use the algorithms of the `ROOT` Mathematical libraries.
3939

4040
- Numerical algorithms interfaces and in same cases default implementations for:
4141
- numerical integration;
4242
- numerical differentiation;
43-
- one dimensional root-finding;
44-
- one-dimensional minimization;
45-
- multi-dimensional minimization (only the `ROOT::Math::Minimizer` interface)
43+
- one dimensional root-finding;
44+
- one-dimensional minimization;
45+
- multi-dimensional minimization (only the `ROOT::Math::Minimizer` interface)
4646

4747
- Fitting classes: set of classes for fitting generic data sets. These classes are provided in the namespace `ROOT::Fit`.
4848
They are describing separately in the Fitting chapter.
@@ -268,6 +268,7 @@ classes. 4 different types exist: **`TRandom`**, **`TRandom1`**,
268268
of random generators. **`TRandom`** is the base class used by others. It
269269
implements methods for generating random numbers according to
270270
pre-defined distributions, such as Gaussian or Poisson.
271+
For random bit sequence generators, see **`TRandomBinary`**.
271272

272273
### TRandom
273274

@@ -592,6 +593,11 @@ Here are the CPU times obtained using the four random classes on an
592593
| `UNURAN` | | | | |
593594
+--------------------+---------------+----------------+----------------+----------------+
594595

596+
### TRandomBinary
597+
598+
This class generates pseudo-random binary sequences, to match those
599+
often implemented in electronic chips, based on linear feedback shift
600+
registers. A usage example can be found in $ROOTSYS/tutorials/PRBS.C.
595601

596602
## Mathematical Functions
597603

@@ -1469,10 +1475,10 @@ iteration the subinterval with the largest estimated error is bisected. It is po
14691475
* `Integration::kGAUSS41` : 41 points Gauss-Konrod rule (value = 4)
14701476
* `Integration::kGAUSS51` : 51 points Gauss-Konrod rule (value = 5)
14711477
* `Integration::kGAUSS61` : 61 points Gauss-Konrod rule (value = 6)
1472-
The higher-order rules give better accuracy for smooth functions, while lower-order rules save time when the function contains local difficulties, such as discontinuities. If no integration rule
1473-
is passed, the 31 points rule is used as default.
1478+
The higher-order rules give better accuracy for smooth functions, while lower-order rules save time when the function contains local difficulties, such as discontinuities. If no integration rule
1479+
is passed, the 31 points rule is used as default.
14741480

1475-
* `ROOT::Math::Integration::kADAPTIVESINGULAR`: based on `gsl_integration_qags`. It is an integration type which can be used in the case of the presence of singularities.It uses the
1481+
* `ROOT::Math::Integration::kADAPTIVESINGULAR`: based on `gsl_integration_qags`. It is an integration type which can be used in the case of the presence of singularities.It uses the
14761482
Gauss-Kronrod 21-point integration rule. This is the default algorithm
14771483

14781484
Note that when using the common `ROOT::Math::IntegratorOneDIm` class the enumeration type defining the algorithm must be defined in the namespace `ROOT::Math::IntegrationOneDim` (to distinguish from

0 commit comments

Comments
 (0)