From a58a495cd19c8bd6544c4b31b83327345611efcd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Philippe=20P=C3=A9bay?= <philippe.pebay@kitware.com>
Date: Thu, 22 Mar 2012 13:13:50 +0100
Subject: [PATCH] Brought some doc up to standard
Change-Id: I77a1ae9eb899cdb4433f072db07b9a062f7b2a72
---
Infovis/vtkMultiCorrelativeStatistics.cxx | 20 ++++++++++++++------
1 file changed, 14 insertions(+), 6 deletions(-)
diff --git a/Infovis/vtkMultiCorrelativeStatistics.cxx b/Infovis/vtkMultiCorrelativeStatistics.cxx
index ada4959a44f..4fd134e2f51 100644
--- a/Infovis/vtkMultiCorrelativeStatistics.cxx
+++ b/Infovis/vtkMultiCorrelativeStatistics.cxx
@@ -612,7 +612,9 @@ void vtkMultiCorrelativeStatistics::Assess( vtkTable* inData,
{
vtkTable* reqModel = vtkTable::SafeDownCast( inMeta->GetBlock( req ) );
if ( ! reqModel )
- { // silently skip invalid entries. Note we leave assessValues column in output data even when it's empty.
+ {
+ // Silently skip invalid entries
+ // NB: The assessValues column is left in output data even when empty
continue;
}
@@ -701,8 +703,12 @@ bool vtkMultiCorrelativeAssessFunctor::Initialize( vtkTable* inData,
return false;
}
- vtksys_stl::vector<vtkDataArray*> cols; // input data columns
- vtksys_stl::vector<double*> chol; // Cholesky matrix columns. Only the lower triangle is significant.
+ // Storage for input data columns
+ vtksys_stl::vector<vtkDataArray*> cols;
+
+ // Storage for Cholesky matrix columns
+ // NB: Only the lower triangle is significant
+ vtksys_stl::vector<double*> chol;
vtkIdType m = reqModel->GetNumberOfColumns() - 2;
vtkIdType i;
for ( i = 0; i < m ; ++ i )
@@ -731,11 +737,13 @@ bool vtkMultiCorrelativeAssessFunctor::Initialize( vtkTable* inData,
this->EmptyTuple = vtksys_stl::vector<double>( m, 0. );
if ( cholesky )
{
- vtkMultiCorrelativeInvertCholesky( chol, this->Factor ); // store the inverse of chol in this->Factor, F
- vtkMultiCorrelativeTransposeTriangular( this->Factor, m ); // transposing F makes it easier to use in the () operator.
+ // Store the inverse of chol in this->Factor, F
+ vtkMultiCorrelativeInvertCholesky( chol, this->Factor );
+ // transpose F to make it easier to use in the () operator
+ vtkMultiCorrelativeTransposeTriangular( this->Factor, m );
}
#if 0
- // Compute the normalization factor to turn X * F * F' * X' into a cumulance.
+ // Compute the normalization factor to turn X * F * F' * X' into a cumulance
if ( m % 2 == 0 )
{
this->Normalization = 1.0;
--
GitLab