graph_python_interface.hh 14.1 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
#include <boost/lambda/bind.hpp>
22
23
#include <boost/graph/graph_traits.hpp>
#include <boost/mpl/logical.hpp>
24
#include <boost/functional/hash.hpp>
25
#include <boost/iterator/iterator_facade.hpp>
26

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

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

35
// this file includes a simple python interface for the internally kept
36
37
38
39
// 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).
40

41
42
43
44
namespace graph_tool
{
using namespace boost;

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


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

71
// below are classes related to the PythonVertex type
72
class PythonVertex
73
74
{
public:
75
    PythonVertex(GraphInterface& gi, GraphInterface::vertex_t v):
76
77
78
79
80
81
82
83
84
85
86
        _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));
    }
87

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

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

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

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

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

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

136
    // provide iterator support for out_edges
137

138
139
140
    struct get_out_edges
    {
        template<class Graph>
141
        void operator()(const Graph& g, GraphInterface& gi,
142
143
144
145
146
147
148
                        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>
149
                                  (gi, out_edges(v, g)));
150
151
152
153
        }
    };

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

164
165
166
    struct get_in_edges
    {
        template<class Graph>
167
        void operator()(const Graph& g, GraphInterface& gi,
168
169
170
171
172
173
174
                        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>
175
                 (gi, in_edge_iteratorS<Graph>::get_edges(v, g)));
176
177
178
179
        }
    };

    python::object
180
    InEdges() const
181
    {
182
        CheckValid();
183
        python::object iter;
184
        run_action<>()(_gi, lambda::bind<void>(get_in_edges(), lambda::_1,
185
186
187
                                               lambda::var(_gi), _v,
                                               lambda::var(iter)))();
        return iter;
Tiago Peixoto's avatar
Tiago Peixoto committed
188
    }
189

190
191
    std::string GetString() const
    {
192
        CheckValid();
193
194
195
        return lexical_cast<std::string>(_v);
    }

196
    size_t GetHash() const
197
    {
198
        return hash<size_t>()(_gi._vertex_index[_v]);
199
200
    }

201
202
203
204
205
    size_t GetIndex() const
    {
        return _gi._vertex_index[_v];
    }

206
    bool operator==(const PythonVertex& other) const
207
    {
208
209
        CheckValid();
        other.CheckValid();
210
        return other._v == _v;
211
    }
212

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

220
private:
221
    GraphInterface& _gi;
222
    GraphInterface::vertex_t _v;
223
    bool _valid;
224
};
225

226
// below are classes related to the PythonEdge type
227

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

    bool IsValid() const
Tiago Peixoto's avatar
Tiago Peixoto committed
240
    {
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
        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
256
            throw ValueException("invalid edge descriptor");
Tiago Peixoto's avatar
Tiago Peixoto committed
257
258
    }

259
    GraphInterface::edge_t GetDescriptor() const
260
261
262
263
    {
        return _e;
    }

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

275
    python::object GetSource() const
Tiago Peixoto's avatar
Tiago Peixoto committed
276
    {
277
        CheckValid();
278
        python::object v;
279
        run_action<>()(_gi, lambda::bind<void>(get_source(), lambda::_1,
280
                                               lambda::var(_gi),
281
                                               lambda::var(_e),
282
283
                                               lambda::var(v)))();
        return v;
Tiago Peixoto's avatar
Tiago Peixoto committed
284
285
    }

286
287
288
    struct get_target
    {
        template<class GraphType>
289
        void operator()(const GraphType& g, GraphInterface& gi,
290
                        const edge_descriptor& edge,
291
292
                        python::object& vertex) const
        {
293
            vertex = python::object(PythonVertex(gi, target(edge, g)));
294
295
        }
    };
296

297
    python::object GetTarget() const
Tiago Peixoto's avatar
Tiago Peixoto committed
298
    {
299
        CheckValid();
300
        python::object v;
301
        run_action<>()(_gi, lambda::bind<void>(get_target(), lambda::_1,
302
303
304
                                               lambda::var(_gi),
                                               lambda::var(_e),
                                               lambda::var(v)))();
305
        return v;
Tiago Peixoto's avatar
Tiago Peixoto committed
306
307
    }

308
309
    std::string GetString() const
    {
310
311
312
        CheckValid();
        PythonVertex src = python::extract<PythonVertex>(GetSource());
        PythonVertex tgt = python::extract<PythonVertex>(GetTarget());
313
        return "(" + src.GetString() + "," + tgt.GetString() + ")";
314
315
    }

316
    size_t GetHash() const
Tiago Peixoto's avatar
Tiago Peixoto committed
317
    {
318
319
        CheckValid();
        return hash<size_t>()(_gi._edge_index[_e]);
Tiago Peixoto's avatar
Tiago Peixoto committed
320
321
    }

322
    bool operator==(const PythonEdge& other) const
Tiago Peixoto's avatar
Tiago Peixoto committed
323
    {
324
        CheckValid();
325
        return other._e == _e;
Tiago Peixoto's avatar
Tiago Peixoto committed
326
    }
327

328
    bool operator!=(const PythonEdge& other) const
329
    {
330
        CheckValid();
331
        return other._e != _e;
332
333
334
    }

private:
335
    GraphInterface& _gi;
336
    edge_descriptor _e;
337
    bool _valid;
338
339
};

340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
// 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>
365
366
367
class PythonPropertyMap
{
public:
368
369
    PythonPropertyMap(const PropertyMap& pmap)
        : _pmap(pmap) {}
370

371
372
373
374
375
376
377
    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;

378
    template <class PythonDescriptor>
379
    reference GetValue(const PythonDescriptor& key)
380
    {
381
        key.CheckValid();
382
        return get(_pmap, key.GetDescriptor());
383
384
    }

385
386
    template <class PythonDescriptor>
    void SetValue(const PythonDescriptor& key, const value_type& val)
387
    {
388
389
390
391
        set_value(key, val,
                  is_convertible<
                  typename property_traits<PropertyMap>::category,
                  writable_property_map_tag>());
392
393
    }

394
395
396
    template <class PythonDescriptor>
    void set_value(const PythonDescriptor& key, const value_type& val,
                   true_type)
397
    {
398
399
        key.CheckValid();
        put(_pmap, key.GetDescriptor(), val);
400
401
    }

402
    template <class PythonDescriptor>
403
404
    void set_value(const PythonDescriptor& key, const value_type& val,
                   false_type)
405
    {
Tiago Peixoto's avatar
Tiago Peixoto committed
406
        throw ValueException("property is read-only");
407
408
409
410
    }

    size_t GetHash() const
    {
411
        return hash<size_t>()(size_t(this));
412
413
414
415
    }

    std::string GetType() const
    {
416
417
418
419
420
421
422
        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];
423
424
    }

425
    boost::any GetMap() const
426
427
428
429
    {
        return _pmap;
    }

430
431
432
433
434
435
436
    boost::any GetDynamicMap() const
    {
        return (dynamic_property_map*)
            (new boost::detail::dynamic_property_map_adaptor<PropertyMap>
             (_pmap));
    }

437
438
439
    python::object GetArray(size_t size)
    {
        typedef typename mpl::or_<
440
441
442
443
444
445
446
447
448
              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());
449
450
451
452
453
454
455
456
457
458
459
460
461
    }

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

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


467
468
469
470
471
472
473
474
475
476
477
478
479
//
// 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])
        {
480
481
            typedef typename property_map_type::apply<ValueType, IndexMap>::type
                map_t;
482
483
484
485
486
487
488
489
            map_t prop(index);
            new_prop = python::object(PythonPropertyMap<map_t>(prop));
            found = true;
        }
    }
};

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

504
505
506
} //graph_tool namespace

#endif