Changeset 65 in tspsg-svn for trunk/src/tspsolver.cpp


Ignore:
Timestamp:
Oct 20, 2009, 9:38:01 PM (15 years ago)
Author:
laleppa
Message:

More code documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/tspsolver.cpp

    r64 r65  
    2424#include "tspsolver.h"
    2525
     26//! Class constructor
    2627CTSPSolver::CTSPSolver()
    2728        : nCities(0)
     
    125126}
    126127
    127 // TODO: Comment the algorithm
     128/*!
     129 * \brief Solves the given task.
     130 * \param numCities Number of cities in the task.
     131 * \param task The matrix of city-to-city travel costs.
     132 * \param parent The parent widget for displaying messages and dialogs.
     133 *
     134 * \todo TODO: Comment the algorithm.
     135 */
    128136sStep *CTSPSolver::solve(int numCities, tMatrix task, QWidget *parent)
    129137{
     
    226234}
    227235
     236/*!
     237 * \brief Returns the sorted optimal path, starting from City 1.
     238 */
    228239QString CTSPSolver::getSortedPath() const
    229240{
     
    242253}
    243254
     255/*!
     256 * \brief Returns CTSPSolver's version ID.
     257 *
     258 *  Current version ID is <b>\$Id$</b>.
     259 */
    244260QString CTSPSolver::getVersionId()
    245261{
     
    247263}
    248264
     265/*!
     266 * \brief Returns whether or not the solution is definitely optimal.
     267 *
     268 *  The solution may need some further interations to determine whether it is optimal.
     269 *  In such cases this function returns \p false.
     270 */
    249271bool CTSPSolver::isOptimal() const
    250272{
Note: See TracChangeset for help on using the changeset viewer.