graph_bind.cc 12.8 KB
Newer Older
Tiago Peixoto's avatar
Tiago Peixoto committed
1
2
// graph-tool -- a general graph modification and manipulation thingy
//
3
// Copyright (C) 2007-2010 Tiago de Paula Peixoto <tiago@forked.de>
Tiago Peixoto's avatar
Tiago Peixoto committed
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
Tiago Peixoto's avatar
Tiago Peixoto committed
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
17
// along with this program. If not, see <http://www.gnu.org/licenses/>.

Tiago Peixoto's avatar
Tiago Peixoto committed
18
#include "graph.hh"
19
#define NUMPY_EXPORT
20
#include "graph_python_interface.hh"
21
#include "graph_util.hh"
22
#include "numpy_bind.hh"
Tiago Peixoto's avatar
Tiago Peixoto committed
23

24
25
26
#include <boost/python.hpp>
#include <boost/python/suite/indexing/vector_indexing_suite.hpp>

Tiago Peixoto's avatar
Tiago Peixoto committed
27
28
#ifdef HAVE_SCIPY // integration with scipy weave
#include "weave/scxx/object.h"
29
30
31
32
#include "weave/scxx/list.h"
#include "weave/scxx/tuple.h"
#include "weave/scxx/dict.h"
#include "weave/scxx/str.h"
Tiago Peixoto's avatar
Tiago Peixoto committed
33
34
#endif

Tiago Peixoto's avatar
Tiago Peixoto committed
35
36
37
38
39
using namespace std;
using namespace graph_tool;
using namespace boost;
using namespace boost::python;

40
struct LibInfo
Tiago Peixoto's avatar
Tiago Peixoto committed
41
{
42
43
44
45
46
47
    string GetName()      const {return PACKAGE_NAME;}
    string GetAuthor()    const {return AUTHOR;}
    string GetCopyright() const {return COPYRIGHT;}
    string GetVersion()   const {return VERSION " (commit " GIT_COMMIT
                                        ", " GIT_COMMIT_DATE ")";}
    string GetLicense()   const {return "GPL version 3 or above";}
Tiago Peixoto's avatar
Tiago Peixoto committed
48
    string GetCXXFLAGS()  const {return CPPFLAGS " " CXXFLAGS " " LDFLAGS;}
49
50
    string GetInstallPrefix() const {return INSTALL_PREFIX;}
    string GetPythonDir() const {return PYTHON_DIR;}
Tiago Peixoto's avatar
Tiago Peixoto committed
51
52
53
54
55
56
    string GetGCCVersion() const
    {
        stringstream s;
        s << __GNUC__ << "." << __GNUC_MINOR__ << "." <<  __GNUC_PATCHLEVEL__;
        return s.str();
    }
Tiago Peixoto's avatar
Tiago Peixoto committed
57
58
};

59
60
template <class ValueType>
struct vector_from_list
Tiago Peixoto's avatar
Tiago Peixoto committed
61
{
62
    vector_from_list()
Tiago Peixoto's avatar
Tiago Peixoto committed
63
    {
64
        converter::registry::push_back
65
            (&convertible, &construct,
66
             boost::python::type_id<vector<ValueType> >());
Tiago Peixoto's avatar
Tiago Peixoto committed
67
68
69
70
    }

    static void* convertible(PyObject* obj_ptr)
    {
71
72
        handle<> x(borrowed(obj_ptr));
        object o(x);
73
74
75
76
77
78
79
        size_t N = len(o);
        for (size_t i = 0; i < N; ++i)
        {
            extract<ValueType> elem(o[i]);
            if (!elem.check())
                return 0;
        }
80
        return obj_ptr;
Tiago Peixoto's avatar
Tiago Peixoto committed
81
82
    }

83
    static void construct(PyObject* obj_ptr,
84
                          converter::rvalue_from_python_stage1_data* data)
85
    {
86
87
        handle<> x(borrowed(obj_ptr));
        object o(x);
88
89
90
91
        vector<ValueType> value;
        size_t N = len(o);
        for (size_t i = 0; i < N; ++i)
            value.push_back(extract<ValueType>(o[i]));
92
        void* storage =
93
            ( (boost::python::converter::rvalue_from_python_storage
94
95
               <vector<ValueType> >*) data)->storage.bytes;
        new (storage) vector<ValueType>(value);
96
        data->convertible = storage;
Tiago Peixoto's avatar
Tiago Peixoto committed
97
98
99
    }
};

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
template <class ValueType>
bool vector_equal_compare(const vector<ValueType>& v1,
                          const vector<ValueType>& v2)
{
    if (v1.size() != v2.size())
        return false;
    for (size_t i = 0; i < v1.size(); ++i)
    {
        if (v1[i] != v2[i])
            return false;
    }
    return true;
}

template <class ValueType>
bool vector_nequal_compare(const vector<ValueType>& v1,
                           const vector<ValueType>& v2)
{
    return !vector_equal_compare(v1,v2);
}

121
struct export_vector_types
Tiago Peixoto's avatar
Tiago Peixoto committed
122
{
123
124
    template <class ValueType>
    void operator()(ValueType) const
Tiago Peixoto's avatar
Tiago Peixoto committed
125
    {
126
127
128
129
130
        string type_name = get_type_name<>()(typeid(ValueType));
        if (type_name == "long double")
            type_name = "long_double";
        string name = "Vector_" + type_name;
        class_<vector<ValueType> >(name.c_str())
131
132
133
            .def(vector_indexing_suite<vector<ValueType> >())
            .def("__eq__", &vector_equal_compare<ValueType>)
            .def("__ne__", &vector_nequal_compare<ValueType>);
134
        vector_from_list<ValueType>();
Tiago Peixoto's avatar
Tiago Peixoto committed
135
    }
136
};
Tiago Peixoto's avatar
Tiago Peixoto committed
137

138
139
// exception translation
template <class Exception>
Tiago Peixoto's avatar
Tiago Peixoto committed
140
void graph_exception_translator(const Exception& e)
141
{
Tiago Peixoto's avatar
Tiago Peixoto committed
142
143
144
145
146
147
148
149
150
151
152
    PyObject* error;
    if (is_same<Exception, GraphException>::value)
        error = PyExc_RuntimeError;
    if (is_same<Exception, IOException>::value)
        error = PyExc_IOError;
    if (is_same<Exception, ValueException>::value)
        error = PyExc_ValueError;

    PyObject* message = PyString_FromString(e.what());
    PyObject_SetAttrString(error, "message", message);
    PyErr_SetString(error, e.what());
153
}
Tiago Peixoto's avatar
Tiago Peixoto committed
154

155
156
157
158
void raise_error(const string& msg)
{
    throw GraphException(msg);
}
Tiago Peixoto's avatar
Tiago Peixoto committed
159

160
161
template <class T1, class T2>
struct pair_to_tuple
Tiago Peixoto's avatar
Tiago Peixoto committed
162
{
163
    static PyObject* convert(const pair<T1,T2>& p)
Tiago Peixoto's avatar
Tiago Peixoto committed
164
    {
165
166
        boost::python::tuple t = boost::python::make_tuple(p.first,p.second);
        return incref(t.ptr());
Tiago Peixoto's avatar
Tiago Peixoto committed
167
168
169
    }
};

170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
template <class T1, class T2>
struct pair_from_tuple
{
    pair_from_tuple()
    {
        converter::registry::push_back(&convertible, &construct,
                                       boost::python::type_id<pair<T1,T2> >());
    }

    static void* convertible(PyObject* obj_ptr)
    {
        handle<> x(borrowed(obj_ptr));
        object o(x);
        extract<T1> first(o[0]);
        extract<T2> second(o[1]);
        if (!first.check() || !second.check())
            return 0;
        return obj_ptr;
    }

    static void construct(PyObject* obj_ptr,
                          converter::rvalue_from_python_stage1_data* data)
    {
        handle<> x(borrowed(obj_ptr));
        object o(x);
        pair<T1,T2> value;
        value.first = extract<T1>(o[0]);
        value.second = extract<T2>(o[1]);
        void* storage =
            ( (boost::python::converter::rvalue_from_python_storage
               <pair<T1,T2> >*) data)->storage.bytes;
        new (storage) pair<T1,T2>(value);
        data->convertible = storage;
    }
};

template <class ValueType>
struct variant_from_python
{
    variant_from_python()
    {
        converter::registry::push_back
            (&convertible, &construct,
             boost::python::type_id<GraphInterface::deg_t>());
    }

    static void* convertible(PyObject* obj_ptr)
    {
        handle<> x(borrowed(obj_ptr));
        object o(x);
        extract<ValueType> str(o);
        if (!str.check())
            return 0;
        return obj_ptr;
    }

    static void construct(PyObject* obj_ptr,
                          converter::rvalue_from_python_stage1_data* data)
    {
        handle<> x(borrowed(obj_ptr));
        object o(x);
        ValueType value = extract<ValueType>(o);
        GraphInterface::deg_t deg = value;
        void* storage =
            ( (boost::python::converter::rvalue_from_python_storage
               <GraphInterface::deg_t>*) data)->storage.bytes;
        new (storage) GraphInterface::deg_t(deg);
        data->convertible = storage;
    }
};

Tiago Peixoto's avatar
Tiago Peixoto committed
241
242
// scipy weave integration
#ifdef HAVE_SCIPY
243
template <class ScxxType>
Tiago Peixoto's avatar
Tiago Peixoto committed
244
245
struct scxx_to_python
{
246
    static PyObject* convert(const ScxxType& o)
Tiago Peixoto's avatar
Tiago Peixoto committed
247
248
249
250
251
252
    {
        return incref((PyObject*)(o));
    }
};
#endif

253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
// persistent python object IO
namespace graph_tool
{
extern python::object object_pickler;
extern python::object object_unpickler;
}

void set_pickler(python::object o)
{
    graph_tool::object_pickler = o;
}

void set_unpickler(python::object o)
{
    graph_tool::object_unpickler = o;
}

Tiago Peixoto's avatar
Tiago Peixoto committed
270
271
272
273
274
275
276
277
python::list get_property_types()
{
    python::list plist;
    for (int i = 0; i < mpl::size<value_types>::value; ++i)
        plist.append(string(type_names[i]));
    return plist;
}

Tiago Peixoto's avatar
Tiago Peixoto committed
278
279
280
struct graph_type_name
{
    template <class Graph>
281
    void operator()(const Graph& g, string& name) const
Tiago Peixoto's avatar
Tiago Peixoto committed
282
283
284
285
286
287
288
289
290
    {
        using python::detail::gcc_demangle;
        name = string(gcc_demangle(typeid(Graph).name()));
    }
};

string get_graph_type(GraphInterface& g)
{
    string name;
291
    run_action<>()(g, bind<void>(graph_type_name(), _1, ref(name)))();
Tiago Peixoto's avatar
Tiago Peixoto committed
292
293
294
    return name;
}

Tiago Peixoto's avatar
Tiago Peixoto committed
295
296
297
298
299
300
301
302
303
bool openmp_enabled()
{
    #ifdef USING_OPENMP
    return true;
    #else
    return false;
    #endif
}

304
305
306
307
void ungroup_vector_property(GraphInterface& g, boost::any vector_prop,
                             boost::any prop, size_t pos, bool edge);
void group_vector_property(GraphInterface& g, boost::any vector_prop,
                           boost::any prop, size_t pos, bool edge);
308
void export_python_interface();
309

310
BOOST_PYTHON_MODULE(libgraph_tool_core)
Tiago Peixoto's avatar
Tiago Peixoto committed
311
{
312
313
314
    // numpy
    import_array();

315
    export_python_interface();
Tiago Peixoto's avatar
Tiago Peixoto committed
316

Tiago Peixoto's avatar
Tiago Peixoto committed
317
318
319
320
321
322
    register_exception_translator<GraphException>
        (graph_exception_translator<GraphException>);
    register_exception_translator<IOException>
        (graph_exception_translator<IOException>);
    register_exception_translator<ValueException>
        (graph_exception_translator<ValueException>);
Tiago Peixoto's avatar
Tiago Peixoto committed
323

324
    def("raise_error", &raise_error);
Tiago Peixoto's avatar
Tiago Peixoto committed
325
    def("get_property_types", &get_property_types);
326
    class_<boost::any>("any");
327

328
    def("graph_filtering_enabled", &graph_filtering_enabled);
Tiago Peixoto's avatar
Tiago Peixoto committed
329
    def("openmp_enabled", &openmp_enabled);
330

331
332
333
334
    mpl::for_each<mpl::push_back<scalar_types,string>::type>(export_vector_types());

    class_<GraphInterface>("GraphInterface", init<>())
        .def(init<GraphInterface>())
335
336
337
338
339
340
341
342
343
        .def("GetNumberOfVertices", &GraphInterface::GetNumberOfVertices)
        .def("GetNumberOfEdges", &GraphInterface::GetNumberOfEdges)
        .def("SetDirected", &GraphInterface::SetDirected)
        .def("GetDirected", &GraphInterface::GetDirected)
        .def("SetReversed", &GraphInterface::SetReversed)
        .def("GetReversed", &GraphInterface::GetReversed)
        .def("SetVertexFilterProperty",
             &GraphInterface::SetVertexFilterProperty)
        .def("IsVertexFilterActive", &GraphInterface::IsVertexFilterActive)
344
        .def("SetEdgeFilterProperty",
345
346
347
348
             &GraphInterface::SetEdgeFilterProperty)
        .def("IsEdgeFilterActive", &GraphInterface::IsEdgeFilterActive)
        .def("PurgeVertices",  &GraphInterface::PurgeVertices)
        .def("PurgeEdges",  &GraphInterface::PurgeEdges)
349
        .def("ShiftVertexProperty",  &GraphInterface::ShiftVertexProperty)
350
351
        .def("WriteToFile", &GraphInterface::WriteToFile)
        .def("ReadFromFile",&GraphInterface::ReadFromFile)
352
        .def("DegreeMap", &GraphInterface::DegreeMap)
353
        .def("Clear", &GraphInterface::Clear)
354
355
356
357
358
359
        .def("ClearEdges", &GraphInterface::ClearEdges)
        .def("GetVertexIndex", &GraphInterface::GetVertexIndex)
        .def("GetEdgeIndex", &GraphInterface::GetEdgeIndex)
        .def("GetGraphIndex", &GraphInterface::GetGraphIndex)
        .def("CopyVertexProperty", &GraphInterface::CopyVertexProperty)
        .def("CopyEdgeProperty", &GraphInterface::CopyEdgeProperty);
360

361
362
363
364
    class_<GraphInterface::vertex_index_map_t>("vertex_index_map", no_init);
    class_<GraphInterface::edge_index_map_t>("edge_index_map", no_init);
    class_<GraphInterface::graph_index_map_t>("graph_index_map", no_init);

365
366
367
368
369
    enum_<GraphInterface::degree_t>("Degree")
        .value("In", GraphInterface::IN_DEGREE)
        .value("Out", GraphInterface::OUT_DEGREE)
        .value("Total", GraphInterface::TOTAL_DEGREE);

370
    variant_from_python<boost::any>();
371
    variant_from_python<GraphInterface::degree_t>();
372
    to_python_converter<pair<string,bool>, pair_to_tuple<string,bool> >();
373
    to_python_converter<pair<size_t,size_t>, pair_to_tuple<size_t,size_t> >();
374
    to_python_converter<pair<double,double>, pair_to_tuple<double,double> >();
375
376
    pair_from_tuple<double,double>();
    pair_from_tuple<size_t,size_t>();
Tiago Peixoto's avatar
Tiago Peixoto committed
377
#ifdef HAVE_SCIPY
378
379
380
381
382
    to_python_converter<py::object, scxx_to_python<py::object> >();
    to_python_converter<py::tuple, scxx_to_python<py::tuple> >();
    to_python_converter<py::list, scxx_to_python<py::list> >();
    to_python_converter<py::dict, scxx_to_python<py::dict> >();
    to_python_converter<py::str, scxx_to_python<py::str> >();
Tiago Peixoto's avatar
Tiago Peixoto committed
383
#endif
Tiago Peixoto's avatar
Tiago Peixoto committed
384

385
386
387
388
389
390
    class_<IStream>("IStream", no_init).def("Read", &IStream::Read);
    class_<OStream>("OStream", no_init).def("Write", &OStream::Write).
        def("Flush", &OStream::Flush);
    def("set_pickler", &set_pickler);
    def("set_unpickler", &set_unpickler);

391
392
393
    def("group_vector_property", &group_vector_property);
    def("ungroup_vector_property", &ungroup_vector_property);

Tiago Peixoto's avatar
Tiago Peixoto committed
394
    class_<LibInfo>("mod_info")
395
396
397
        .add_property("name", &LibInfo::GetName)
        .add_property("author", &LibInfo::GetAuthor)
        .add_property("copyright", &LibInfo::GetCopyright)
398
        .add_property("version", &LibInfo::GetVersion)
399
400
401
        .add_property("license", &LibInfo::GetLicense)
        .add_property("cxxflags", &LibInfo::GetCXXFLAGS)
        .add_property("install_prefix", &LibInfo::GetInstallPrefix)
Tiago Peixoto's avatar
Tiago Peixoto committed
402
403
        .add_property("python_dir", &LibInfo::GetPythonDir)
        .add_property("gcc_version", &LibInfo::GetGCCVersion);
Tiago Peixoto's avatar
Tiago Peixoto committed
404
405

    def("get_graph_type", &get_graph_type);
Tiago Peixoto's avatar
Tiago Peixoto committed
406
}
Tiago Peixoto's avatar
Tiago Peixoto committed
407