source: tspsg/src/tspsolver.h @ fcaa74f7d7

0.1.3.145-beta1-symbian0.1.4.170-beta2-bb10appveyorimgbotreadme
Last change on this file since fcaa74f7d7 was fcaa74f7d7, checked in by Oleksii Serdiuk, 15 years ago
  • TCandidate should, actually, be SCandidate (struct, not typedef). Renamed it.
  • Documentation update.
  • Property mode set to 100644
File size: 3.2 KB
Line 
1/*!
2 * \file tspsolver.h
3 * \author Copyright &copy; 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
4 *
5 *  $Id$
6 *  $URL$
7 *
8 * \brief Defines #TMatrix typedef, SCandidate and SStep structs and CTSPSolver class.
9 *
10 *  <b>TSPSG: TSP Solver and Generator</b>
11 *
12 *  This file is part of TSPSG.
13 *
14 *  TSPSG is free software: you can redistribute it and/or modify
15 *  it under the terms of the GNU General Public License as published by
16 *  the Free Software Foundation, either version 3 of the License, or
17 *  (at your option) any later version.
18 *
19 *  TSPSG is distributed in the hope that it will be useful,
20 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
21 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 *  GNU General Public License for more details.
23 *
24 *  You should have received a copy of the GNU General Public License
25 *  along with TSPSG.  If not, see <http://www.gnu.org/licenses/>.
26 */
27
28#ifndef TSPSOLVER_H
29#define TSPSOLVER_H
30
31#include "globals.h"
32
33#include "tspmodel.h"
34
35//! A matrix of city-to-city travel costs.
36typedef QList<QList<double> > TMatrix;
37
38/*!
39 * \brief A structure that represents a candidate for branching.
40 */
41struct SCandidate {
42        int nRow; //!< A zero-based row number of the candidate
43        int nCol; //!< A zero-based column number of the candidate
44
45        //! Assigns default values
46        SCandidate() {
47                nCol = nRow = -1;
48        }
49        //! An operator == implementation
50        bool operator ==(const SCandidate &cand) const {
51                return ((cand.nRow == nRow) && (cand.nCol == nCol));
52        }
53};
54
55/*!
56 * \brief This structure represents one step of solving.
57 *
58 *  A tree of such elements will represent the solving process.
59 */
60struct SStep {
61        TMatrix matrix; //!< This step's matrix
62        double price; //!< The price of travel to this step
63        SCandidate candidate; //!< A candiadate for branching in the current matrix
64        QList<SCandidate> alts; //!< A list of alternative branching candidates
65        SStep *plNode; //!< Pointer to the left branch step
66        SStep *prNode; //!< Pointer to the right branch step
67
68        //! Assigns default values
69        SStep() {
70                price = -1;
71                plNode = prNode = NULL;
72        }
73};
74
75/*!
76 * \brief This class solves Travelling Salesman Problem task.
77 * \author Copyright &copy; 2007-2009 Lёppa <contacts[at]oleksii[dot]name>
78 *
79 * \todo TODO: Deletion of solution tree on destroy and cleanup.
80 */
81class CTSPSolver
82{
83        Q_DECLARE_TR_FUNCTIONS(CTSPSolver)
84
85public:
86        CTSPSolver();
87        QString getSortedPath() const;
88        static QString getVersionId();
89        bool isOptimal() const;
90        SStep *solve(int numCities, TMatrix task, QWidget *parent = 0);
91        ~CTSPSolver();
92
93private:
94        bool mayNotBeOptimal;
95        int nCities;
96        SStep *root;
97        QHash<int,int> route;
98//      QHash<int,int> forbidden;
99
100        double align(TMatrix &matrix);
101        void cleanup();
102        void deleteNode(SStep *node);
103        QList<SCandidate> findCandidate(const TMatrix &matrix, int &nRow, int &nCol) const;
104        double findMinInCol(int nCol, const TMatrix &matrix, int exr = -1) const;
105        double findMinInRow(int nRow, const TMatrix &matrix, int exc = -1) const;
106        bool hasSubCycles(int nRow, int nCol) const;
107        void subCol(TMatrix &matrix, int nCol, double val);
108        void subRow(TMatrix &matrix, int nRow, double val);
109};
110
111#endif // TSPSOLVER_H
Note: See TracBrowser for help on using the repository browser.