Changeset caef58b531 in tspsg for src/tspsolver.h

Timestamp:

Oct 20, 2009, 9:38:01 PM (15 years ago)

Author:

Oleksii Serdiuk

Branches:

0.1.3.145-beta1-symbian, 0.1.4.170-beta2-bb10, appveyor, imgbot, master, readme

Children:

85ad815b0b

Parents:

bc1b8837b6

Message:

More code documentation.

File:

• src/tspsolver.h (modified) (3 diffs)

src/tspsolver.h

@@ -1 @@
-/*
- *  TSPSG: TSP Solver and Generator
- *  Copyright (C) 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
+/*!
+ * \class CTSPSolver
+ * \author Copyright &copy; 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
+ * \brief This class solves Travelling Salesman Problem task.
  *
  *  $Id$
  *  $URL$
+ *
+ *  <b>TSPSG: TSP Solver and Generator</b>
  *
  *  This file is part of TSPSG.
@@ -20 +23 @@
  *  You should have received a copy of the GNU General Public License
  *  along with TSPSG.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * \todo TODO: Deletion of solution tree on destroy and cleanup.
  */
 
@@ -29 +34 @@
 #include "tspmodel.h"
 
+//! A matrix of city-to-city travel costs.
 typedef QList<QList<double> > tMatrix;
 
-// This structure represents one step of solving
-// The tree of such elements will represent the solving process
+/*!
+ * \brief This structure represents one step of solving.
+ *
+ *  A tree of such elements will represent the solving process.
+ */
+//! \todo TODO: List alternative candidates.
 struct sStep {
-        tMatrix matrix; // Steps's matrix
-        double price; // Price of travel to this step
-        struct {int nRow; int nCol;} candidate; // Candiadate for branching in current matrix
-        bool alts; // This matrix has alternative candidates
-        sStep *plNode, *prNode; // Pointers to left and right branch steps
-        sStep() { price = candidate.nRow = candidate.nCol = -1; alts = false; plNode = prNode = NULL; } // Default values
+        tMatrix matrix; //!< This step's matrix
+        double price; //!< The price of travel to this step
+        struct {
+                int nRow; //!< A zero-based row number of the candidate
+                int nCol; //!< A zero-based column number of the candidate
+        } candidate; //!< A candiadate for branching in the current matrix
+        bool alts; //!< Indicates whether or not matrix has alternative candidates
+        sStep *plNode; //!< Pointer to the left branch step
+        sStep *prNode; //!< Pointer to the right branch step
+
+        //! Assigns default values
+        sStep() {
+                price = candidate.nRow = candidate.nCol = -1;
+                alts = false;
+                plNode = prNode = NULL;
+        }
 };
 
-// TSP Solver class
 class CTSPSolver
 {