Changeset 5d401f2c50 in tspsg

Timestamp:

Apr 28, 2010, 1:38:10 AM (15 years ago)

Author:

Oleksii Serdiuk

Branches:

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

Children:

f2ff738751

Parents:

20015b41e7

git-author:

Oleksii Serdiuk <contacts@…> (04/28/10 01:38:10)

git-committer:

Oleksii Serdiuk <contacts@…> (06/29/12 19:41:31)

Message:

+ Added ChangeLog?, Installation Guide and License pages to doxygen generated documentation.

• Added city and separator parameters to CTSPSolver::getSortedPath() method to make path generation more flexible.
• Fixed a bug when the solution graph wasn't drwan correctly in some situations.

Files:

• INSTALL.txt (modified) (5 diffs)
• README.txt (modified) (1 diff)
• docs/dox/changelog.dox (added)
• docs/dox/install.dox (added)
• docs/dox/license.dox (added)
• docs/dox/mainpage.dox (added)
• doxygen.conf (modified) (3 diffs)
• src/mainwindow.cpp (modified) (2 diffs)
• src/tspsolver.cpp (modified) (2 diffs)
• src/tspsolver.h (modified) (1 diff)
• src/version.h (modified) (1 diff)

INSTALL.txt

@@ -35 +35 @@
 or higher.
 
+NOTE: Please, note that there will be some regressions in functionality
+if your version of \em Qt is lower than the recommended.
+
 
 
@@ -164 +167 @@
     C:\Qt\bin\lrelease tspsg.pro
     C:\Qt\bin\qmake tspsg.pro CONFIG+=release
-        nmake
+    nmake
 
 If make step finished without errors you can install TSPSG by running
@@ -188 +191 @@
     lrelease tspsg.pro
     qmake tspsg.pro CONFIG+=release
-        nmake
+    nmake
 
 There is no automated installation process for Windows Mobile build. To
@@ -217 +220 @@
     make release-gcce
 
-NOTE: You need to unpack the source on the same drive as Qt and Symbian
-development tools.
+WARNING: You need to unpack the source to the same drive as Symbian SDK
+and the path must not contain any spaces or TSPSG won't build.
 
 If make step finished without errors you can generate sis installation
@@ -299 +302 @@
 qmake doesn't always enclose installation paths in quotes. This may
 cause some files not to be installed or removed when their path
-contains quotes. In this case it is safe to delete this files and TSPSG
-installation directory manually.
+contains spaces. In this case it is safe to delete these files and
+TSPSG installation directory manually.
 
 

README.txt

@@ -6 +6 @@
 
 TSPSG is intended to generate and solve Travelling Salesman Problem
-(TSP) tasks. It uses Branch and Bound method for solving. An input
-is number of cities and matrix of city-to-city travel costs.
-The matrix can be populated with random values in a given range
-(useful for generating tasks). The result is an optimal route, its
-price, step-by-step matrices of solving and solving graph. The task
-can be saved in internal binary format and opened later. The result
-can be printed without the answer (only input matrix) or with it.
+(TSP) tasks. It uses Branch and Bound method for solving. Its input is
+a number of cities and a matrix of city-to-city travel costs. The
+matrix can be populated with random values in a given range (which is
+useful for generating tasks). The result is an optimal route, its
+price, step-by-step matrices of solving and a solving graph. The task
+can be saved in an internal binary format and opened later. The result
+can be printed or saved as PDF, HTML, or ODF.
 
 TSPSG may be useful for teachers to generate test tasks or just for
 regular users to solve TSPs. Also, it may be used as an example of
-using Branch and bound method to solve particular task.
+using Branch and Bound method to solve a particular task.
 
 TSPSG is free software: you can redistribute it and/or modify it

doxygen.conf

@@ -597 +597 @@
 # with spaces.
 
-INPUT                  = src
+INPUT                  = src docs/dox
 
 # This tag can be used to specify the character encoding of the source files 
@@ -650 +650 @@
 # If left blank NO is used.
 
-RECURSIVE              = YES
+RECURSIVE              = NO
 
 # The EXCLUDE tag can be used to specify files and/or directories that should 
@@ -684 +684 @@
 # the \include command).
 
-EXAMPLE_PATH           = 
+EXAMPLE_PATH           = .
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 

src/mainwindow.cpp

@@ -666 +666 @@
 
         cur.insertBlock(fmt_paragraph);
-        cur.insertText("  " + solver.getSortedPath());
+        cur.insertText("  " + solver.getSortedPath(tr("City %1")));
 
         cur.insertBlock(fmt_paragraph);
@@ -861 +861 @@
                 pic.drawLine(QPointF(x, y - r), QPointF(r * 2.25, y - 2 * r));
         } else if (nstep > 1) {
-                pic.drawLine(QPointF(x, y - r), QPointF((step->pNode->next == SStep::RightBranch) ? r * 3.5 : r, y - 2 * r));
+                pic.drawLine(QPointF(x, y - r), QPointF((step->pNode->pNode->next == SStep::RightBranch) ? r * 3.5 : r, y - 2 * r));
         }
 

src/tspsolver.cpp

@@ -71 +71 @@
 /*!
  * \brief Returns the sorted optimal path, starting from City 1.
+ * \param city A string that represents city elements in the path.
+ * \param separator A string that represents separators between cities in the path.
  * \return A string, containing sorted optimal path.
- */
-QString CTSPSolver::getSortedPath() const
+ *
+ *  The resulting path will be in the form \a city+\a separator+\a city+...+\a separator+\a city.
+ *  \c \%1 in \a city will be replaced by the city number.
+ */
+QString CTSPSolver::getSortedPath(const QString &city, const QString &separator) const
 {
         if (!root || route.isEmpty() || (route.size() != nCities))
@@ -79 +84 @@
 
 int i = 0; // We start from City 1
-QString path = tr("City %1").arg(1) + " -> ";
+QStringList path;
+        path << city.arg(1);
         while ((i = route[i]) != 0) {
-                path += tr("City %1").arg(i + 1) + " -> ";
+                path << city.arg(i + 1);
         }
         // And finish in City 1, too
-        path += tr("City %1").arg(1);
-
-        return path;
+        path << city.arg(1);
+
+        return path.join(separator);
 }
 

src/tspsolver.h

@@ -113 +113 @@
         CTSPSolver(QObject *parent = NULL);
         void cleanup(bool processEvents = false);
-        QString getSortedPath() const;
+        QString getSortedPath(const QString &city, const QString &separator = " -> ") const;
         int getTotalSteps() const;
         bool isOptimal() const;

src/version.h

@@ -11 +11 @@
  *
  *  This file is part of TSPSG.
- *
- *  TSPSG is free software: you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation, either version 3 of the License, or
- *  (at your option) any later version.
- *
- *  TSPSG is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with TSPSG.  If not, see <http://www.gnu.org/licenses/>.
- */
-/*!
- * \mainpage
- * \image html tspsg.png
- *  <b>TSPSG: TSP Solver and Generator</b>
- * \author Copyright &copy; 2007-2010 Lёppa <contacts[at]oleksii[dot]name>
- *
- *  \b Homepage: <a href="http://tspsg.sourceforge.net/">tspsg.sourceforge.net</a>
  *
  *  TSPSG is free software: you can redistribute it and/or modify