graph_python_interface.hh 14.8 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-2011 Tiago de Paula Peixoto <tiago@skewed.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
51
    PythonIterator(const python::object& g, std::pair<Iterator,Iterator> e)
        : _g(g), _e(e) {}
52
    Descriptor Next()
53
    {
54
55
        if (_e.first == _e.second)
            python::objects::stop_iteration_error();
56
57
58
59
        if (_g() == python::object())
            throw GraphException("The corresponding graph object has been"
                                 " deleted during iteration!");
        Descriptor e(_g, *_e.first);
60
61
        ++_e.first;
        return e;
62
63
    }
private:
64
    python::object _g;
65
    std::pair<Iterator,Iterator> _e;
Tiago Peixoto's avatar
Tiago Peixoto committed
66
67
68
};


69
// forward declaration of PythonEdge
70
71
template <class Graph>
class PythonEdge;
72

73
// below are classes related to the PythonVertex type
74
class PythonVertex
75
76
{
public:
77
78
    PythonVertex(const python::object& g, GraphInterface::vertex_t v):
        _g(g), _v(v), _valid(true)
79
80
81
82
83
84
    {
        CheckValid();
    }

    bool IsValid() const
    {
85
86
87
        if (_g().ptr() == Py_None)
            return false;
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
88
89
        return _valid &&
            (_v != graph_traits<GraphInterface::multigraph_t>::null_vertex()) &&
Tiago Peixoto's avatar
Tiago Peixoto committed
90
            (_v < num_vertices(gi._state->_mg));
91
    }
92

93
    void SetValid(bool valid)
94
    {
95
96
        _valid = valid;
    }
97

98
99
100
    void CheckValid() const
    {
        if (!IsValid())
101
102
            throw ValueException("invalid vertex descriptor: " +
                                 lexical_cast<string>(_v));
103
    }
104

105
    GraphInterface::vertex_t GetDescriptor() const
106
107
108
109
    {
        return _v;
    }

110
111
112
113
    template <class DegSelector>
    struct get_degree
    {
        template<class Graph>
114
        void operator()(const Graph& g,
115
116
117
                        typename graph_traits<Graph>::vertex_descriptor v,
                        size_t& deg) const
        {
118
            deg = DegSelector()(v, g);
119
120
121
        }
    };

122
    size_t GetInDegree() const
123
    {
124
        CheckValid();
125
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
126
        size_t in_deg;
127
128
129
        run_action<>()(gi, bind<void>(get_degree<in_degreeS>(),
                                      _1, _v,
                                      ref(in_deg)))();
130
        return in_deg;
131
    }
132

133
    size_t GetOutDegree() const
134
    {
135
        CheckValid();
136
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
137
        size_t out_deg;
138
139
        run_action<>()(gi, bind<void>(get_degree<out_degreeS>(), _1, _v,
                                      ref(out_deg)))();
140
        return out_deg;
Tiago Peixoto's avatar
Tiago Peixoto committed
141
142
    }

143
    // provide iterator support for out_edges
144

145
146
147
    struct get_out_edges
    {
        template<class Graph>
148
        void operator()(const Graph& g, const python::object& pg,
149
150
151
152
153
154
155
                        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>
156
                                  (pg, out_edges(v, g)));
157
158
159
160
        }
    };

    python::object
161
    OutEdges() const
Tiago Peixoto's avatar
Tiago Peixoto committed
162
    {
163
        CheckValid();
164
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
165
        python::object iter;
166
167
        run_action<>()(gi, bind<void>(get_out_edges(), _1,
                                      ref(_g), _v, ref(iter)))();
168
        return iter;
169
    }
170

171
172
173
    struct get_in_edges
    {
        template<class Graph>
174
        void operator()(const Graph& g, const python::object& pg,
175
176
177
178
179
180
181
                        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>
182
                 (pg, in_edge_iteratorS<Graph>::get_edges(v, g)));
183
184
185
186
        }
    };

    python::object
187
    InEdges() const
188
    {
189
        CheckValid();
190
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
191
        python::object iter;
192
193
        run_action<>()(gi, bind<void>(get_in_edges(), _1, ref(_g), _v,
                                      ref(iter)))();
194
        return iter;
Tiago Peixoto's avatar
Tiago Peixoto committed
195
    }
196

197
198
    std::string GetString() const
    {
199
        CheckValid();
200
201
202
        return lexical_cast<std::string>(_v);
    }

203
    size_t GetHash() const
204
    {
205
        return hash<size_t>()(_v);
206
207
    }

208
209
    size_t GetIndex() const
    {
210
211
212
        CheckValid();
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
        return gi._vertex_index[_v];
213
214
    }

215
    bool operator==(const PythonVertex& other) const
216
    {
217
218
        CheckValid();
        other.CheckValid();
219
        return other._v == _v;
220
    }
221

222
    bool operator!=(const PythonVertex& other) const
223
    {
224
225
        CheckValid();
        other.CheckValid();
226
        return other._v != _v;
227
228
    }

229
private:
230
    python::object _g;
231
    GraphInterface::vertex_t _v;
232
    bool _valid;
233
};
234

235
// below are classes related to the PythonEdge type
236

237
238
239
240
template <class Graph>
class PythonEdge
{
public:
Tiago Peixoto's avatar
Tiago Peixoto committed
241
    typedef typename graph_traits<Graph>::edge_descriptor edge_descriptor;
242
243
    PythonEdge(const python::object& g, edge_descriptor e)
        : _g(g), _e(e), _valid(true)
244
245
246
247
248
    {
        CheckValid();
    }

    bool IsValid() const
Tiago Peixoto's avatar
Tiago Peixoto committed
249
    {
250
251
252
        if (_g().ptr() == Py_None)
            return false;
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
253
        GraphInterface::edge_t e(_e);
Tiago Peixoto's avatar
Tiago Peixoto committed
254
255
256
        return (_valid &&
                PythonVertex(_g, source(e, gi._state->_mg)).IsValid() &&
                PythonVertex(_g, target(e, gi._state->_mg)).IsValid());
257
258
259
260
261
262
263
264
265
    }

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

    void CheckValid() const
    {
266
        if (!IsValid())
Tiago Peixoto's avatar
Tiago Peixoto committed
267
            throw ValueException("invalid edge descriptor");
Tiago Peixoto's avatar
Tiago Peixoto committed
268
269
    }

270
    GraphInterface::edge_t GetDescriptor() const
271
272
273
274
    {
        return _e;
    }

275
276
277
    struct get_source
    {
        template<class GraphType>
278
        void operator()(const GraphType& g, const python::object& pg,
279
280
281
                        const edge_descriptor& edge, python::object& vertex)
            const
        {
282
283
            typedef typename graph_traits<GraphType>::edge_descriptor edge_t;
            vertex = python::object(PythonVertex(pg, source(edge_t(edge), g)));
284
285
        }
    };
286

287
    python::object GetSource() const
Tiago Peixoto's avatar
Tiago Peixoto committed
288
    {
289
        CheckValid();
290
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
291
        python::object v;
292
293
        run_action<>()(gi, bind<void>(get_source(), _1, ref(_g), ref(_e),
                                      ref(v)))();
294
        return v;
Tiago Peixoto's avatar
Tiago Peixoto committed
295
296
    }

297
298
299
    struct get_target
    {
        template<class GraphType>
300
301
302
        void operator()(const GraphType& g, const python::object& pg,
                        const edge_descriptor& edge, python::object& vertex)
            const
303
        {
304
305
            typedef typename graph_traits<GraphType>::edge_descriptor edge_t;
            vertex = python::object(PythonVertex(pg, target(edge_t(edge), g)));
306
307
        }
    };
308

309
    python::object GetTarget() const
Tiago Peixoto's avatar
Tiago Peixoto committed
310
    {
311
        CheckValid();
312
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
313
        python::object v;
314
315
        run_action<>()(gi, bind<void>(get_target(), _1, ref(_g), ref(_e),
                                      ref(v)))();
316
        return v;
Tiago Peixoto's avatar
Tiago Peixoto committed
317
318
    }

319
320
    std::string GetString() const
    {
321
322
        PythonVertex src = python::extract<PythonVertex>(GetSource());
        PythonVertex tgt = python::extract<PythonVertex>(GetTarget());
323
        return "(" + src.GetString() + ", " + tgt.GetString() + ")";
324
325
    }

326
    size_t GetHash() const
Tiago Peixoto's avatar
Tiago Peixoto committed
327
    {
328
        CheckValid();
329
330
        GraphInterface& gi = python::extract<GraphInterface&>(_g());
        return hash<size_t>()(gi._edge_index[_e]);
Tiago Peixoto's avatar
Tiago Peixoto committed
331
332
    }

333
    bool operator==(const PythonEdge& other) const
Tiago Peixoto's avatar
Tiago Peixoto committed
334
    {
335
        CheckValid();
336
        other.CheckValid();
337
        return other._e == _e;
Tiago Peixoto's avatar
Tiago Peixoto committed
338
    }
339

340
    bool operator!=(const PythonEdge& other) const
341
    {
342
        CheckValid();
343
        other.CheckValid();
344
        return other._e != _e;
345
346
347
    }

private:
348
    python::object _g;
349
    edge_descriptor _e;
350
    bool _valid;
351
352
};

353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
// 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>
378
379
380
class PythonPropertyMap
{
public:
381
382
    PythonPropertyMap(const PropertyMap& pmap)
        : _pmap(pmap) {}
383

384
385
386
387
388
389
390
    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;

391
    template <class PythonDescriptor>
392
    reference GetValue(const PythonDescriptor& key)
393
    {
394
        key.CheckValid();
395
        return get(_pmap, key.GetDescriptor());
396
397
    }

398
399
    // in this case, val should be a copy, not a reference. This is to avoid a
    // problem with vector-valued property maps
400
    template <class PythonDescriptor>
401
    void SetValue(const PythonDescriptor& key, value_type val)
402
    {
403
404
405
406
        set_value(key, val,
                  is_convertible<
                  typename property_traits<PropertyMap>::category,
                  writable_property_map_tag>());
407
408
    }

409
410
411
    template <class PythonDescriptor>
    void set_value(const PythonDescriptor& key, const value_type& val,
                   true_type)
412
    {
413
414
        key.CheckValid();
        put(_pmap, key.GetDescriptor(), val);
415
416
    }

417
    template <class PythonDescriptor>
418
419
    void set_value(const PythonDescriptor& key, const value_type& val,
                   false_type)
420
    {
Tiago Peixoto's avatar
Tiago Peixoto committed
421
        throw ValueException("property is read-only");
422
423
424
425
    }

    size_t GetHash() const
    {
426
        return hash<size_t>()(size_t(this));
427
428
429
430
    }

    std::string GetType() const
    {
431
432
433
434
435
436
437
        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];
438
439
    }

440
    boost::any GetMap() const
441
442
443
444
    {
        return _pmap;
    }

445
446
447
448
449
450
451
    boost::any GetDynamicMap() const
    {
        return (dynamic_property_map*)
            (new boost::detail::dynamic_property_map_adaptor<PropertyMap>
             (_pmap));
    }

452
453
454
    python::object GetArray(size_t size)
    {
        typedef typename mpl::or_<
455
456
457
458
459
460
461
462
463
              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());
464
465
466
467
468
469
470
471
472
473
474
475
476
    }

    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();
    }

477
478
    bool IsWritable() const
    {
479
480
        return is_convertible<typename property_traits<PropertyMap>::category,
                              writable_property_map_tag>::value;
481
482
    }

483
private:
484
    PropertyMap _pmap; // hold an internal copy, since it's cheap
485
486
487
};


488
489
490
491
492
493
494
495
496
497
498
499
500
//
// 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])
        {
501
502
            typedef typename property_map_type::apply<ValueType, IndexMap>::type
                map_t;
503
504
505
506
507
508
509
510
            map_t prop(index);
            new_prop = python::object(PythonPropertyMap<map_t>(prop));
            found = true;
        }
    }
};

template <class IndexMap>
511
python::object new_property(const string& type, IndexMap index_map)
512
513
514
{
    python::object prop;
    bool found = false;
515
516
    mpl::for_each<value_types>(bind<void>(new_property_map(), _1, index_map,
                                          ref(type), ref(prop), ref(found)));
517
    if (!found)
Tiago Peixoto's avatar
Tiago Peixoto committed
518
        throw ValueException("Invalid property type: " + type);
519
520
521
    return prop;
}

522
523
524
} //graph_tool namespace

#endif