From d157dc2f345975d318696b19e4b8b64a3de61e2c Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (l)" <j.wuttke@fz-juelich.de>
Date: Tue, 24 Nov 2020 13:56:20 +0100
Subject: [PATCH] regenerate
---
auto/Wrap/doxygenBase.i | 2 +-
auto/Wrap/doxygenCore.i | 104 +++---------------
auto/Wrap/doxygenDevice.i | 18 ++--
auto/Wrap/doxygenFit.i | 145 +++++++-------------------
auto/Wrap/doxygenParam.i | 12 +--
auto/Wrap/doxygenSample.i | 86 +++++++--------
auto/Wrap/libBornAgainDevice.py | 10 +-
auto/Wrap/libBornAgainDevice_wrap.cpp | 4 +-
auto/Wrap/libBornAgainParam.py | 2 +-
auto/Wrap/libBornAgainParam_wrap.cpp | 2 +-
auto/Wrap/libBornAgainSample.py | 2 +-
11 files changed, 120 insertions(+), 267 deletions(-)
diff --git a/auto/Wrap/doxygenBase.i b/auto/Wrap/doxygenBase.i
index 0ddeba653b3..e7af05b5a5d 100644
--- a/auto/Wrap/doxygenBase.i
+++ b/auto/Wrap/doxygenBase.i
@@ -1219,7 +1219,7 @@ Creates a new clipped axis.
";
-// File: namespace_0d16.xml
+// File: namespace_0D16.xml
// File: namespacealgo.xml
diff --git a/auto/Wrap/doxygenCore.i b/auto/Wrap/doxygenCore.i
index 39aeeffbefa..329624469ec 100644
--- a/auto/Wrap/doxygenCore.i
+++ b/auto/Wrap/doxygenCore.i
@@ -1466,43 +1466,6 @@ weight_factors:
user-defined weighting factors. Used linearly, no matter which norm is chosen.
";
-%feature("docstring") PoissonLikeMetric::computeFromArrays "double Chi2Metric::computeFromArrays(std::vector< double > sim_data, std::vector< double > exp_data, std::vector< double > uncertainties, std::vector< double > weight_factors) const override
-
-Computes metric value from data arrays. Negative values in exp_data are ignored as well as non-positive weight_factors and uncertainties. All arrays involved in the computation must be of the same size.
-
-Parameters:
------------
-
-sim_data:
-array with simulated intensities.
-
-exp_data:
-array with intensity values obtained from an experiment.
-
-uncertainties:
-array with experimental data uncertainties.
-
-weight_factors:
-user-defined weighting factors. Used linearly, no matter which norm is chosen.
-";
-
-%feature("docstring") PoissonLikeMetric::computeFromArrays "double Chi2Metric::computeFromArrays(std::vector< double > sim_data, std::vector< double > exp_data, std::vector< double > weight_factors) const override
-
-Computes metric value from data arrays. Negative values in exp_data are ignored as well as non-positive weight_factors. All arrays involved in the computation must be of the same size.
-
-Parameters:
------------
-
-sim_data:
-array with simulated intensities.
-
-exp_data:
-array with intensity values obtained from an experiment.
-
-weight_factors:
-user-defined weighting factors. Used linearly, no matter which norm is chosen.
-";
-
// File: classPoissonNoiseBackground.xml
%feature("docstring") PoissonNoiseBackground "
@@ -1676,43 +1639,6 @@ weight_factors:
user-defined weighting factors. Used linearly, no matter which norm is chosen.
";
-%feature("docstring") RelativeDifferenceMetric::computeFromArrays "double Chi2Metric::computeFromArrays(std::vector< double > sim_data, std::vector< double > exp_data, std::vector< double > uncertainties, std::vector< double > weight_factors) const override
-
-Computes metric value from data arrays. Negative values in exp_data are ignored as well as non-positive weight_factors and uncertainties. All arrays involved in the computation must be of the same size.
-
-Parameters:
------------
-
-sim_data:
-array with simulated intensities.
-
-exp_data:
-array with intensity values obtained from an experiment.
-
-uncertainties:
-array with experimental data uncertainties.
-
-weight_factors:
-user-defined weighting factors. Used linearly, no matter which norm is chosen.
-";
-
-%feature("docstring") RelativeDifferenceMetric::computeFromArrays "double Chi2Metric::computeFromArrays(std::vector< double > sim_data, std::vector< double > exp_data, std::vector< double > weight_factors) const override
-
-Computes metric value from data arrays. Negative values in exp_data are ignored as well as non-positive weight_factors. All arrays involved in the computation must be of the same size.
-
-Parameters:
------------
-
-sim_data:
-array with simulated intensities.
-
-exp_data:
-array with intensity values obtained from an experiment.
-
-weight_factors:
-user-defined weighting factors. Used linearly, no matter which norm is chosen.
-";
-
// File: classRoughMultiLayerComputation.xml
%feature("docstring") RoughMultiLayerComputation "
@@ -2309,49 +2235,49 @@ Returns default units to convert to.
";
-// File: namespace_0d15.xml
+// File: namespace_0D15.xml
-// File: namespace_0d19.xml
+// File: namespace_0D19.xml
-// File: namespace_0d27.xml
+// File: namespace_0D27.xml
-// File: namespace_0d35.xml
+// File: namespace_0D35.xml
-// File: namespace_0d40.xml
+// File: namespace_0D40.xml
-// File: namespace_0d49.xml
+// File: namespace_0D49.xml
-// File: namespace_0d51.xml
+// File: namespace_0D51.xml
-// File: namespace_0d55.xml
+// File: namespace_0D55.xml
-// File: namespace_0d57.xml
+// File: namespace_0D57.xml
-// File: namespace_0d62.xml
+// File: namespace_0D62.xml
-// File: namespace_0d64.xml
+// File: namespace_0D64.xml
-// File: namespace_0d68.xml
+// File: namespace_0D68.xml
-// File: namespace_0d78.xml
+// File: namespace_0D78.xml
-// File: namespace_0d80.xml
+// File: namespace_0D80.xml
-// File: namespace_0d86.xml
+// File: namespace_0D86.xml
// File: namespaceExportToPython.xml
diff --git a/auto/Wrap/doxygenDevice.i b/auto/Wrap/doxygenDevice.i
index c633ce26a5d..d8f8115e0fb 100644
--- a/auto/Wrap/doxygenDevice.i
+++ b/auto/Wrap/doxygenDevice.i
@@ -1560,9 +1560,7 @@ init detector with beam settings
// File: classIntensityDataIOFactory.xml
%feature("docstring") IntensityDataIOFactory "
-Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth \"*.gz\" or \"*.bz2\" the file will be zipped on the fly using appropriate algorithm.
-
-Usage:
+Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth \"*.gz\" or \"*.bz2\" the file will be zipped on the fly using appropriate algorithm. Usage:
C++ includes: IntensityDataIOFactory.h
";
@@ -2355,7 +2353,7 @@ Sets concrete writing strategy.
// File: classPolygon.xml
%feature("docstring") Polygon "
-A polygon in 2D space. Polygon defined by two arrays with x and y coordinates of points. Sizes of arrays should coincide. If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically.
+A polygon in 2D space.Polygon defined by two arrays with x and y coordinates of points. Sizes of arrays should coincide. If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically.
C++ includes: Polygon.h
";
@@ -3161,22 +3159,22 @@ Returns true if area defined by two bins is inside or on border of polygon (more
// File: classConvolve_1_1Workspace.xml
-// File: namespace_0d113.xml
+// File: namespace_0D113.xml
-// File: namespace_0d33.xml
+// File: namespace_0D33.xml
-// File: namespace_0d56.xml
+// File: namespace_0D56.xml
-// File: namespace_0d58.xml
+// File: namespace_0D58.xml
-// File: namespace_0d62.xml
+// File: namespace_0D62.xml
-// File: namespace_0d68.xml
+// File: namespace_0D68.xml
// File: namespaceArrayUtils.xml
diff --git a/auto/Wrap/doxygenFit.i b/auto/Wrap/doxygenFit.i
index f50cfe66019..a7ba6b7d2ba 100644
--- a/auto/Wrap/doxygenFit.i
+++ b/auto/Wrap/doxygenFit.i
@@ -3344,9 +3344,13 @@ Copy constructor for functor based on ROOT::Math::IMultiGenFunction
";
%feature("docstring") ROOT::Math::Functor::Clone "ImplBase* ROOT::Math::Functor::Clone() const
+
+Clone a function. Each derived class must implement their version of the Clone method
";
%feature("docstring") ROOT::Math::Functor::NDim "unsigned int ROOT::Math::Functor::NDim() const
+
+Retrieve the dimension of the function
";
@@ -3534,7 +3538,7 @@ C++ includes: GenericFunction.h
// File: classTMVA_1_1GeneticAlgorithm.xml
%feature("docstring") TMVA::GeneticAlgorithm "";
-%feature("docstring") TMVA::GeneticAlgorithm::GeneticAlgorithm "TMVA::GeneticAlgorithm::GeneticAlgorithm(IFitterTarget &target, Int_t populationSize, const std::vector< TMVA::Interval * > &ranges, UInt_t seed=0)
+%feature("docstring") TMVA::GeneticAlgorithm::GeneticAlgorithm "TMVA::GeneticAlgorithm::GeneticAlgorithm(IFitterTarget &target, Int_t populationSize, const std::vector< TMVA::Interval *> &ranges, UInt_t seed=0)
";
%feature("docstring") TMVA::GeneticAlgorithm::~GeneticAlgorithm "virtual TMVA::GeneticAlgorithm::~GeneticAlgorithm()
@@ -3785,7 +3789,7 @@ Returns map of string representing different minimizer statuses.
// File: classTMVA_1_1GeneticPopulation.xml
%feature("docstring") TMVA::GeneticPopulation "";
-%feature("docstring") TMVA::GeneticPopulation::GeneticPopulation "TMVA::GeneticPopulation::GeneticPopulation(const std::vector< TMVA::Interval * > &ranges, Int_t size, UInt_t seed=0)
+%feature("docstring") TMVA::GeneticPopulation::GeneticPopulation "TMVA::GeneticPopulation::GeneticPopulation(const std::vector< TMVA::Interval *> &ranges, Int_t size, UInt_t seed=0)
";
%feature("docstring") TMVA::GeneticPopulation::~GeneticPopulation "virtual TMVA::GeneticPopulation::~GeneticPopulation()
@@ -5438,11 +5442,6 @@ Evaluate all the vector of function derivatives (gradient) at a point x. Derived
Optimized method to evaluate at the same time the function value and derivative at a point x. Often both value and derivatives are needed and it is often more efficient to compute them at the same time. Derived class should implement this method if performances play an important role and if it is faster to evaluate value and derivative at the same time
";
-%feature("docstring") ROOT::Math::IGradientFunctionMultiDimTempl::NDim "virtual unsigned int ROOT::Math::IBaseFunctionMultiDimTempl< T >::NDim() const=0
-
-Retrieve the dimension of the function
-";
-
// File: classROOT_1_1Math_1_1IGradientFunctionOneDim.xml
%feature("docstring") ROOT::Math::IGradientFunctionOneDim "
@@ -5957,7 +5956,7 @@ Evaluate partial derivative using cached parameter values (multi-dim like interf
The Kahan compensate summation algorithm significantly reduces the numerical error in the total obtained by adding a sequence of finite precision floating point numbers. This is done by keeping a separate running compensation (a variable to accumulate small errors).
The intial values of the result and the correction are set to the default value of the type it hass been instantiated with.
-Examples:
+ ####Examples:
C++ includes: Util.h
";
@@ -7976,73 +7975,19 @@ C++ includes: MinuitParameter.h
// File: classROOT_1_1Math_1_1MixMaxEngine.xml
%feature("docstring") ROOT::Math::MixMaxEngine "
-MixMaxEngine is a wrapper class for the MIXMAX Random number generator.
- MIXMAX is a matrix-recursive random number generator introduced by
- G. Savvidy.
+MixMaxEngine is a wrapper class for the MIXMAX Random number generator. MIXMAX is a matrix-recursive random number generator introduced by G. Savvidy.
-The real implementation of the generator, written in C, is in the mixmax.h and mixmax.cxx files.
- This generator code is available also at hepforge: http://mixmax.hepforge.org
- The MIXMAX code has been created and developed by Konstantin Savvidy and it is
- released under GNU Lesser General Public License v3.
+The real implementation of the generator, written in C, is in the mixmax.h and mixmax.cxx files. This generator code is available also at hepforge: http://mixmax.hepforge.org The MIXMAX code has been created and developed by Konstantin Savvidy and it is released under GNU Lesser General Public License v3.
-This wrapper class provides 3 different variants of MIXMAX according to the template para extra parameter N.
- The extra parameter, `SkipNumber`, is used to perform additional iterations of the generator before returning the random numbers.
- For example, when `SkipNumber = 2`, the generator will have two extra iterations that will be discarder.
+This wrapper class provides 3 different variants of MIXMAX according to the template para extra parameter N. The extra parameter, SkipNumber, is used to perform additional iterations of the generator before returning the random numbers. For example, when SkipNumber = 2, the generator will have two extra iterations that will be discarder.
-MIXMAX with N = 240. This is a new version of the generator (version 2.0beta) described in the
- <a href=\"http://dx.doi.org/10.1016/j.chaos.2016.05.003\">2016 paper</a> (3rd reference), with
- special number $s=487013230256099140$, $m=2^{51}+1$ and having a period of $10^{4389}$.
+MIXMAX with N = 240. This is a new version of the generator (version 2.0beta) described in the 2016 paper (3rd reference), with special number $s=487013230256099140$, $m=2^{51}+1$ and having a period of $10^{4389}$.
MIXMAX with N = 17, from the 2.0beta version with $s=0$ and $m=2^{36}+1$. The period of the generator is $10^{294}$.
-MIXMAX with N = 256 from the 1.0 version. The period is (for `SkipNumber=0`) $10^{4682}$.
- For this generator we recommend in ROOT using a default value of `SkipNumber=2, while for the previous two generators
- skipping is not needed.
-
-This table describes the properties of the MIXMAX generators. MIXMAX is a genuine 61 bit generator on the Galois field GF[p], where
- $p=2^{61}-1$ is the Mersenne prime number.
- The MIXMAX generators with these parameters pass all of the BigCrush
- tests in the <a href=\"http://simul.iro.umontreal.ca/testu01/tu01.html\">TestU01 suite</a\\\\>.
-
-\\\\begin{table}[h]
- \\\\centering
- \\\\begin{tabular}{@{} rrlcrr @{}}
-
- \\\\toprule
- Dimension &~ Entropy & Decorrelation Time & Iteration Time & Relaxation Time &Period q\\\\\\\\
- N &~~ $~h(T)$ &~~~ $\\\\tau_0 = {1\\\\over h(T) 2N }$ & t & $\\\\tau ={1\\\\over h(T) \\\\ln {1\\\\over \\\\delta v_0}}$ & $ \\\\log_{10} (q)$ \\\\\\\\ % Crush
- \\\\midrule
- 256 & 194 & ~~~~~0.000012 & 1 & 95.00 & 4682\\\\footnote{full
- period is not confirmed} \\\\\\\\
- \\\\hline
- 8 & 220 & $~~~~~0.00028$ & 1 & 1.54 & 129 \\\\\\\\
- 17 & 374 & ~~~~~0.000079 & 1 & 1.92 & 294 \\\\\\\\
- 240 & 8679 & ~~~~~0.00000024 & 1 & 1.17 & 4389 \\\\\\\\
- \\\\bottomrule
- \\\\end{tabular}
- \\\\caption{The entropy $h(T)$, decorrelation time $\\\\tau_0$
- decorrelation time, relaxation time $\\\\tau $ and period of the MIXMAX generator
- \\\\cite{savvidy2017ex,savvidy2017cl},
- expressed in units of the iteration time $t$, which is
- normalised to 1.
- Clearly $\\\\tau_0~ < t ~< \\\\tau $.
-}
-\\\\end{table}
- The References for MIXMAX are
-
-G.K.Savvidy and N.G.Ter-Arutyunian, *On the Monte Carlo simulation of physical systems,
- J.Comput.Phys. 97, 566 (1991)*;
- Preprint EPI-865-16-86, Yerevan, Jan. 1986
-
-K.Savvidy, *The MIXMAX random number generator*,
- Comp. Phys. Commun. 196 (2015), pp 161–165
- http://dx.doi.org/10.1016/j.cpc.2015.06.003
-
-K.Savvidy and G.Savvidy, *Spectrum and Entropy of C-systems MIXMAX Random Number Generator*,
- Chaos, Solitons & Fractals, Volume 91, (2016) pp. 33–38
- http://dx.doi.org/10.1016/j.chaos.2016.05.003
-
-@ingroup Random
+MIXMAX with N = 256 from the 1.0 version. The period is (for SkipNumber=0) $10^{4682}$. For this generator we recommend in ROOT using a default value of `SkipNumber=2, while for the previous two generators skipping is not needed.
+
+This table describes the properties of the MIXMAX generators. MIXMAX is a genuine 61 bit generator on the Galois field GF[p], where $p=2^{61}-1$ is the Mersenne prime number. The MIXMAX generators with these parameters pass all of the BigCrush tests in the TestU01 suite</a>. The References for MIXMAX are G.K.Savvidy and N.G.Ter-Arutyunian, *On the Monte Carlo simulation of physical systems, J.Comput.Phys. 97, 566 (1991)*; Preprint EPI-865-16-86, Yerevan, Jan. 1986 K.Savvidy, *The MIXMAX random number generator*, Comp. Phys. Commun. 196 (2015), pp 161–165 http://dx.doi.org/10.1016/j.cpc.2015.06.003 K.Savvidy and G.Savvidy, *Spectrum and Entropy of C-systems MIXMAX Random Number Generator*, Chaos, Solitons & Fractals, Volume 91, (2016) pp. 33–38 http://dx.doi.org/10.1016/j.chaos.2016.05.003@endverbatim
C++ includes: MixMaxEngine.h
";
@@ -8660,14 +8605,14 @@ override Minuit's own determination
";
-// File: classROOT_1_1Minuit2_1_1BasicMinimumError_1_1MnMadePosDef.xml
-%feature("docstring") ROOT::Minuit2::BasicMinimumError::MnMadePosDef "";
-
-
// File: classROOT_1_1Minuit2_1_1MinimumError_1_1MnMadePosDef.xml
%feature("docstring") ROOT::Minuit2::MinimumError::MnMadePosDef "";
+// File: classROOT_1_1Minuit2_1_1BasicMinimumError_1_1MnMadePosDef.xml
+%feature("docstring") ROOT::Minuit2::BasicMinimumError::MnMadePosDef "";
+
+
// File: classROOT_1_1Minuit2_1_1MnMigrad.xml
%feature("docstring") ROOT::Minuit2::MnMigrad "
@@ -8871,14 +8816,14 @@ ask for MinosError (Lower + Upper) can be printed via std::cout
";
-// File: classROOT_1_1Minuit2_1_1MinimumError_1_1MnNotPosDef.xml
-%feature("docstring") ROOT::Minuit2::MinimumError::MnNotPosDef "";
-
-
// File: classROOT_1_1Minuit2_1_1BasicMinimumError_1_1MnNotPosDef.xml
%feature("docstring") ROOT::Minuit2::BasicMinimumError::MnNotPosDef "";
+// File: classROOT_1_1Minuit2_1_1MinimumError_1_1MnNotPosDef.xml
+%feature("docstring") ROOT::Minuit2::MinimumError::MnNotPosDef "";
+
+
// File: classROOT_1_1Minuit2_1_1MnParabola.xml
%feature("docstring") ROOT::Minuit2::MnParabola "
@@ -12100,12 +12045,6 @@ C++ includes: PlanCases.h
%feature("docstring") TRandom2::SetSeed "virtual void TRandom2::SetSeed(ULong_t seed=0)
";
-%feature("docstring") TRandom2::Rndm "virtual Double_t TRandom::Rndm()
-";
-
-%feature("docstring") TRandom2::Rndm "virtual Double_t TRandom::Rndm(Int_t)
-";
-
// File: classTRandom3.xml
%feature("docstring") TRandom3 "";
@@ -12131,12 +12070,6 @@ C++ includes: PlanCases.h
%feature("docstring") TRandom3::SetSeed "virtual void TRandom3::SetSeed(ULong_t seed=0)
";
-%feature("docstring") TRandom3::Rndm "virtual Double_t TRandom::Rndm()
-";
-
-%feature("docstring") TRandom3::Rndm "virtual Double_t TRandom::Rndm(Int_t)
-";
-
// File: classROOT_1_1Math_1_1TRandomEngine.xml
%feature("docstring") ROOT::Math::TRandomEngine "";
@@ -12175,8 +12108,6 @@ When the data are copying in the number of points can be set later (or re-set) u
the data are inserted one by one using the Add method.
It is mandatory to set the size before using the Add method.
-@ingroup FitData
-
C++ includes: UnBinData.h
";
@@ -12522,12 +12453,14 @@ Constructor a wrapped function from a pointer to a callable object, the function
%feature("docstring") ROOT::Math::WrappedParamFunction::WrappedParamFunction "ROOT::Math::WrappedParamFunction< FuncPtr >::WrappedParamFunction(FuncPtr func, unsigned int dim, Iterator begin, Iterator end)
-Constructor a wrapped function from a pointer to a callable object, the function dimension and an iterator specifying begin and end of parameters
+Constructor a wrapped function from a non-const pointer to a callable object, the function dimension and number of parameters which are set to zero by default This constructor is needed in the case FuncPtr is a std::unique_ptr which has a copy ctor taking non const objects Constructor a wrapped function from a pointer to a callable object, the function dimension and an iterator specifying begin and end of parameters
";
%feature("docstring") ROOT::Math::WrappedParamFunction::Clone "IMultiGenFunction* ROOT::Math::WrappedParamFunction< FuncPtr >::Clone() const
-clone the function
+clone the function
+
+Constructor a wrapped function from a non - const pointer to a callable object, the function dimension and an iterator specifying begin and end of parameters. This constructor is needed in the case FuncPtr is a std::unique_ptr which has a copy ctor taking non const objects
";
%feature("docstring") ROOT::Math::WrappedParamFunction::Parameters "const double* ROOT::Math::WrappedParamFunction< FuncPtr >::Parameters() const
@@ -12606,43 +12539,45 @@ Return the number of Parameters
";
%feature("docstring") ROOT::Math::WrappedParamFunctionGen::NDim "unsigned int ROOT::Math::WrappedParamFunctionGen< FuncPtr >::NDim() const
+
+Retrieve the dimension of the function
";
-// File: namespace_0d201.xml
+// File: namespace_0D201.xml
-// File: namespace_0d203.xml
+// File: namespace_0D203.xml
-// File: namespace_0d211.xml
+// File: namespace_0D211.xml
-// File: namespace_0d215.xml
+// File: namespace_0D215.xml
-// File: namespace_0d217.xml
+// File: namespace_0D217.xml
-// File: namespace_0d229.xml
+// File: namespace_0D229.xml
-// File: namespace_0d243.xml
+// File: namespace_0D243.xml
-// File: namespace_0d245.xml
+// File: namespace_0D245.xml
-// File: namespace_0d253.xml
+// File: namespace_0D253.xml
-// File: namespace_0d263.xml
+// File: namespace_0D263.xml
-// File: namespace_0d280.xml
+// File: namespace_0D280.xml
-// File: namespace_0d65.xml
+// File: namespace_0D65.xml
// File: namespaceMath.xml
diff --git a/auto/Wrap/doxygenParam.i b/auto/Wrap/doxygenParam.i
index 7e738f3bada..31b26b87f77 100644
--- a/auto/Wrap/doxygenParam.i
+++ b/auto/Wrap/doxygenParam.i
@@ -1038,7 +1038,7 @@ C++ includes: NodeIterator.h
%feature("docstring") IteratorState::IteratorState "IteratorState::IteratorState(const INode *single_element)
";
-%feature("docstring") IteratorState::IteratorState "IteratorState::IteratorState(std::vector< const INode * > samples)
+%feature("docstring") IteratorState::IteratorState "IteratorState::IteratorState(std::vector< const INode *> samples)
";
%feature("docstring") IteratorState::~IteratorState "virtual IteratorState::~IteratorState()
@@ -1235,7 +1235,7 @@ Returns number of parameters in the pool.
Adds parameter to the pool, and returns reference to the input pointer.
-Returning the input pointer allows us to concatenate function calls like pool->addParameter( new RealParameter(...) ).setLimits(-1,+1).setFixed().setUnit(\"nm\")
+Returning the input pointer allows us to concatenate function calls like pool->addParameter( new RealParameter(...) ).setLimits(-1,+1).setFixed().setUnit(\"nm\")
";
%feature("docstring") ParameterPool::parameter "RealParameter * ParameterPool::parameter(const std::string &name)
@@ -1582,16 +1582,16 @@ C++ includes: Unit.h
";
-// File: namespace_0d10.xml
+// File: namespace_0D10.xml
-// File: namespace_0d14.xml
+// File: namespace_0D14.xml
-// File: namespace_0d24.xml
+// File: namespace_0D24.xml
-// File: namespace_0d29.xml
+// File: namespace_0D29.xml
// File: namespaceNodeUtils.xml
diff --git a/auto/Wrap/doxygenSample.i b/auto/Wrap/doxygenSample.i
index a9dc98b810d..e2b889088f7 100644
--- a/auto/Wrap/doxygenSample.i
+++ b/auto/Wrap/doxygenSample.i
@@ -5040,7 +5040,7 @@ Returns lateral correlation length.
// File: classLayersWithAbsorptionBuilder.xml
%feature("docstring") LayersWithAbsorptionBuilder "
-The LayersWithAbsorptionBuilder class generates a multilayer with 3 layers with absorption (refractive index has imaginary part). The middle layer is populated with particles. Requires IComponentService which generates form factors, used for bulk form factors testing.
+The LayersWithAbsorptionBuilder class generates a multilayer with 3 layers with absorption (refractive index has imaginary part).The middle layer is populated with particles. Requires IComponentService which generates form factors, used for bulk form factors testing.
C++ includes: LayersWithAbsorptionBuilder.h
";
@@ -5695,7 +5695,7 @@ Indicates if the peak shape encodes angular disorder, in which case all peaks in
// File: classMultiLayer.xml
%feature("docstring") MultiLayer "
-Our sample model: a stack of layers one below the other. Example of system of 4 layers (3 interfaces):
+Our sample model: a stack of layers one below the other.Example of system of 4 layers (3 interfaces):
ambience layer #0 ------ interface #0 z=0.0 Fe, 20A layer #1 ------ interface #1 z=-20.0 Cr, 40A layer #2 ------ interface #2 z=-60.0 substrate layer #3
@@ -7618,124 +7618,124 @@ C++ includes: ZLimits.h
";
-// File: namespace_0d122.xml
+// File: namespace_0D122.xml
-// File: namespace_0d125.xml
+// File: namespace_0D125.xml
-// File: namespace_0d149.xml
+// File: namespace_0D149.xml
-// File: namespace_0d153.xml
+// File: namespace_0D153.xml
-// File: namespace_0d157.xml
+// File: namespace_0D157.xml
-// File: namespace_0d16.xml
+// File: namespace_0D16.xml
-// File: namespace_0d167.xml
+// File: namespace_0D167.xml
-// File: namespace_0d169.xml
+// File: namespace_0D169.xml
-// File: namespace_0d171.xml
+// File: namespace_0D171.xml
-// File: namespace_0d181.xml
+// File: namespace_0D181.xml
-// File: namespace_0d2.xml
+// File: namespace_0D2.xml
-// File: namespace_0d201.xml
+// File: namespace_0D201.xml
-// File: namespace_0d203.xml
+// File: namespace_0D203.xml
-// File: namespace_0d205.xml
+// File: namespace_0D205.xml
-// File: namespace_0d210.xml
+// File: namespace_0D210.xml
-// File: namespace_0d212.xml
+// File: namespace_0D212.xml
-// File: namespace_0d222.xml
+// File: namespace_0D222.xml
-// File: namespace_0d236.xml
+// File: namespace_0D236.xml
-// File: namespace_0d241.xml
+// File: namespace_0D241.xml
-// File: namespace_0d25.xml
+// File: namespace_0D25.xml
-// File: namespace_0d259.xml
+// File: namespace_0D259.xml
-// File: namespace_0d267.xml
+// File: namespace_0D267.xml
-// File: namespace_0d277.xml
+// File: namespace_0D277.xml
-// File: namespace_0d279.xml
+// File: namespace_0D279.xml
-// File: namespace_0d281.xml
+// File: namespace_0D281.xml
-// File: namespace_0d283.xml
+// File: namespace_0D283.xml
-// File: namespace_0d285.xml
+// File: namespace_0D285.xml
-// File: namespace_0d289.xml
+// File: namespace_0D289.xml
-// File: namespace_0d291.xml
+// File: namespace_0D291.xml
-// File: namespace_0d295.xml
+// File: namespace_0D295.xml
-// File: namespace_0d307.xml
+// File: namespace_0D307.xml
-// File: namespace_0d31.xml
+// File: namespace_0D31.xml
-// File: namespace_0d313.xml
+// File: namespace_0D313.xml
-// File: namespace_0d317.xml
+// File: namespace_0D317.xml
-// File: namespace_0d335.xml
+// File: namespace_0D335.xml
-// File: namespace_0d354.xml
+// File: namespace_0D354.xml
-// File: namespace_0d37.xml
+// File: namespace_0D37.xml
-// File: namespace_0d39.xml
+// File: namespace_0D39.xml
-// File: namespace_0d4.xml
+// File: namespace_0D4.xml
-// File: namespace_0d47.xml
+// File: namespace_0D47.xml
// File: namespacebake.xml
@@ -7803,7 +7803,7 @@ Function for calculating the reduced potential, used for obtaining the Fresnel c
%feature("docstring") MaterialUtils::MagnetizationCorrection "Eigen::Matrix2cd MaterialUtils::MagnetizationCorrection(complex_t unit_factor, double magnetic_factor, BasicVector3D< T > polarization)
";
-%feature("docstring") MaterialUtils::checkMaterialTypes "MATERIAL_TYPES MaterialUtils::checkMaterialTypes(const std::vector< const Material * > &materials)
+%feature("docstring") MaterialUtils::checkMaterialTypes "MATERIAL_TYPES MaterialUtils::checkMaterialTypes(const std::vector< const Material *> &materials)
Checks if all non-default materials in materials are of the same type and returns this type. If several types of materials are involved, InvalidMaterialType identifier is returned.
";
diff --git a/auto/Wrap/libBornAgainDevice.py b/auto/Wrap/libBornAgainDevice.py
index 0af965feaa2..1ca03058809 100644
--- a/auto/Wrap/libBornAgainDevice.py
+++ b/auto/Wrap/libBornAgainDevice.py
@@ -3398,7 +3398,7 @@ class Polygon(IShape2D):
r"""
- A polygon in 2D space. Polygon defined by two arrays with x and y coordinates of points. Sizes of arrays should coincide. If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically.
+ A polygon in 2D space.Polygon defined by two arrays with x and y coordinates of points. Sizes of arrays should coincide. If polygon is unclosed (the last point doesn't repeat the first one), it will be closed automatically.
C++ includes: Polygon.h
@@ -5949,9 +5949,7 @@ class IntensityDataIOFactory(object):
r"""
- Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth "*.gz" or "*.bz2" the file will be zipped on the fly using appropriate algorithm.
-
- Usage:
+ Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth "*.gz" or "*.bz2" the file will be zipped on the fly using appropriate algorithm. Usage:
C++ includes: IntensityDataIOFactory.h
@@ -5995,9 +5993,7 @@ class IntensityDataIOFactory(object):
__init__(IntensityDataIOFactory self) -> IntensityDataIOFactory
- Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth "*.gz" or "*.bz2" the file will be zipped on the fly using appropriate algorithm.
-
- Usage:
+ Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth "*.gz" or "*.bz2" the file will be zipped on the fly using appropriate algorithm. Usage:
C++ includes: IntensityDataIOFactory.h
diff --git a/auto/Wrap/libBornAgainDevice_wrap.cpp b/auto/Wrap/libBornAgainDevice_wrap.cpp
index f46ca1ba0d5..409a15b1937 100644
--- a/auto/Wrap/libBornAgainDevice_wrap.cpp
+++ b/auto/Wrap/libBornAgainDevice_wrap.cpp
@@ -48651,9 +48651,7 @@ static PyMethodDef SwigMethods[] = {
"new_IntensityDataIOFactory() -> IntensityDataIOFactory\n"
"\n"
"\n"
- "Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth \"*.gz\" or \"*.bz2\" the file will be zipped on the fly using appropriate algorithm.\n"
- "\n"
- "Usage:\n"
+ "Provides users with possibility to read and write IntensityData from/to files in different format. Type of the file will be deduced from file name. *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy. *.int - BornAgain internal ASCII format. *.tif - 32-bits tiff file. If file name ends woth \"*.gz\" or \"*.bz2\" the file will be zipped on the fly using appropriate algorithm. Usage:\n"
"\n"
"C++ includes: IntensityDataIOFactory.h\n"
"\n"
diff --git a/auto/Wrap/libBornAgainParam.py b/auto/Wrap/libBornAgainParam.py
index 02bc6f19283..af1d487e80f 100644
--- a/auto/Wrap/libBornAgainParam.py
+++ b/auto/Wrap/libBornAgainParam.py
@@ -2793,7 +2793,7 @@ class ParameterPool(libBornAgainBase.ICloneable):
Adds parameter to the pool, and returns reference to the input pointer.
- Returning the input pointer allows us to concatenate function calls like pool->addParameter( new RealParameter(...) ).setLimits(-1,+1).setFixed().setUnit("nm")
+ Returning the input pointer allows us to concatenate function calls like pool->addParameter( new RealParameter(...) ).setLimits(-1,+1).setFixed().setUnit("nm")
"""
return _libBornAgainParam.ParameterPool_addParameter(self, newPar)
diff --git a/auto/Wrap/libBornAgainParam_wrap.cpp b/auto/Wrap/libBornAgainParam_wrap.cpp
index c166237eb9f..0455f1ab2e5 100644
--- a/auto/Wrap/libBornAgainParam_wrap.cpp
+++ b/auto/Wrap/libBornAgainParam_wrap.cpp
@@ -50769,7 +50769,7 @@ static PyMethodDef SwigMethods[] = {
"\n"
"Adds parameter to the pool, and returns reference to the input pointer.\n"
"\n"
- "Returning the input pointer allows us to concatenate function calls like pool->addParameter( new RealParameter(...) ).setLimits(-1,+1).setFixed().setUnit(\"nm\") \n"
+ "Returning the input pointer allows us to concatenate function calls like pool->addParameter( new RealParameter(...) ).setLimits(-1,+1).setFixed().setUnit(\"nm\") \n"
"\n"
""},
{ "ParameterPool_parameter", _wrap_ParameterPool_parameter, METH_VARARGS, "\n"
diff --git a/auto/Wrap/libBornAgainSample.py b/auto/Wrap/libBornAgainSample.py
index 8c183344e7b..0e749a7562b 100644
--- a/auto/Wrap/libBornAgainSample.py
+++ b/auto/Wrap/libBornAgainSample.py
@@ -8376,7 +8376,7 @@ class MultiLayer(ISample):
r"""
- Our sample model: a stack of layers one below the other. Example of system of 4 layers (3 interfaces):
+ Our sample model: a stack of layers one below the other.Example of system of 4 layers (3 interfaces):
ambience layer #0 ------ interface #0 z=0.0 Fe, 20A layer #1 ------ interface #1 z=-20.0 Cr, 40A layer #2 ------ interface #2 z=-60.0 substrate layer #3
--
GitLab