STYLE: Declare m_VnlOptimizer from Optimizers as unique_ptr

Also "defaulted" the destructors of those optimizer classes.
InsightSoftwareConsortium · Sep 27, 2022 · 7357008 · 7357008
1 parent 2b1b531
commit 7357008
Show file tree

Hide file tree

Showing 12 changed files with 45 additions and 79 deletions.
diff --git a/Modules/Numerics/Optimizers/include/itkAmoebaOptimizer.h b/Modules/Numerics/Optimizers/include/itkAmoebaOptimizer.h
@@ -21,6 +21,7 @@
 #include "itkSingleValuedNonLinearVnlOptimizer.h"
 #include "vnl/algo/vnl_amoeba.h"
 #include "ITKOptimizersExport.h"
+#include <memory> // For unique_ptr.
 
 namespace itk
 {
@@ -175,7 +176,7 @@ class ITKOptimizers_EXPORT AmoebaOptimizer : public SingleValuedNonLinearVnlOpti
   bool                          m_AutomaticInitialSimplex;
   ParametersType                m_InitialSimplexDelta;
   bool                          m_OptimizeWithRestarts;
-  vnl_amoeba *                  m_VnlOptimizer;
+  std::unique_ptr<vnl_amoeba>   m_VnlOptimizer;
 
   std::ostringstream m_StopConditionDescription;
 };

diff --git a/Modules/Numerics/Optimizers/include/itkConjugateGradientOptimizer.h b/Modules/Numerics/Optimizers/include/itkConjugateGradientOptimizer.h
@@ -22,6 +22,7 @@
 #include "itkSingleValuedNonLinearVnlOptimizer.h"
 #include "vnl/algo/vnl_conjugate_gradient.h"
 #include "ITKOptimizersExport.h"
+#include <memory> // For unique_ptr.
 
 namespace itk
 {
@@ -86,8 +87,8 @@ class ITKOptimizers_EXPORT ConjugateGradientOptimizer : public SingleValuedNonLi
 
 private:
   /**  The vnl optimization method for conjugate gradient. */
-  bool                    m_OptimizerInitialized;
-  InternalOptimizerType * m_VnlOptimizer;
+  bool                                   m_OptimizerInitialized;
+  std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
 };
 } // end namespace itk
 

diff --git a/Modules/Numerics/Optimizers/include/itkLBFGSBOptimizer.h b/Modules/Numerics/Optimizers/include/itkLBFGSBOptimizer.h
@@ -21,6 +21,7 @@
 #include "itkIntTypes.h"
 #include "itkSingleValuedNonLinearVnlOptimizer.h"
 #include "ITKOptimizersExport.h"
+#include <memory> // For unique_ptr.
 
 namespace itk
 {
@@ -216,10 +217,10 @@ class ITKOptimizers_EXPORT LBFGSBOptimizer : public SingleValuedNonLinearVnlOpti
   unsigned int m_CurrentIteration{ 0 };
   double       m_InfinityNormOfProjectedGradient{ 0.0 };
 
-  InternalOptimizerType * m_VnlOptimizer{ nullptr };
-  BoundValueType          m_LowerBound;
-  BoundValueType          m_UpperBound;
-  BoundSelectionType      m_BoundSelection;
+  std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
+  BoundValueType                         m_LowerBound;
+  BoundValueType                         m_UpperBound;
+  BoundSelectionType                     m_BoundSelection;
 };
 } // end namespace itk
 

diff --git a/Modules/Numerics/Optimizers/include/itkLBFGSOptimizer.h b/Modules/Numerics/Optimizers/include/itkLBFGSOptimizer.h
@@ -21,6 +21,7 @@
 #include "itkSingleValuedNonLinearVnlOptimizer.h"
 #include "vnl/algo/vnl_lbfgs.h"
 #include "ITKOptimizersExport.h"
+#include <memory> // For unique_ptr.
 
 namespace itk
 {
@@ -179,9 +180,9 @@ class ITKOptimizers_EXPORT LBFGSOptimizer : public SingleValuedNonLinearVnlOptim
   using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
 
 private:
-  bool                       m_OptimizerInitialized;
-  InternalOptimizerType *    m_VnlOptimizer;
-  mutable std::ostringstream m_StopConditionDescription;
+  bool                                   m_OptimizerInitialized;
+  std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
+  mutable std::ostringstream             m_StopConditionDescription;
 
   bool         m_Trace;
   unsigned int m_MaximumNumberOfFunctionEvaluations;

diff --git a/Modules/Numerics/Optimizers/include/itkLevenbergMarquardtOptimizer.h b/Modules/Numerics/Optimizers/include/itkLevenbergMarquardtOptimizer.h
@@ -21,6 +21,7 @@
 #include "itkMultipleValuedNonLinearVnlOptimizer.h"
 #include "vnl/algo/vnl_levenberg_marquardt.h"
 #include "ITKOptimizersExport.h"
+#include <memory> // For unique_ptr.
 
 namespace itk
 {
@@ -95,12 +96,12 @@ class ITKOptimizers_EXPORT LevenbergMarquardtOptimizer : public MultipleValuedNo
   using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
 
 private:
-  bool                    m_OptimizerInitialized;
-  InternalOptimizerType * m_VnlOptimizer;
-  unsigned int            m_NumberOfIterations;
-  double                  m_ValueTolerance;
-  double                  m_GradientTolerance;
-  double                  m_EpsilonFunction;
+  bool                                   m_OptimizerInitialized;
+  std::unique_ptr<InternalOptimizerType> m_VnlOptimizer;
+  unsigned int                           m_NumberOfIterations;
+  double                                 m_ValueTolerance;
+  double                                 m_GradientTolerance;
+  double                                 m_EpsilonFunction;
 };
 } // end namespace itk
 

diff --git a/Modules/Numerics/Optimizers/src/itkAmoebaOptimizer.cxx b/Modules/Numerics/Optimizers/src/itkAmoebaOptimizer.cxx
@@ -36,10 +36,7 @@ AmoebaOptimizer::AmoebaOptimizer()
 }
 
 
-AmoebaOptimizer::~AmoebaOptimizer()
-{
-  delete m_VnlOptimizer;
-}
+AmoebaOptimizer::~AmoebaOptimizer() = default;
 
 
 const std::string
@@ -95,7 +92,7 @@ AmoebaOptimizer::GetValue() const
 vnl_amoeba *
 AmoebaOptimizer::GetOptimizer() const
 {
-  return this->m_VnlOptimizer;
+  return this->m_VnlOptimizer.get();
 }
 
 void
@@ -150,8 +147,7 @@ AmoebaOptimizer::StartOptimization()
   CostFunctionAdaptorType * adaptor = GetNonConstCostFunctionAdaptor();
   // get rid of previous instance of the internal optimizer and create a
   // new one
-  delete m_VnlOptimizer;
-  m_VnlOptimizer = new vnl_amoeba(*adaptor);
+  m_VnlOptimizer = std::make_unique<vnl_amoeba>(*adaptor);
   m_VnlOptimizer->set_max_iterations(static_cast<int>(m_MaximumNumberOfIterations));
   m_VnlOptimizer->set_x_tolerance(m_ParametersConvergenceTolerance);
   m_VnlOptimizer->set_f_tolerance(m_FunctionConvergenceTolerance);

diff --git a/Modules/Numerics/Optimizers/src/itkConjugateGradientOptimizer.cxx b/Modules/Numerics/Optimizers/src/itkConjugateGradientOptimizer.cxx
@@ -32,18 +32,15 @@ ConjugateGradientOptimizer::ConjugateGradientOptimizer()
 /**
  * Destructor
  */
-ConjugateGradientOptimizer::~ConjugateGradientOptimizer()
-{
-  delete m_VnlOptimizer;
-}
+ConjugateGradientOptimizer::~ConjugateGradientOptimizer() = default;
 
 /**
  * Get the Optimizer
  */
 vnl_conjugate_gradient *
 ConjugateGradientOptimizer::GetOptimizer()
 {
-  return m_VnlOptimizer;
+  return m_VnlOptimizer.get();
 }
 
 /**
@@ -58,14 +55,9 @@ ConjugateGradientOptimizer::SetCostFunction(SingleValuedCostFunction * costFunct
 
   adaptor->SetCostFunction(costFunction);
 
-  if (m_OptimizerInitialized)
-  {
-    delete m_VnlOptimizer;
-  }
-
   this->SetCostFunctionAdaptor(adaptor);
 
-  m_VnlOptimizer = new vnl_conjugate_gradient(*adaptor);
+  m_VnlOptimizer = std::make_unique<vnl_conjugate_gradient>(*adaptor);
   m_OptimizerInitialized = true;
 }
 

diff --git a/Modules/Numerics/Optimizers/src/itkLBFGSBOptimizer.cxx b/Modules/Numerics/Optimizers/src/itkLBFGSBOptimizer.cxx
@@ -63,10 +63,7 @@ LBFGSBOptimizer::LBFGSBOptimizer()
 /**
  * Destructor
  */
-LBFGSBOptimizer::~LBFGSBOptimizer()
-{
-  delete m_VnlOptimizer;
-}
+LBFGSBOptimizer::~LBFGSBOptimizer() = default;
 
 /**
  * PrintSelf
@@ -266,14 +263,9 @@ LBFGSBOptimizer::SetCostFunction(SingleValuedCostFunction * costFunction)
 
   adaptor->SetCostFunction(costFunction);
 
-  if (m_OptimizerInitialized)
-  {
-    delete m_VnlOptimizer;
-  }
-
   this->SetCostFunctionAdaptor(adaptor);
 
-  m_VnlOptimizer = new InternalOptimizerType(*adaptor, this);
+  m_VnlOptimizer = std::make_unique<InternalOptimizerType>(*adaptor, this);
 
   // set the optimizer parameters
   m_VnlOptimizer->set_lower_bound(m_LowerBound);

diff --git a/Modules/Numerics/Optimizers/src/itkLBFGSOptimizer.cxx b/Modules/Numerics/Optimizers/src/itkLBFGSOptimizer.cxx
@@ -38,10 +38,7 @@ LBFGSOptimizer::LBFGSOptimizer()
 /**
  * Destructor
  */
-LBFGSOptimizer::~LBFGSOptimizer()
-{
-  delete m_VnlOptimizer;
-}
+LBFGSOptimizer::~LBFGSOptimizer() = default;
 
 /**
  * PrintSelf
@@ -185,14 +182,9 @@ LBFGSOptimizer::SetCostFunction(SingleValuedCostFunction * costFunction)
 
   adaptor->SetCostFunction(costFunction);
 
-  if (m_OptimizerInitialized)
-  {
-    delete m_VnlOptimizer;
-  }
-
   this->SetCostFunctionAdaptor(adaptor);
 
-  m_VnlOptimizer = new vnl_lbfgs(*adaptor);
+  m_VnlOptimizer = std::make_unique<vnl_lbfgs>(*adaptor);
 
   // set the optimizer parameters
   m_VnlOptimizer->set_trace(m_Trace);
@@ -265,7 +257,7 @@ LBFGSOptimizer::StartOptimization()
 vnl_lbfgs *
 LBFGSOptimizer::GetOptimizer()
 {
-  return m_VnlOptimizer;
+  return m_VnlOptimizer.get();
 }
 
 const std::string

diff --git a/Modules/Numerics/Optimizers/src/itkLevenbergMarquardtOptimizer.cxx b/Modules/Numerics/Optimizers/src/itkLevenbergMarquardtOptimizer.cxx
@@ -36,10 +36,7 @@ LevenbergMarquardtOptimizer::LevenbergMarquardtOptimizer()
 /**
  * Destructor
  */
-LevenbergMarquardtOptimizer::~LevenbergMarquardtOptimizer()
-{
-  delete m_VnlOptimizer;
-}
+LevenbergMarquardtOptimizer::~LevenbergMarquardtOptimizer() = default;
 
 /**
  * Connect a Cost Function
@@ -54,14 +51,9 @@ LevenbergMarquardtOptimizer::SetCostFunction(MultipleValuedCostFunction * costFu
 
   adaptor->SetCostFunction(costFunction);
 
-  if (m_OptimizerInitialized)
-  {
-    delete m_VnlOptimizer;
-  }
-
   this->SetCostFunctionAdaptor(adaptor);
 
-  m_VnlOptimizer = new vnl_levenberg_marquardt(*adaptor);
+  m_VnlOptimizer = std::make_unique<vnl_levenberg_marquardt>(*adaptor);
 
   this->SetNumberOfIterations(m_NumberOfIterations);
   this->SetValueTolerance(m_ValueTolerance);
@@ -203,7 +195,7 @@ LevenbergMarquardtOptimizer::SetEpsilonFunction(double epsilon)
 vnl_levenberg_marquardt *
 LevenbergMarquardtOptimizer::GetOptimizer() const
 {
-  return m_VnlOptimizer;
+  return m_VnlOptimizer.get();
 }
 
 const std::string

diff --git a/Modules/Numerics/Optimizersv4/include/itkAmoebaOptimizerv4.h b/Modules/Numerics/Optimizersv4/include/itkAmoebaOptimizerv4.h
@@ -21,6 +21,7 @@
 #include "itkSingleValuedNonLinearVnlOptimizerv4.h"
 #include "vnl/algo/vnl_amoeba.h"
 #include "ITKOptimizersv4Export.h"
+#include <memory> // For unique_ptr.
 
 namespace itk
 {
@@ -153,12 +154,12 @@ class ITKOptimizersv4_EXPORT AmoebaOptimizerv4 : public SingleValuedNonLinearVnl
   void
   ValidateSettings();
 
-  ParametersType::ValueType m_ParametersConvergenceTolerance;
-  MeasureType               m_FunctionConvergenceTolerance;
-  bool                      m_AutomaticInitialSimplex;
-  ParametersType            m_InitialSimplexDelta;
-  bool                      m_OptimizeWithRestarts;
-  vnl_amoeba *              m_VnlOptimizer;
+  ParametersType::ValueType   m_ParametersConvergenceTolerance;
+  MeasureType                 m_FunctionConvergenceTolerance;
+  bool                        m_AutomaticInitialSimplex;
+  ParametersType              m_InitialSimplexDelta;
+  bool                        m_OptimizeWithRestarts;
+  std::unique_ptr<vnl_amoeba> m_VnlOptimizer;
 
   std::ostringstream m_StopConditionDescription;
 };

diff --git a/Modules/Numerics/Optimizersv4/src/itkAmoebaOptimizerv4.cxx b/Modules/Numerics/Optimizersv4/src/itkAmoebaOptimizerv4.cxx
@@ -35,10 +35,7 @@ AmoebaOptimizerv4::AmoebaOptimizerv4()
 }
 
 
-AmoebaOptimizerv4::~AmoebaOptimizerv4()
-{
-  delete m_VnlOptimizer;
-}
+AmoebaOptimizerv4::~AmoebaOptimizerv4() = default;
 
 
 const std::string
@@ -62,7 +59,7 @@ AmoebaOptimizerv4::PrintSelf(std::ostream & os, Indent indent) const
 vnl_amoeba *
 AmoebaOptimizerv4::GetOptimizer() const
 {
-  return this->m_VnlOptimizer;
+  return this->m_VnlOptimizer.get();
 }
 
 void
@@ -136,8 +133,7 @@ AmoebaOptimizerv4::StartOptimization(bool /* doOnlyInitialization */)
   CostFunctionAdaptorType * adaptor = GetNonConstCostFunctionAdaptor();
   // get rid of previous instance of the internal optimizer and create a
   // new one
-  delete m_VnlOptimizer;
-  m_VnlOptimizer = new vnl_amoeba(*adaptor);
+  m_VnlOptimizer = std::make_unique<vnl_amoeba>(*adaptor);
   m_VnlOptimizer->set_max_iterations(static_cast<int>(m_NumberOfIterations));
   m_VnlOptimizer->set_x_tolerance(m_ParametersConvergenceTolerance);
   m_VnlOptimizer->set_f_tolerance(m_FunctionConvergenceTolerance);