graph_python_interface.hh 14.4 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-2010 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()) &&
90
            (_v < num_vertices(gi._mg));
91
    }
92

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

98
99
100
    void CheckValid() const
    {
        if (!IsValid())
Tiago Peixoto's avatar
Tiago Peixoto committed
101
            throw ValueException("invalid vertex descriptor");
102
    }
103

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

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

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

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

142
    // provide iterator support for out_edges
143

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

268
    GraphInterface::edge_t GetDescriptor() const
269
270
271
272
    {
        return _e;
    }

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

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

294
295
296
    struct get_target
    {
        template<class GraphType>
297
298
299
        void operator()(const GraphType& g, const python::object& pg,
                        const edge_descriptor& edge, python::object& vertex)
            const
300
        {
301
            vertex = python::object(PythonVertex(pg, target(edge, g)));
302
303
        }
    };
304

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

315
316
    std::string GetString() const
    {
317
318
        PythonVertex src = python::extract<PythonVertex>(GetSource());
        PythonVertex tgt = python::extract<PythonVertex>(GetTarget());
319
        return "(" + src.GetString() + "," + tgt.GetString() + ")";
320
321
    }

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

329
    bool operator==(const PythonEdge& other) const
Tiago Peixoto's avatar
Tiago Peixoto committed
330
    {
331
        CheckValid();
332
        other.CheckValid();
333
        return other._e == _e;
Tiago Peixoto's avatar
Tiago Peixoto committed
334
    }
335

336
    bool operator!=(const PythonEdge& other) const
337
    {
338
        CheckValid();
339
        other.CheckValid();
340
        return other._e != _e;
341
342
343
    }

private:
344
    python::object _g;
345
    edge_descriptor _e;
346
    bool _valid;
347
348
};

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

380
381
382
383
384
385
386
    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;

387
    template <class PythonDescriptor>
388
    reference GetValue(const PythonDescriptor& key)
389
    {
390
        key.CheckValid();
391
        return get(_pmap, key.GetDescriptor());
392
393
    }

394
395
    template <class PythonDescriptor>
    void SetValue(const PythonDescriptor& key, const value_type& val)
396
    {
397
398
399
400
        set_value(key, val,
                  is_convertible<
                  typename property_traits<PropertyMap>::category,
                  writable_property_map_tag>());
401
402
    }

403
404
405
    template <class PythonDescriptor>
    void set_value(const PythonDescriptor& key, const value_type& val,
                   true_type)
406
    {
407
408
        key.CheckValid();
        put(_pmap, key.GetDescriptor(), val);
409
410
    }

411
    template <class PythonDescriptor>
412
413
    void set_value(const PythonDescriptor& key, const value_type& val,
                   false_type)
414
    {
Tiago Peixoto's avatar
Tiago Peixoto committed
415
        throw ValueException("property is read-only");
416
417
418
419
    }

    size_t GetHash() const
    {
420
        return hash<size_t>()(size_t(this));
421
422
423
424
    }

    std::string GetType() const
    {
425
426
427
428
429
430
431
        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];
432
433
    }

434
    boost::any GetMap() const
435
436
437
438
    {
        return _pmap;
    }

439
440
441
442
443
444
445
    boost::any GetDynamicMap() const
    {
        return (dynamic_property_map*)
            (new boost::detail::dynamic_property_map_adaptor<PropertyMap>
             (_pmap));
    }

446
447
448
    python::object GetArray(size_t size)
    {
        typedef typename mpl::or_<
449
450
451
452
453
454
455
456
457
              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());
458
459
460
461
462
463
464
465
466
467
468
469
470
    }

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

471
472
473
474
475
476
477
    bool IsWritable() const
    {
        return is_convertible<
            typename property_traits<PropertyMap>::category,
            readable_property_map_tag>::value;
    }

478
private:
479
    PropertyMap _pmap; // hold an internal copy, since it's cheap
480
481
482
};


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

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

517
518
519
} //graph_tool namespace

#endif