Added comments for debuggin dead code

Author: jardiamj

Simulator/Core/Model.cpp

@@ -14,7 +14,7 @@
  */
 
 #include "Model.h"
-#include "ConnGrowth.h"
+// #include "FixedLayout.h"
 #include "Connections.h"
 #include "Factory.h"
 #include "ParameterManager.h"
@@ -106,10 +106,16 @@ void Model::setupSim()
    connections_->createEdgeIndexMap();
 }
 
+// Note: This method was previously used for debugging, but it is now dead code left behind.
 /// Log this simulation step.
 void Model::logSimStep() const
 {
-   layout_->printLayout();
+   FixedLayout *fixedLayout = dynamic_cast<FixedLayout *>(layout_.get());
+   if (fixedLayout == nullptr) {
+      return;
+   }
+
+   fixedLayout->printLayout();
 }
 
 /// Update the simulation history of every epoch.

Simulator/Core/Model.h

@@ -80,6 +80,7 @@ class Model {
    virtual void updateConnections() = 0;
 
 protected:
+   // Note: This method was previously used for debugging, but it is now dead code left behind.
    /// Prints debug information about the current state of the network.
    void logSimStep() const;
 

Simulator/Layouts/Layout.cpp

@@ -58,11 +58,6 @@ void Layout::registerGraphProperties()
    // initial graph
 }
 
-void Layout::printLayout()
-{
-   // Empty implementation because not all Layouts implement it but it is used by the Model
-}
-
 /// Setup the internal structure of the class.
 /// Allocate memories to store all layout state, no sequential dependency in this method
 void Layout::setup()

Simulator/Layouts/Layout.h

@@ -68,9 +68,6 @@ class Layout {
    /// @return The number of vertices managed by the Layout
    virtual int getNumVertices() const;
 
-   /// @brief  Prints the layout, used for debugging.
-   virtual void printLayout();
-
    VectorMatrix xloc_;   ///< Store neuron i's x location.
 
    VectorMatrix yloc_;   ///< Store neuron i's y location.

Simulator/Layouts/Neuro/FixedLayout.cpp

@@ -176,6 +176,8 @@ void FixedLayout::initVerticesLocs()
    }
 }
 
+// Note: This code was previously used for debugging, but it is now dead code left behind
+// and it is never executed.
 void FixedLayout::printLayout()
 {
    ConnGrowth &pConnGrowth

Simulator/Layouts/Neuro/FixedLayout.h

@@ -59,8 +59,8 @@ class FixedLayout : public Layout {
    /// @return type of the synapse.
    virtual edgeType edgType(const int srcVertex, const int destVertex) override;
 
-   /// @brief  Prints the layout, used for debugging.
-   virtual void printLayout() override;
+   /// Prints the layout, used for debugging.
+   void printLayout();
 
 private:
    /// initialize the location maps (xloc and yloc).