problem.h

Go to the documentation of this file.

/*
 *   libpal - Automated Placement of Labels Library
 *
 *   Copyright (C) 2008 Maxence Laurent, MIS-TIC, HEIG-VD
 *                      University of Applied Sciences, Western Switzerland
 *                      http://www.hes-so.ch
 *
 *   Contact:
 *      maxence.laurent <at> heig-vd <dot> ch
 *    or
 *      eric.taillard <at> heig-vd <dot> ch
 *
 * This file is part of libpal.
 *
 * libpal 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.
 *
 * libpal 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 libpal.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef PAL_PROBLEM_H
#define PAL_PROBLEM_H
 
#define SIP_NO_FILE
 
 
#include <list>
#include <memory>
#include <vector>
 
#include "palrtree.h"
#include "qgis_core.h"
#include "qgsrendercontext.h"
 
#include <QList>
 
namespace pal
{
 
  class LabelPosition;
  class Label;
  class PriorityQueue;

 
  struct Chain
  {
    int degree;
    double delta;
    std::vector< int > feat;
    std::vector< int > label;
  };

  class CORE_EXPORT Problem
  {
      friend class Pal;
 
    public:

      Problem( const QgsRectangle &extent );
 
      //Problem(char *lorena_file, bool displayAll);
 
      ~Problem();
 
      Problem( const Problem &other ) = delete;
      Problem &operator=( const Problem &other ) = delete;

      void addCandidatePosition( std::unique_ptr< LabelPosition > position );

      std::size_t featureCount() const { return mFeatureCount; }

      int featureCandidateCount( int feature ) const { return mCandidateCountForFeature[feature]; }

      LabelPosition *featureCandidate( int feature, int candidate ) const { return mLabelPositions[ mFirstCandidateIndexForFeature[feature] + candidate ].get(); }

      void reduce();

      void chainSearch( QgsRenderContext &context );

      QList<LabelPosition *> getSolution( bool returnInactive, QList<LabelPosition *> *unlabeled = nullptr );
 
      /* useful only for postscript post-conversion*/
      //void toFile(char *label_file);
 
      void init_sol_falp();

      std::vector< std::unique_ptr< LabelPosition > > *positionsWithNoCandidates()
      {
        return &mPositionsWithNoCandidates;
      }

      PalRtree< LabelPosition > &allCandidatesIndex() { return mAllCandidatesIndex; }
 
    private:

      bool candidatesAreConflicting( const LabelPosition *lp1, const LabelPosition *lp2 ) const;

      int mLayerCount = 0;

      QStringList labelledLayersName;

      int mTotalCandidates = 0;

      int mAllNblp = 0;

      std::size_t mFeatureCount = 0;

      bool mDisplayAll = false;

      double mMapExtentBounds[4] = {0, 0, 0, 0};
 
      std::vector< std::unique_ptr< LabelPosition > > mLabelPositions;
 
      PalRtree<LabelPosition> mAllCandidatesIndex;
      PalRtree<LabelPosition> mActiveCandidatesIndex;
 
      std::vector< std::unique_ptr< LabelPosition > > mPositionsWithNoCandidates;

      std::vector< int > mFirstCandidateIndexForFeature;
      std::vector< int > mCandidateCountForFeature;
      std::vector< double > mUnlabeledCostForFeature;
 
      class Sol
      {
        public:

          std::vector< int > activeLabelIds;
 
          void init( std::size_t featureCount )
          {
            activeLabelIds.resize( featureCount, -1 );
          }
      };
 
      Sol mSol;
      double mNbOverlap = 0.0;
 
      // seed is actually a feature ID, maybe it should be renamed?
      std::unique_ptr< Chain > chain( int seed );
 
      Pal *pal = nullptr;
 
      void solution_cost();
      void ignoreLabel( const LabelPosition *lp, pal::PriorityQueue &list, PalRtree<LabelPosition> &candidatesIndex );
  };
 
} // namespace
 
#endif