Changes attributes to parameters

Author: StephenNneji

cpp/includes/defines.h

@@ -11,7 +11,7 @@ const std::string docsProgressEventData = R"(The Python binding for the C++ prog
 The progress event shows the percentage completion for the calculation. This can be emitted by 
 the DREAM algorithm only.
 
-Attributes
+Parameters
 ----------
 message : str
     The title text for the event.
@@ -29,7 +29,7 @@ const std::string docsPlotEventData = R"(The Python binding for the C++ plotEven
 The plot event data contains intermediate results from the calculation. This can be emitted 
 by the Simplex and DE algorithms only.
 
-Attributes
+Parameters
 ----------
 reflectivity : list
     The reflectivity curves for each contrast, with the same range as the data 
@@ -78,7 +78,7 @@ with five rows. The rows represent:
 - 3: the 65th percentile;
 - 4: the 95th percentile.
 
-Attributes
+Parameters
 ----------
 reflectivity : list
     The prediction interval data for reflectivity of each contrast.
@@ -98,7 +98,7 @@ struct PredictionIntervals
 const std::string docsConfidenceIntervals = R"(The Python binding for the C++ confidenceIntervals struct. 
 The 65% and 95% confidence intervals for the best fit results.
 
-Attributes
+Parameters
 ----------
 percentile95 : np.ndarray[np.float]
     The 95% confidence intervals for each fit parameter.
@@ -118,7 +118,7 @@ struct ConfidenceIntervals
 const std::string docsNestedSamplerOutput = R"(The Python binding for the C++ nestedSamplerOutput struct. 
 The output information from the Nested Sampler (ns).
 
-Attributes
+Parameters
 ----------
 logZ : float
     The natural logarithm of the evidence Z for the parameter values.
@@ -146,7 +146,7 @@ struct NestedSamplerOutput
 const std::string docsDreamParams = R"(The Python binding for the C++ dreamParams struct. 
 The parameters used by the inner DREAM algorithm.
 
-Attributes
+Parameters
 ----------
 nParams : float
     The number of parameters used by the algorithm.
@@ -217,7 +217,7 @@ struct DreamParams
 const std::string docsDreamOutput = R"(The Python binding for the C++ DreamOutput struct. 
 The diagnostic output information from DREAM.
 
-Attributes
+Parameters
 ----------
 allChains : np.ndarray[np.float]
     An ``nGenerations`` x ``nParams + 2`` x ``nChains`` size array,
@@ -268,7 +268,7 @@ struct DreamOutput
 const std::string docsBayesResults = R"(The Python binding for the C++ bayesResults struct. 
 The results of a Bayesian RAT calculation.
 
-Attributes
+Parameters
 ----------
 predictionIntervals : RATapi.rat_core.orePredictionIntervals
     The prediction intervals.
@@ -298,7 +298,7 @@ struct BayesResults
 const std::string docsCalculation = R"(The Python binding for the C++ calculationResult struct.
 The goodness of fit from the Abeles calculation.
 
-Attributes
+Parameters
 ----------
 chiValues : np.ndarray[np.float]
     The chi-squared value for each contrast.
@@ -315,7 +315,7 @@ struct Calculation
 const std::string docsContrastParams = R"(The Python binding for the C++ contrastParams struct.
 The experimental parameters for each contrast.
 
-Attributes
+Parameters
 ----------
 scalefactors : np.ndarray[np.float]
     The scalefactor values for each contrast.
@@ -340,7 +340,7 @@ struct ContrastParams
 
 const std::string docsOutputResult = R"(The C++ result struct of a RAT calculation.
 
-Attributes
+Parameters
 ----------
 reflectivity : list
     The reflectivity curves for each contrast, with the same range as the data 
@@ -389,7 +389,7 @@ struct OutputResult {
 const std::string docsPriors = R"(The Python binding for the C++ priors struct.
 The priors for each parameter defined in the project.
 
-Attributes
+Parameters
 ----------
 params : list 
     Priors for params in the problem definition.
@@ -431,7 +431,7 @@ struct Priors
 const std::string docsLimits = R"(The Python binding for the C++ limit struct which contains
 Min and max values for each parameter defined in the project.
 
-Attributes
+Parameters
 ----------
 params : np.ndarray[np.float] 
     Limits for params in the problem definition.
@@ -465,7 +465,7 @@ struct Limits {
 const std::string docsNameStore = R"(The Python binding for the C++ names struct which 
 contains names of all parameters in the project.
 
-Attributes
+Parameters
 ----------
 params : list 
     Names of params in the problem definition.
@@ -501,7 +501,7 @@ struct NameStore {
 const std::string docsChecks = R"(The Python binding for the C++ checks struct which contains 
 flags indicating which parameters should be fitted in the project.
 
-Attributes
+Parameters
 ----------
 params : np.ndarray[np.float] 
     Non-zero values indicates which params is fitted.
@@ -534,7 +534,7 @@ struct Checks {
 
 const std::string docsProblemDefinition = R"(The Python binding for the C++ problem struct.
 
-Attributes
+Parameters
 ----------
 TF : str
     The target function for the calculation which can be 'normal' or 'domains'.
@@ -673,7 +673,7 @@ struct ProblemDefinition {
 
 const std::string docsControl = R"(The Python binding for the C++ controls struct.
 
-Attributes
+Parameters
 ----------
 parallel : str
     How the calculation should be parallelised (This uses the Parallel Computing Toolbox). Can be 'single', 'contrasts' or 'points'.