STYLE: Updated comments and variable in the ImportImageContainer

Comments and the variable name better describe the behavior of the ImportImageContainer. The variable name in VectorImage has also been updated. Closes InsightSoftwareConsortium#4359
issakomi · Dec 4, 2023 · acd45c6 · acd45c6
1 parent 8a4ab31
commit acd45c6
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 20 deletions.
diff --git a/Modules/Core/Common/include/itkImportImageContainer.h b/Modules/Core/Common/include/itkImportImageContainer.h
@@ -118,12 +118,12 @@ class ITK_TEMPLATE_EXPORT ImportImageContainer : public Object
    * container. However, in this particular case, Reserve as a Resize
    * semantics that is kept for backward compatibility reasons.
    *
-   * If UseDefaultConstructor is true, then * the default constructor is used
-   * to initialize each element.  POD date types initialize to zero.
+   * If UseValueInitialization is true, then POD types will be
+   * zero-initialized.
    *
    * \sa SetImportPointer() */
   void
-  Reserve(ElementIdentifier size, const bool UseDefaultConstructor = false);
+  Reserve(ElementIdentifier size, const bool UseValueInitialization = false);
 
   /** Tell the container to try to minimize its memory usage for
    * storage of the current number of elements.  If new memory is
@@ -162,12 +162,11 @@ class ITK_TEMPLATE_EXPORT ImportImageContainer : public Object
   PrintSelf(std::ostream & os, Indent indent) const override;
 
   /**
-   * Allocates elements of the array.  If UseDefaultConstructor is true, then
-   * the default constructor is used to initialize each element.  POD date types
-   * initialize to zero.
+   * Allocates elements of the array.  If UseValueInitialization is true, then
+   * POD types will be zero-initialized.
    */
   virtual TElement *
-  AllocateElements(ElementIdentifier size, bool UseDefaultConstructor = false) const;
+  AllocateElements(ElementIdentifier size, bool UseValueInitialization = false) const;
 
   virtual void
   DeallocateManagedMemory();

diff --git a/Modules/Core/Common/include/itkImportImageContainer.hxx b/Modules/Core/Common/include/itkImportImageContainer.hxx
@@ -44,7 +44,7 @@ ImportImageContainer<TElementIdentifier, TElement>::~ImportImageContainer()
  */
 template <typename TElementIdentifier, typename TElement>
 void
-ImportImageContainer<TElementIdentifier, TElement>::Reserve(ElementIdentifier size, const bool UseDefaultConstructor)
+ImportImageContainer<TElementIdentifier, TElement>::Reserve(ElementIdentifier size, const bool UseValueInitialization)
 {
   // Reserve has a Resize semantics. We keep it that way for
   // backwards compatibility .
@@ -53,7 +53,7 @@ ImportImageContainer<TElementIdentifier, TElement>::Reserve(ElementIdentifier si
   {
     if (size > m_Capacity)
     {
-      TElement * temp = this->AllocateElements(size, UseDefaultConstructor);
+      TElement * temp = this->AllocateElements(size, UseValueInitialization);
       // only copy the portion of the data used in the old buffer
       std::copy_n(m_ImportPointer, m_Size, temp);
 
@@ -73,7 +73,7 @@ ImportImageContainer<TElementIdentifier, TElement>::Reserve(ElementIdentifier si
   }
   else
   {
-    m_ImportPointer = this->AllocateElements(size, UseDefaultConstructor);
+    m_ImportPointer = this->AllocateElements(size, UseValueInitialization);
     m_Capacity = size;
     m_Size = size;
     m_ContainerManageMemory = true;
@@ -153,22 +153,19 @@ ImportImageContainer<TElementIdentifier, TElement>::SetImportPointer(TElement *
 template <typename TElementIdentifier, typename TElement>
 TElement *
 ImportImageContainer<TElementIdentifier, TElement>::AllocateElements(ElementIdentifier size,
-                                                                     bool              UseDefaultConstructor) const
+                                                                     bool              UseValueInitialization) const
 {
-  // Encapsulate all image memory allocation here to throw an
-  // exception when memory allocation fails even when the compiler
-  // does not do this by default.
   TElement * data;
 
   try
   {
-    if (UseDefaultConstructor)
+    if (UseValueInitialization)
     {
-      data = new TElement[size](); // POD types initialized to 0, others use default constructor.
+      data = new TElement[size]();
     }
     else
     {
-      data = new TElement[size]; // Faster but uninitialized
+      data = new TElement[size];
     }
   }
   catch (...)

diff --git a/Modules/Core/Common/include/itkVectorImage.h b/Modules/Core/Common/include/itkVectorImage.h
@@ -203,7 +203,7 @@ class ITK_TEMPLATE_EXPORT VectorImage : public ImageBase<VImageDimension>
   /** Allocate the image memory. The size of the image must
    * already be set, e.g. by calling SetRegions(). */
   void
-  Allocate(bool UseDefaultConstructor = false) override;
+  Allocate(bool UseValueInitialization = false) override;
 
   /** Restore the data object to its initial state. This means releasing
    * memory. */

diff --git a/Modules/Core/Common/include/itkVectorImage.hxx b/Modules/Core/Common/include/itkVectorImage.hxx
@@ -35,7 +35,7 @@ namespace itk
 //----------------------------------------------------------------------------
 template <typename TPixel, unsigned int VImageDimension>
 void
-VectorImage<TPixel, VImageDimension>::Allocate(const bool UseDefaultConstructor)
+VectorImage<TPixel, VImageDimension>::Allocate(const bool UseValueInitialization)
 {
   if (m_VectorLength == 0)
   {
@@ -46,7 +46,7 @@ VectorImage<TPixel, VImageDimension>::Allocate(const bool UseDefaultConstructor)
   this->ComputeOffsetTable();
   num = this->GetOffsetTable()[VImageDimension];
 
-  m_Buffer->Reserve(num * m_VectorLength, UseDefaultConstructor);
+  m_Buffer->Reserve(num * m_VectorLength, UseValueInitialization);
 }
 
 template <typename TPixel, unsigned int VImageDimension>