root/sandbox/orkney/algorithm.h

/*
 * Copyright (c) 2007 Anton A. Patrushev, Orkney, Inc.
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

#ifndef _ALGORITHM_H_INCLUDED
#define _ALGORITHM_H_INCLUDED

#include "ogr_core.h"
#include "ogr_feature.h"
#include "ogr_geometry.h"

#include <boost/config.hpp>
#include <boost/graph/graph_traits.hpp>
#include <boost/graph/adjacency_list.hpp>


#define MAX_NODES 1000000

#define ID_FIELD       "id"
#define COST_FIELD     "cost"
#define WEIGHT_FIELD   "weight"
#define RC_FIELD       "reverse_cost"

#define SOURCE_FIELD   "source"
#define TARGET_FIELD   "target"

#define TO_COST_FIELD  "to_cost"
#define RULE_FIELD     "rule"

#define EXIT_SUCCESS    0
#define NO_SOURCE_FOUND 1
#define NO_TARGET_FOUND 2
#define NO_PATH_FOUND   3
#define RESULT_OVERFLOW 4


using namespace std;
using namespace boost;

struct Edge
{
  int id;
  int source;
  int target;
  double cost;
  double distance;
  double rank;
  std::map< int, vector< std::pair<float, std::vector<int> > >, std::less<int> > adjacent_edges;
  default_color_type color;
};
        
struct Vertex
{
  int id;
  double x;
  double y;
};

struct found_goal {}; // exception for termination

typedef adjacency_list < listS, vecS, directedS, Vertex, Edge > graph_t;

typedef graph_traits < graph_t >::vertex_descriptor vertex_descriptor;
typedef graph_traits < graph_t >::edge_descriptor edge_descriptor; 
      
class Algorithm
{
  protected:
    bool  directed;
    bool  weighted;
    bool  reverseCost;
    
    char *name;
    int   e_max_id;

  public:
//             Algorithm();
//             Algorithm(char*, bool, bool, bool);
//    virtual ~Algorithm();

            Algorithm(){}
            Algorithm( char *nameIn, bool directedIn, bool weightedIn, bool reverseCostIn )
            {
              name = nameIn;
              directed = directedIn;
              weighted = weightedIn;
              reverseCost = reverseCostIn;
            }
    virtual ~Algorithm(){}
                   
    virtual bool addEdge(edge_descriptor *e, OGRFeature *edge, graph_t &graph) = 0;
    virtual void fillFeature(OGRFeature **edges, unsigned int count, edge_descriptor *e, graph_t &graph, int j) = 0;
    virtual int  getRoute(int start, int end, OGRFeature **edges, OGRFeature **result, int *resultCount, graph_t &graph) = 0;
    virtual int  makeResult(vertex_descriptor target, vertex_descriptor source, 
                            OGRFeature **edges,
                            std::vector<vertex_descriptor> &predecessors, 
                            OGRFeature **result, int *resultCount, graph_t &graph) = 0;

    //Template method for shortest path calculation
    int shortestPath(OGRFeature **edges, unsigned int count, int start, 
                     int end, OGREnvelope *bbox, OGRFeature **result, int *resultCount)
    {      

      // FIXME: compute this value
      const unsigned int num_nodes = ((IsDirected() && HasReverseCost() ? 2 : 1) * count) + 100;
  
      graph_t graph(num_nodes);
      
      for (unsigned int z = 0; z < count; ++z)
      {
        if(edges[z]->GetFieldAsInteger(ID_FIELD) > e_max_id)
          e_max_id=edges[z]->GetFieldAsInteger(ID_FIELD);
      }
      
      for (std::size_t j = 0; j < count; ++j)
      {
        edge_descriptor *e; 
        
            fillFeature(edges, count, e, graph, j);     
      }
      
      return getRoute(start, end, edges, result, resultCount, graph);      
    }
    
    void  SetName( char* nameIn ) { name = nameIn; }
    virtual char *GetName() { return name; }

    void  SetDirected( bool directedIn ) { directed = directedIn; }
    bool  IsDirected() const { return directed; }
    void  SetWeighted( bool weightedIn ) { weighted = weightedIn; }
    bool  IsWeighted() const { return weighted; }
    void  SetReverseCost( bool reverseCostIn ) { reverseCost = reverseCostIn; }
    bool  HasReverseCost() const { return reverseCost; }
};

#endif