graph_python_interface.hh 13.5 KB
Newer Older
1
2
// graph-tool -- a general graph modification and manipulation thingy
//
Tiago Peixoto's avatar
Tiago Peixoto committed
3
// Copyright (C) 2007  Tiago de Paula Peixoto <tiago@forked.de>
4
5
6
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
Tiago Peixoto's avatar
Tiago Peixoto committed
7
// as published by the Free Software Foundation; either version 3
8
9
10
11
12
13
14
15
// 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
16
// along with this program. If not, see <http://www.gnu.org/licenses/>.
17

18
19
#ifndef PYTHON_INTERFACE_HH
#define PYTHON_INTERFACE_HH
20
21
22

#include <boost/graph/graph_traits.hpp>
#include <boost/mpl/logical.hpp>
23
#include <boost/functional/hash.hpp>
24
#include <boost/iterator/iterator_facade.hpp>
25

26
27
#include "graph.hh"
#include "graph_filtering.hh"
28
#include "graph_selectors.hh"
29
#include "numpy_bind.hh"
30

31
#include <boost/python.hpp>
32
#include <boost/python/type_id.hpp>
33

34
// this file includes a simple python interface for the internally kept
35
36
37
38
// graph. It defines a PythonVertex, PythonEdge and PythonIterator template
// classes, which contain the proper member functions for graph traversal. These
// types are then specialized for each version of the adapted graph (directed,
// undirected, filtered, reversed).
39

40
41
42
43
namespace graph_tool
{
using namespace boost;

44
45
// generic iterator adaptor which can be used to iterate vertices, edges,
// out_edges and in_edges through python
46
template <class Descriptor, class Iterator>
47
class PythonIterator
48
{
49
public:
50
    PythonIterator(GraphInterface& gi, std::pair<Iterator,Iterator> e)
51
        : _gi(gi), _e(e) {}
52
    Descriptor Next()
53
    {
54
55
        if (_e.first == _e.second)
            python::objects::stop_iteration_error();
56
        Descriptor e(_gi, *_e.first);
57
58
        ++_e.first;
        return e;
59
60
    }
private:
61
    GraphInterface& _gi;
62
    std::pair<Iterator,Iterator> _e;
Tiago Peixoto's avatar
Tiago Peixoto committed
63
64
65
};


66
// forward declaration of PythonEdge
67
68
template <class Graph>
class PythonEdge;
69

70
// below are classes related to the PythonVertex type
71
class PythonVertex
72
73
{
public:
74
    PythonVertex(GraphInterface& gi, GraphInterface::vertex_t v):
75
76
77
78
79
80
81
82
83
84
85
        _gi(gi), _v(v), _valid(true)
    {
        CheckValid();
    }

    bool IsValid() const
    {
        return _valid &&
            (_v != graph_traits<GraphInterface::multigraph_t>::null_vertex()) &&
            (_v < num_vertices(_gi._mg));
    }
86

87
    void SetValid(bool valid)
88
    {
89
90
        _valid = valid;
    }
91

92
93
94
    void CheckValid() const
    {
        if (!IsValid())
Tiago Peixoto's avatar
Tiago Peixoto committed
95
            throw ValueException("invalid vertex descriptor");
96
    }
97

98
    GraphInterface::vertex_t GetDescriptor() const
99
100
101
102
    {
        return _v;
    }

103
104
105
106
    template <class DegSelector>
    struct get_degree
    {
        template<class Graph>
107
        void operator()(const Graph& g,
108
109
110
                        typename graph_traits<Graph>::vertex_descriptor v,
                        size_t& deg) const
        {
111
            deg = DegSelector()(v, g);
112
113
114
        }
    };

115
    size_t GetInDegree() const
116
    {
117
        CheckValid();
118
        size_t in_deg;
119
120
121
        run_action<>()(_gi, bind<void>(get_degree<in_degreeS>(),
                                       _1, _v,
                                       ref(in_deg)))();
122
        return in_deg;
123
    }
124

125
    size_t GetOutDegree() const
126
    {
127
        CheckValid();
128
        size_t out_deg;
129
130
        run_action<>()(_gi, bind<void>(get_degree<out_degreeS>(), _1, _v,
                                       ref(out_deg)))();
131
        return out_deg;
Tiago Peixoto's avatar
Tiago Peixoto committed
132
133
    }

134
    // provide iterator support for out_edges
135

136
137
138
    struct get_out_edges
    {
        template<class Graph>
139
        void operator()(const Graph& g, GraphInterface& gi,
140
141
142
143
144
145
146
                        typename graph_traits<Graph>::vertex_descriptor v,
                        python::object& iter) const
        {
            typedef typename graph_traits<Graph>::out_edge_iterator
                out_edge_iterator;
            iter = python::object(PythonIterator<PythonEdge<Graph>,
                                                 out_edge_iterator>
147
                                  (gi, out_edges(v, g)));
148
149
150
151
        }
    };

    python::object
152
    OutEdges() const
Tiago Peixoto's avatar
Tiago Peixoto committed
153
    {
154
        CheckValid();
155
        python::object iter;
156
157
        run_action<>()(_gi, bind<void>(get_out_edges(), _1,
                                       ref(_gi), _v, ref(iter)))();
158
        return iter;
159
    }
160

161
162
163
    struct get_in_edges
    {
        template<class Graph>
164
        void operator()(const Graph& g, GraphInterface& gi,
165
166
167
168
169
170
171
                        typename graph_traits<Graph>::vertex_descriptor v,
                        python::object& iter) const
        {
            typedef typename in_edge_iteratorS<Graph>::type
                in_edge_iterator;
            iter = python::object
                (PythonIterator<PythonEdge<Graph>,in_edge_iterator>
172
                 (gi, in_edge_iteratorS<Graph>::get_edges(v, g)));
173
174
175
176
        }
    };

    python::object
177
    InEdges() const
178
    {
179
        CheckValid();
180
        python::object iter;
181
182
        run_action<>()(_gi, bind<void>(get_in_edges(), _1, ref(_gi),
                                       _v, ref(iter)))();
183
        return iter;
Tiago Peixoto's avatar
Tiago Peixoto committed
184
    }
185

186
187
    std::string GetString() const
    {
188
        CheckValid();
189
190
191
        return lexical_cast<std::string>(_v);
    }

192
    size_t GetHash() const
193
    {
194
        return hash<size_t>()(_gi._vertex_index[_v]);
195
196
    }

197
198
199
200
201
    size_t GetIndex() const
    {
        return _gi._vertex_index[_v];
    }

202
    bool operator==(const PythonVertex& other) const
203
    {
204
205
        CheckValid();
        other.CheckValid();
206
        return other._v == _v;
207
    }
208

209
    bool operator!=(const PythonVertex& other) const
210
    {
211
212
        CheckValid();
        other.CheckValid();
213
        return other._v != _v;
214
215
    }

216
private:
217
    GraphInterface& _gi;
218
    GraphInterface::vertex_t _v;
219
    bool _valid;
220
};
221

222
// below are classes related to the PythonEdge type
223

224
225
226
227
template <class Graph>
class PythonEdge
{
public:
Tiago Peixoto's avatar
Tiago Peixoto committed
228
    typedef typename graph_traits<Graph>::edge_descriptor edge_descriptor;
229
    PythonEdge(GraphInterface& gi, edge_descriptor e)
230
231
232
233
234
235
        : _gi(gi), _e(e), _valid(true)
    {
        CheckValid();
    }

    bool IsValid() const
Tiago Peixoto's avatar
Tiago Peixoto committed
236
    {
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
        return _valid &&
            (_gi._vertex_index[target(_e, _gi._mg)] < num_vertices(_gi._mg)) &&
            (_gi._vertex_index[source(_e, _gi._mg)] < num_vertices(_gi._mg)) &&
            (target(_e, _gi._mg) != graph_traits<Graph>::null_vertex()) &&
            (source(_e, _gi._mg) != graph_traits<Graph>::null_vertex());
    }

    void SetValid(bool valid)
    {
        _valid = valid;
    }

    void CheckValid() const
    {
        if (!_valid)
Tiago Peixoto's avatar
Tiago Peixoto committed
252
            throw ValueException("invalid edge descriptor");
Tiago Peixoto's avatar
Tiago Peixoto committed
253
254
    }

255
    GraphInterface::edge_t GetDescriptor() const
256
257
258
259
    {
        return _e;
    }

260
261
262
    struct get_source
    {
        template<class GraphType>
263
        void operator()(const GraphType& g, GraphInterface& gi,
264
265
266
                        const edge_descriptor& edge, python::object& vertex)
            const
        {
267
            vertex = python::object(PythonVertex(gi, source(edge, g)));
268
269
        }
    };
270

271
    python::object GetSource() const
Tiago Peixoto's avatar
Tiago Peixoto committed
272
    {
273
        CheckValid();
274
        python::object v;
275
276
        run_action<>()(_gi, bind<void>(get_source(), _1, ref(_gi), ref(_e),
                                       ref(v)))();
277
        return v;
Tiago Peixoto's avatar
Tiago Peixoto committed
278
279
    }

280
281
282
    struct get_target
    {
        template<class GraphType>
283
        void operator()(const GraphType& g, GraphInterface& gi,
284
                        const edge_descriptor& edge,
285
286
                        python::object& vertex) const
        {
287
            vertex = python::object(PythonVertex(gi, target(edge, g)));
288
289
        }
    };
290

291
    python::object GetTarget() const
Tiago Peixoto's avatar
Tiago Peixoto committed
292
    {
293
        CheckValid();
294
        python::object v;
295
296
        run_action<>()(_gi, bind<void>(get_target(), _1, ref(_gi), ref(_e),
                                       ref(v)))();
297
        return v;
Tiago Peixoto's avatar
Tiago Peixoto committed
298
299
    }

300
301
    std::string GetString() const
    {
302
303
304
        CheckValid();
        PythonVertex src = python::extract<PythonVertex>(GetSource());
        PythonVertex tgt = python::extract<PythonVertex>(GetTarget());
305
        return "(" + src.GetString() + "," + tgt.GetString() + ")";
306
307
    }

308
    size_t GetHash() const
Tiago Peixoto's avatar
Tiago Peixoto committed
309
    {
310
311
        CheckValid();
        return hash<size_t>()(_gi._edge_index[_e]);
Tiago Peixoto's avatar
Tiago Peixoto committed
312
313
    }

314
    bool operator==(const PythonEdge& other) const
Tiago Peixoto's avatar
Tiago Peixoto committed
315
    {
316
        CheckValid();
317
        return other._e == _e;
Tiago Peixoto's avatar
Tiago Peixoto committed
318
    }
319

320
    bool operator!=(const PythonEdge& other) const
321
    {
322
        CheckValid();
323
        return other._e != _e;
324
325
326
    }

private:
327
    GraphInterface& _gi;
328
    edge_descriptor _e;
329
    bool _valid;
330
331
};

332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
// metafunction to determine wether or not to return copies or internal
// references to property types
struct return_reference
{
    template <class ValueType>
    struct apply
    {
        // return actual references only for non-string and non-python::object
        // classes

        typedef typename mpl::if_<
            typename mpl::and_<
                is_class<ValueType>,
                typename mpl::and_<
                    typename mpl::not_<is_same<ValueType,
                                               string> >::type,
                    typename mpl::not_<is_same<ValueType,
                                               python::object> >::type>::type
                >::type,
            mpl::bool_<true>,
            mpl::bool_<false> >::type type;
    };
};

template <class PropertyMap>
357
358
359
class PythonPropertyMap
{
public:
360
361
    PythonPropertyMap(const PropertyMap& pmap)
        : _pmap(pmap) {}
362

363
364
365
366
367
368
369
    typedef typename property_traits<PropertyMap>::value_type value_type;

    typedef typename mpl::if_<
        typename return_reference::apply<value_type>::type,
        value_type&,
        value_type>::type reference;

370
    template <class PythonDescriptor>
371
    reference GetValue(const PythonDescriptor& key)
372
    {
373
        key.CheckValid();
374
        return get(_pmap, key.GetDescriptor());
375
376
    }

377
378
    template <class PythonDescriptor>
    void SetValue(const PythonDescriptor& key, const value_type& val)
379
    {
380
381
382
383
        set_value(key, val,
                  is_convertible<
                  typename property_traits<PropertyMap>::category,
                  writable_property_map_tag>());
384
385
    }

386
387
388
    template <class PythonDescriptor>
    void set_value(const PythonDescriptor& key, const value_type& val,
                   true_type)
389
    {
390
391
        key.CheckValid();
        put(_pmap, key.GetDescriptor(), val);
392
393
    }

394
    template <class PythonDescriptor>
395
396
    void set_value(const PythonDescriptor& key, const value_type& val,
                   false_type)
397
    {
Tiago Peixoto's avatar
Tiago Peixoto committed
398
        throw ValueException("property is read-only");
399
400
401
402
    }

    size_t GetHash() const
    {
403
        return hash<size_t>()(size_t(this));
404
405
406
407
    }

    std::string GetType() const
    {
408
409
410
411
412
413
414
        using python::detail::gcc_demangle;
        if (is_same<typename mpl::find<value_types,value_type>::type,
                    typename mpl::end<value_types>::type>::value)
            return gcc_demangle(typeid(value_type).name());
        else
            return type_names[mpl::find<value_types,
                                        value_type>::type::pos::value];
415
416
    }

417
    boost::any GetMap() const
418
419
420
421
    {
        return _pmap;
    }

422
423
424
425
426
427
428
    boost::any GetDynamicMap() const
    {
        return (dynamic_property_map*)
            (new boost::detail::dynamic_property_map_adaptor<PropertyMap>
             (_pmap));
    }

429
430
431
    python::object GetArray(size_t size)
    {
        typedef typename mpl::or_<
432
433
434
435
436
437
438
439
440
              typename mpl::or_<
                   is_same<PropertyMap,
                           GraphInterface::vertex_index_map_t>,
                   is_same<PropertyMap,
                           GraphInterface::edge_index_map_t> >::type,
              typename mpl::not_<
                  typename mpl::has_key<numpy_types, value_type>::type >
            ::type>::type isnt_vector_map;
        return get_array(_pmap, size, isnt_vector_map());
441
442
443
444
445
446
447
448
449
450
451
452
453
    }

    python::object get_array(PropertyMap pmap, size_t size, mpl::bool_<false>)
    {
        _pmap.reserve(size);
        return wrap_vector_not_owned(_pmap.get_storage());
    }

    python::object get_array(PropertyMap pmap, size_t size, mpl::bool_<true>)
    {
        return python::object();
    }

454
455
456
457
458
459
460
    bool IsWritable() const
    {
        return is_convertible<
            typename property_traits<PropertyMap>::category,
            readable_property_map_tag>::value;
    }

461
private:
462
    PropertyMap _pmap; // hold an internal copy, since it's cheap
463
464
465
};


466
467
468
469
470
471
472
473
474
475
476
477
478
//
// Create new properties
//

struct new_property_map
{
    template <class ValueType, class IndexMap>
    void operator()(ValueType, IndexMap index, const string& type_name,
                    python::object& new_prop, bool& found) const
    {
        size_t i = mpl::find<value_types,ValueType>::type::pos::value;
        if (type_name == type_names[i])
        {
479
480
            typedef typename property_map_type::apply<ValueType, IndexMap>::type
                map_t;
481
482
483
484
485
486
487
488
            map_t prop(index);
            new_prop = python::object(PythonPropertyMap<map_t>(prop));
            found = true;
        }
    }
};

template <class IndexMap>
489
python::object new_property(const string& type, IndexMap index_map)
490
491
492
{
    python::object prop;
    bool found = false;
493
494
    mpl::for_each<value_types>(bind<void>(new_property_map(), _1, index_map,
                                          ref(type), ref(prop), ref(found)));
495
    if (!found)
Tiago Peixoto's avatar
Tiago Peixoto committed
496
        throw ValueException("Invalid property type: " + type);
497
498
499
    return prop;
}

500
501
502
} //graph_tool namespace

#endif