From 65d6666d74fce11bff843fb697e4bd84ba899887 Mon Sep 17 00:00:00 2001
From: Olivier Couet <olivier.couet@cern.ch>
Date: Tue, 20 Dec 2016 09:35:03 +0100
Subject: [PATCH] - Doxygen format - in group TMVA - remove trailing spaces -
spell check
---
tmva/tmva/inc/TMVA/PDEFoamCell.h | 4 +-
.../inc/TMVA/PDEFoamDecisionTreeDensity.h | 2 +-
tmva/tmva/src/PDEFoamCell.cxx | 8 ++-
tmva/tmva/src/PDEFoamDecisionTree.cxx | 42 ++++++------
tmva/tmva/src/PDEFoamDecisionTreeDensity.cxx | 17 +++--
tmva/tmva/src/PDEFoamDensityBase.cxx | 65 +++++++++----------
tmva/tmva/src/PDEFoamDiscriminant.cxx | 28 ++++----
7 files changed, 82 insertions(+), 84 deletions(-)
diff --git a/tmva/tmva/inc/TMVA/PDEFoamCell.h b/tmva/tmva/inc/TMVA/PDEFoamCell.h
index 3c5e52eae51..a0dd727749a 100644
--- a/tmva/tmva/inc/TMVA/PDEFoamCell.h
+++ b/tmva/tmva/inc/TMVA/PDEFoamCell.h
@@ -9,7 +9,7 @@
* *
* Description: *
* Objects of this class are hyperrectangular cells organized in *
- * the binary tree. Special algoritm for encoding relalive *
+ * the binary tree. Special algoritm for encoding relative *
* positioning of the cells saves total memory allocation needed *
* for the system of cells. *
* *
@@ -110,7 +110,7 @@ namespace TMVA {
void Print(Option_t *option) const ; // Prints cell content
//--- getter and setter for user variable ---
void SetElement(TObject* fobj){ fElement = fobj; } // Set user variable
- TObject* GetElement() const { return fElement; } // Get pointer to user varibale
+ TObject* GetElement() const { return fElement; } // Get pointer to user variable
////////////////////////////////////////////////////////////////////////////
ClassDef(PDEFoamCell,2) //Single cell of FOAM
}; // end of PDEFoamCell
diff --git a/tmva/tmva/inc/TMVA/PDEFoamDecisionTreeDensity.h b/tmva/tmva/inc/TMVA/PDEFoamDecisionTreeDensity.h
index c0d33026839..f6ab9b45c12 100644
--- a/tmva/tmva/inc/TMVA/PDEFoamDecisionTreeDensity.h
+++ b/tmva/tmva/inc/TMVA/PDEFoamDecisionTreeDensity.h
@@ -61,7 +61,7 @@ namespace TMVA
PDEFoamDecisionTreeDensity(const PDEFoamDecisionTreeDensity&);
virtual ~PDEFoamDecisionTreeDensity() {}
- // returns allways 0
+ // returns always 0
virtual Double_t Density(std::vector<Double_t> &Xarg, Double_t &event_density);
// fill histograms with events found in volume
diff --git a/tmva/tmva/src/PDEFoamCell.cxx b/tmva/tmva/src/PDEFoamCell.cxx
index fa6658bf3a0..80516d07359 100644
--- a/tmva/tmva/src/PDEFoamCell.cxx
+++ b/tmva/tmva/src/PDEFoamCell.cxx
@@ -9,7 +9,7 @@
* *
* Description: *
* Objects of this class are hyperrectangular cells organized in *
- * the binary tree. Special algoritm for encoding relalive *
+ * the binary tree. Special algoritm for encoding relative *
* positioning of the cells saves total memory allocation needed *
* for the system of cells. *
* *
@@ -28,6 +28,10 @@
* (http://tmva.sourceforge.net/LICENSE) *
**********************************************************************************/
+/*! \class TMVA::PDEFoamCell
+\ingroup TMVA
+
+*/
#include "TMVA/PDEFoamCell.h"
#include "TMVA/PDEFoamVect.h"
@@ -205,7 +209,7 @@ void TMVA::PDEFoamCell::CalcVolume(void)
UInt_t TMVA::PDEFoamCell::GetDepth()
{
- // check wheter we are in the root cell
+ // check whether we are in the root cell
if (fParent == 0)
return 1;
diff --git a/tmva/tmva/src/PDEFoamDecisionTree.cxx b/tmva/tmva/src/PDEFoamDecisionTree.cxx
index eb23465c14a..0b5528fdb41 100644
--- a/tmva/tmva/src/PDEFoamDecisionTree.cxx
+++ b/tmva/tmva/src/PDEFoamDecisionTree.cxx
@@ -26,26 +26,24 @@
* (http://tmva.sourceforge.net/LICENSE) *
**********************************************************************************/
-//_____________________________________________________________________
-//
-// PDEFoamDecisionTree
-//
-// This PDEFoam variant acts like a decision tree and stores in every
-// cell the discriminant
-//
-// D = #events with given class / total number of events
-//
-// as well as the statistical error on the discriminant. It therefore
-// acts as a discriminant estimator. The decision tree-like behaviour
-// is achieved by overriding PDEFoamDiscriminant::Explore() to use a
-// decision tree-like cell splitting algorithm (given a separation
-// type).
-//
-// This PDEFoam variant should be booked together with the
-// PDEFoamDecisionTreeDensity density estimator, which returns the
-// events in a cell without sampling.
-//
-//_____________________________________________________________________
+/*! \class TMVA::PDEFoamDecisionTree
+\ingroup TMVA
+
+This PDEFoam variant acts like a decision tree and stores in every
+cell the discriminant
+
+ D = #events with given class / total number of events
+
+as well as the statistical error on the discriminant. It therefore
+acts as a discriminant estimator. The decision tree-like behaviour
+is achieved by overriding PDEFoamDiscriminant::Explore() to use a
+decision tree-like cell splitting algorithm (given a separation
+type).
+
+This PDEFoam variant should be booked together with the
+PDEFoamDecisionTreeDensity density estimator, which returns the
+events in a cell without sampling.
+*/
#ifndef ROOT_TMVA_PDEFoamDecisionTree
#include "TMVA/PDEFoamDecisionTree.h"
@@ -86,7 +84,7 @@ TMVA::PDEFoamDecisionTree::PDEFoamDecisionTree()
/// - sepType - separation type used for the cell splitting (will be
/// deleted in the destructor)
///
-/// - cls - class to consider as signal when calcualting the purity
+/// - cls - class to consider as signal when calculating the purity
TMVA::PDEFoamDecisionTree::PDEFoamDecisionTree(const TString& name, SeparationBase *sepType, UInt_t cls)
: PDEFoamDiscriminant(name, cls)
@@ -125,7 +123,7 @@ TMVA::PDEFoamDecisionTree::~PDEFoamDecisionTree()
/// this routine.
///
/// Note, that according to the decision tree logic, a cell is only
-/// split, if the number of (unweighted) events in each dautghter
+/// split, if the number of (unweighted) events in each daughter
/// cell is greater than fNmin.
void TMVA::PDEFoamDecisionTree::Explore(PDEFoamCell *cell)
diff --git a/tmva/tmva/src/PDEFoamDecisionTreeDensity.cxx b/tmva/tmva/src/PDEFoamDecisionTreeDensity.cxx
index 8ef50504352..fca0767a969 100644
--- a/tmva/tmva/src/PDEFoamDecisionTreeDensity.cxx
+++ b/tmva/tmva/src/PDEFoamDecisionTreeDensity.cxx
@@ -31,14 +31,13 @@
* (http://tmva.sourceforge.net/LICENSE) *
**********************************************************************************/
-//_____________________________________________________________________
-//
-// PDEFoamDecisionTreeDensity
-//
-// This is a concrete implementation of PDEFoam. The Density(...)
-// function returns allways 0. The function FillHistograms() is
-// added, which returns all events in a given TMVA::Volume.
-// _____________________________________________________________________
+/*! \class TMVA::PDEFoamDecisionTreeDensity
+\ingroup TMVA
+
+This is a concrete implementation of PDEFoam. The Density(...)
+function returns allways 0. The function FillHistograms() is
+added, which returns all events in a given TMVA::Volume.
+*/
#include "TMVA/PDEFoamDecisionTreeDensity.h"
@@ -64,7 +63,7 @@ TMVA::PDEFoamDecisionTreeDensity::PDEFoamDecisionTreeDensity()
{}
////////////////////////////////////////////////////////////////////////////////
-/// User construcor:
+/// User constructor:
///
/// Parameters:
///
diff --git a/tmva/tmva/src/PDEFoamDensityBase.cxx b/tmva/tmva/src/PDEFoamDensityBase.cxx
index 37481c636b1..d69b618feed 100644
--- a/tmva/tmva/src/PDEFoamDensityBase.cxx
+++ b/tmva/tmva/src/PDEFoamDensityBase.cxx
@@ -31,39 +31,38 @@
* (http://tmva.sourceforge.net/LICENSE) *
**********************************************************************************/
-//_____________________________________________________________________
-//
-// PDEFoamDensityBase
-//
-// This is an abstract class, which provides an interface for a
-// PDEFoam density estimator. Derived classes have to implement the
-// Density(...) function, which returns the density of a certain
-// quantity at a given phase-space point during the foam build-up.
-//
-// Variants of PDEFoamDensityBase are:
-//
-// - PDEFoamEventDensity
-// - PDEFoamDiscriminantDensity
-// - PDEFoamTargetDensity
-// - PDEFoamDecisionTreeDensity
-//
-// Usage:
-//
-// The user has to instantiate a child class of PDEFoamDensityBase and
-// set the pointer to the owner, which is a PDEFoam object:
-//
-// PDEFoamDensityBase *dens = new MyDensity();
-// pdefoam->SetDensity(dens);
-//
-// Afterwards the binary search tree should be filled with TMVA
-// events, by either using
-//
-// pdefoam->FillBinarySearchTree(event);
-//
-// or
-//
-// dens->FillBinarySearchTree(event);
-// _____________________________________________________________________
+/*! \class TMVA::PDEFoamDensityBase
+\ingroup TMVA
+
+This is an abstract class, which provides an interface for a
+PDEFoam density estimator. Derived classes have to implement the
+Density(...) function, which returns the density of a certain
+quantity at a given phase-space point during the foam build-up.
+
+Variants of PDEFoamDensityBase are:
+
+ - PDEFoamEventDensity
+ - PDEFoamDiscriminantDensity
+ - PDEFoamTargetDensity
+ - PDEFoamDecisionTreeDensity
+
+Usage:
+
+The user has to instantiate a child class of PDEFoamDensityBase and
+set the pointer to the owner, which is a PDEFoam object:
+
+ PDEFoamDensityBase *dens = new MyDensity();
+ pdefoam->SetDensity(dens);
+
+Afterwards the binary search tree should be filled with TMVA
+events, by either using:
+
+ pdefoam->FillBinarySearchTree(event);
+
+or:
+
+ dens->FillBinarySearchTree(event);
+*/
#include "TMVA/PDEFoamDensityBase.h"
diff --git a/tmva/tmva/src/PDEFoamDiscriminant.cxx b/tmva/tmva/src/PDEFoamDiscriminant.cxx
index b7ae1e1ef7c..c5e067bc989 100644
--- a/tmva/tmva/src/PDEFoamDiscriminant.cxx
+++ b/tmva/tmva/src/PDEFoamDiscriminant.cxx
@@ -26,21 +26,19 @@
* (http://tmva.sourceforge.net/LICENSE) *
**********************************************************************************/
-//_____________________________________________________________________
-//
-// PDEFoamDiscriminant
-//
-// This PDEFoam variant stores in every cell the discriminant
-//
-// D = #events with given class / total number of events
-//
-// as well as the statistical error on the discriminant. It therefore
-// acts as a discriminant estimator. It should be booked together
-// with the PDEFoamDiscriminantDensity density estimator, which
-// returns the discriminant density at a given phase space point
-// during the foam build-up.
-//
-//_____________________________________________________________________
+/*! \class TMVA::PDEFoamDiscriminant
+\ingroup TMVA
+
+This PDEFoam variant stores in every cell the discriminant
+
+ D = #events with given class / total number of events
+
+as well as the statistical error on the discriminant. It therefore
+acts as a discriminant estimator. It should be booked together
+with the PDEFoamDiscriminantDensity density estimator, which
+returns the discriminant density at a given phase space point
+during the foam build-up.
+*/
#include "TMVA/PDEFoamDiscriminant.h"
--
GitLab