__init__.py 98 KB
Newer Older
1
#! /usr/bin/env python
2
# -*- coding: utf-8 -*-
3
#
4
5
# graph_tool -- a general graph manipulation python module
#
Tiago Peixoto's avatar
Tiago Peixoto committed
6
# Copyright (C) 2006-2015 Tiago de Paula Peixoto <tiago@skewed.de>
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 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
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

21
"""
Tiago Peixoto's avatar
Tiago Peixoto committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
graph_tool - efficient graph analysis and manipulation
======================================================

Summary
-------

.. autosummary::
   :nosignatures:

   Graph
   GraphView
   Vertex
   Edge
   PropertyMap
   PropertyArray
   load_graph
   group_vector_property
   ungroup_vector_property
40
41
   infect_vertex_property
   edge_difference
Tiago Peixoto's avatar
Tiago Peixoto committed
42
   perfect_prop_hash
Tiago Peixoto's avatar
Tiago Peixoto committed
43
44
45
   value_types
   show_config

Tiago Peixoto's avatar
Tiago Peixoto committed
46
47

This module provides:
48

49
   1. A :class:`~graph_tool.Graph` class for graph representation and manipulation
50
51
   2. Property maps for Vertex, Edge or Graph.
   3. Fast algorithms implemented in C++.
52

53
54
How to use the documentation
----------------------------
55

56
57
Documentation is available in two forms: docstrings provided
with the code, and the full documentation available in
Tiago Peixoto's avatar
Tiago Peixoto committed
58
`the graph-tool homepage <http://graph-tool.skewed.de>`_.
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

We recommend exploring the docstrings using `IPython
<http://ipython.scipy.org>`_, an advanced Python shell with TAB-completion and
introspection capabilities.

The docstring examples assume that ``graph_tool.all`` has been imported as
``gt``::

   >>> import graph_tool.all as gt

Code snippets are indicated by three greater-than signs::

   >>> x = x + 1

Use the built-in ``help`` function to view a function's docstring::

   >>> help(gt.Graph)

Tiago Peixoto's avatar
Tiago Peixoto committed
77
78
Contents
--------
79
"""
80

81
from __future__ import division, absolute_import, print_function
82
83
84
import sys
if sys.version_info < (3,):
    range = xrange
85

Tiago Peixoto's avatar
Tiago Peixoto committed
86
__author__ = "Tiago de Paula Peixoto <tiago@skewed.de>"
Tiago Peixoto's avatar
Tiago Peixoto committed
87
__copyright__ = "Copyright 2006-2015 Tiago de Paula Peixoto"
Tiago Peixoto's avatar
Tiago Peixoto committed
88
__license__ = "GPL version 3 or above"
Tiago Peixoto's avatar
Tiago Peixoto committed
89
__URL__ = "http://graph-tool.skewed.de"
90

91
92
93
94
# import numpy and scipy before everything to avoid weird segmentation faults
# depending on the order things are imported.

import numpy
95
import numpy.ma
96
97
98
import scipy
import scipy.stats

99
100
101

from .dl_import import *
dl_import("from . import libgraph_tool_core as libcore")
Tiago Peixoto's avatar
Tiago Peixoto committed
102
103
__version__ = libcore.mod_info().version

104
from . import io  # sets up libcore io routines
Tiago Peixoto's avatar
Tiago Peixoto committed
105
106
107
108
109
110
111

import sys
import os
import re
import gzip
import weakref
import copy
112
import textwrap
Tiago Peixoto's avatar
Tiago Peixoto committed
113
114
115
116
import io

if sys.version_info < (3,):
    import StringIO
Tiago Peixoto's avatar
Tiago Peixoto committed
117

118
from .decorators import _wraps, _require, _attrs, _limit_args
Tiago Peixoto's avatar
Tiago Peixoto committed
119
from inspect import ismethod
Tiago Peixoto's avatar
Tiago Peixoto committed
120
121

__all__ = ["Graph", "GraphView", "Vertex", "Edge", "Vector_bool",
122
           "Vector_int16_t", "Vector_int32_t", "Vector_int64_t", "Vector_double",
Tiago Peixoto's avatar
Tiago Peixoto committed
123
124
           "Vector_long_double", "Vector_string", "value_types", "load_graph",
           "PropertyMap", "group_vector_property", "ungroup_vector_property",
Tiago Peixoto's avatar
Tiago Peixoto committed
125
126
127
           "infect_vertex_property", "edge_difference", "perfect_prop_hash",
           "seed_rng", "show_config", "PropertyArray", "openmp_enabled",
           "openmp_get_num_threads", "openmp_set_num_threads", "openmp_get_schedule",
128
           "openmp_set_schedule", "__author__", "__copyright__", "__URL__",
Tiago Peixoto's avatar
Tiago Peixoto committed
129
           "__version__"]
Tiago Peixoto's avatar
Tiago Peixoto committed
130

Tiago Peixoto's avatar
Tiago Peixoto committed
131
132
# this is rather pointless, but it works around a sphinx bug
graph_tool = sys.modules[__name__]
Tiago Peixoto's avatar
Tiago Peixoto committed
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

################################################################################
# Utility functions
################################################################################


def _prop(t, g, prop):
    """Return either a property map, or an internal property map with a given
    name."""
    if type(prop) == str:
        try:
            pmap = g.properties[(t, prop)]
        except KeyError:
            raise KeyError("no internal %s property named: %s" %\
                           ("vertex" if t == "v" else \
                            ("edge" if t == "e" else "graph"), prop))
    else:
        pmap = prop
    if pmap == None:
        return libcore.any()
    else:
        if t != prop.key_type():
            names = {'e': 'edge', 'v': 'vertex', 'g': 'graph'}
            raise ValueError("Expected '%s' property map, got '%s'" %
                             (names[t], names[prop.key_type()]))
        return pmap._PropertyMap__map.get_map()


def _degree(g, name):
    """Retrieve the degree type from string, or returns the corresponding
    property map."""
    deg = name
    if name == "in-degree" or name == "in":
        deg = libcore.Degree.In
    elif name == "out-degree" or name == "out":
        deg = libcore.Degree.Out
    elif name == "total-degree" or name == "total":
        deg = libcore.Degree.Total
    else:
        deg = _prop("v", g, deg)
    return deg


def _type_alias(type_name):
    alias = {"int8_t": "bool",
             "boolean": "bool",
179
             "short": "int16_t",
Tiago Peixoto's avatar
Tiago Peixoto committed
180
181
182
             "int": "int32_t",
             "long": "int64_t",
             "long long": "int64_t",
183
             "unsigned long": "int64_t",
Tiago Peixoto's avatar
Tiago Peixoto committed
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
             "object": "python::object",
             "float": "double"}
    if type_name in value_types():
        return type_name
    if type_name in alias:
        return alias[type_name]
    ma = re.compile(r"vector<(.*)>").match(type_name)
    if ma:
        t = ma.group(1)
        if t in alias:
            return "vector<%s>" % alias[t]
    raise ValueError("invalid property value type: " + type_name)


def _python_type(type_name):
    type_name = _type_alias(type_name)
    if "vector" in type_name:
        ma = re.compile(r"vector<(.*)>").match(type_name)
        t = ma.group(1)
        return list, _python_type(t)
    if "int" in type_name:
        return int
    if type_name == "bool":
        return bool
    if "double" in type_name:
        return float
    if "string" in type_name:
        return str
    return object


215
216
217
218
def _gt_type(obj):
    t = type(obj)
    if t is numpy.longlong or t is numpy.uint64:
        return "long long"
219
220
    if issubclass(t, numpy.int16):
        return "short"
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
    if t is int or issubclass(t, numpy.int):
        return "int"
    if t is numpy.float128:
        return "long double"
    if t is float or issubclass(t, numpy.float):
        return "double"
    if t is str:
        return "string"
    if t is bool:
        return "bool"
    if issubclass(t, list) or issubclass(t, numpy.ndarray):
        return "vector<%s>" % _gt_type(obj[0])
    return "object"


236
237
238
239
240
241
def _convert(prop, val):
    # attempt to convert to a compatible python type. This is useful,
    # for instance, when dealing with numpy types.
    vtype = _python_type(prop.value_type())
    if type(vtype) is tuple:
        return [vtype[1](x) for x in val]
242
243
    if vtype is object:
        return val
244
245
246
    return vtype(val)


Tiago Peixoto's avatar
Tiago Peixoto committed
247
248
249
def show_config():
    """Show ``graph_tool`` build configuration."""
    info = libcore.mod_info()
250
251
252
253
254
255
256
257
    print("version:", info.version)
    print("gcc version:", info.gcc_version)
    print("compilation flags:", info.cxxflags)
    print("install prefix:", info.install_prefix)
    print("python dir:", info.python_dir)
    print("graph filtering:", libcore.graph_filtering_enabled())
    print("openmp:", libcore.openmp_enabled())
    print("uname:", " ".join(os.uname()))
Tiago Peixoto's avatar
Tiago Peixoto committed
258

259
260
261
262
263
264
265
def terminal_size():
    import fcntl, termios, struct
    h, w, hp, wp = struct.unpack('HHHH',
        fcntl.ioctl(0, termios.TIOCGWINSZ,
        struct.pack('HHHH', 0, 0, 0, 0)))
    return w, h

Tiago Peixoto's avatar
Tiago Peixoto committed
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
################################################################################
# Property Maps
################################################################################


class PropertyArray(numpy.ndarray):
    """This is a :class:`~numpy.ndarray` subclass which keeps a reference of its :class:`~graph_tool.PropertyMap` owner, and detects if the underlying data has been invalidated."""

    __array_priority__ = -10

    def _get_pmap(self):
        return self._prop_map

    def _set_pmap(self, value):
        self._prop_map = value

    prop_map = property(_get_pmap, _set_pmap,
                        doc=":class:`~graph_tool.PropertyMap` owner instance.")

    def __new__(cls, input_array, prop_map):
        obj = numpy.asarray(input_array).view(cls)
        obj.prop_map = prop_map

        # check if data really belongs to property map
        if (prop_map._get_data().__array_interface__['data'][0] !=
            obj._get_base_data()):
            obj.prop_map = None
293
            # do a copy
Tiago Peixoto's avatar
Tiago Peixoto committed
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
            obj = numpy.asarray(obj)

        return obj

    def _get_base(self):
        base = self
        while base.base is not None:
            base = base.base
        return base

    def _get_base_data(self):
        return self._get_base().__array_interface__['data'][0]

    def _check_data(self):
        if self.prop_map is None:
            return

        data = self.prop_map._get_data()

        if (data is None or
            data.__array_interface__['data'][0] != self._get_base_data()):
            raise ValueError(("The graph correspondig to the underlying" +
                              " property map %s has changed. The" +
                              " PropertyArray at 0x%x is no longer valid!") %
                             (repr(self.prop_map), id(self)))

    def __array_finalize__(self, obj):
        if type(obj) is PropertyArray:
            obj._check_data()

        if obj is not None:
            # inherit prop_map only if the data is the same
            if (type(obj) is PropertyArray and
                self._get_base_data() == obj._get_base_data()):
                self.prop_map = getattr(obj, 'prop_map', None)
            else:
                self.prop_map = None
        self._check_data()

    def __array_prepare__(self, out_arr, context=None):
        self._check_data()
        return numpy.ndarray.__array_prepare__(self, out_arr, context)

    def __array_wrap__(self, out_arr, context=None):
        #demote to ndarray
        obj = numpy.ndarray.__array_wrap__(self, out_arr, context)
        return numpy.asarray(obj)

    # Overload members and operators to add data checking

    def _wrap_method(method):
        method = getattr(numpy.ndarray, method)

        def checked_method(self, *args, **kwargs):
            self._check_data()
            return method(self, *args, **kwargs)

        if ismethod(method):
            checked_method = _wraps(method)(checked_method)
        checked_method.__doc__ = getattr(method, "__doc__", None)
        return checked_method

    for method in ['all', 'any', 'argmax', 'argmin', 'argsort', 'astype',
                   'byteswap', 'choose', 'clip', 'compress', 'conj',
                   'conjugate', 'copy', 'cumprod', 'cumsum', 'diagonal', 'dot',
                   'dump', 'dumps', 'fill', 'flat', 'flatten', 'getfield',
                   'imag', 'item', 'itemset', 'itemsize', 'max', 'mean', 'min',
                   'newbyteorder', 'nonzero', 'prod', 'ptp', 'put', 'ravel',
                   'real', 'repeat', 'reshape', 'resize', 'round',
                   'searchsorted', 'setfield', 'setflags', 'sort', 'squeeze',
                   'std', 'sum', 'swapaxes', 'take', 'tofile', 'tolist',
                   'tostring', 'trace', 'transpose', 'var', 'view',
                   '__getitem__']:
        if hasattr(numpy.ndarray, method):
            locals()[method] = _wrap_method(method)


class PropertyMap(object):
    """This class provides a mapping from vertices, edges or whole graphs to arbitrary properties.

374
375
376
    See :ref:`sec_property_maps` for more details.

    The possible property value types are listed below.
Tiago Peixoto's avatar
Tiago Peixoto committed
377
378
379
380
381
382
383

    .. table::

        =======================     ======================
         Type name                  Alias
        =======================     ======================
        ``bool``                    ``uint8_t``
384
        ``int16_t``                 ``short``
Tiago Peixoto's avatar
Tiago Peixoto committed
385
386
387
388
389
390
        ``int32_t``                 ``int``
        ``int64_t``                 ``long``, ``long long``
        ``double``                  ``float``
        ``long double``
        ``string``
        ``vector<bool>``            ``vector<uint8_t>``
391
        ``vector<int16_t>``         ``short``
Tiago Peixoto's avatar
Tiago Peixoto committed
392
393
394
395
396
397
398
399
        ``vector<int32_t>``         ``vector<int>``
        ``vector<int64_t>``         ``vector<long>``, ``vector<long long>``
        ``vector<double>``          ``vector<float>``
        ``vector<long double>``
        ``vector<string>``
        ``python::object``          ``object``
        =======================     ======================
    """
400
    def __init__(self, pmap, g, key_type):
Tiago Peixoto's avatar
Tiago Peixoto committed
401
402
        self.__map = pmap
        self.__g = weakref.ref(g)
403
404
405
406
407
408
409
410
        self.__base_g = lambda: None
        try:
            if isinstance(g, GraphView):
                self.__base_g = weakref.ref(g.base)  # keep reference to the
                                                     # base graph, in case the
                                                     # graph view is deleted.
        except NameError:
            pass  # ignore if GraphView is yet undefined
Tiago Peixoto's avatar
Tiago Peixoto committed
411
412
413
        self.__key_type = key_type
        self.__register_map()

414
415
416
417
418
419
420
    def __key_trans(self, key):
        if self.key_type() == "g":
            return key._Graph__graph
        else:
            return key


Tiago Peixoto's avatar
Tiago Peixoto committed
421
    def __register_map(self):
422
423
        for g in [self.__g(), self.__base_g()]:
            if g is not None:
424
                g._Graph__known_properties[id(self)] = weakref.ref(self)
Tiago Peixoto's avatar
Tiago Peixoto committed
425
426

    def __unregister_map(self):
427
        for g in [self.__g(), self.__base_g()]:
428
            if g is not None and id(self) in g._Graph__known_properties:
429
                del g._Graph__known_properties[id(self)]
Tiago Peixoto's avatar
Tiago Peixoto committed
430
431
432
433
434
435
436
437
438
439
440
441

    def __del__(self):
        self.__unregister_map()

    def __getitem__(self, k):
        return self.__map[self.__key_trans(k)]

    def __setitem__(self, k, v):
        key = self.__key_trans(k)
        try:
            self.__map[key] = v
        except TypeError:
442
            self.__map[key] = _convert(self, v)
Tiago Peixoto's avatar
Tiago Peixoto committed
443
444
445
446
447
448
449
450
451

    def __repr__(self):
        # provide some more useful information
        if self.key_type() == "e":
            k = "Edge"
        elif self.key_type() == "v":
            k = "Vertex"
        else:
            k = "Graph"
452
        g = self.get_graph()
Tiago Peixoto's avatar
Tiago Peixoto committed
453
454
455
456
        if g == None:
            g = "a non-existent graph"
        else:
            g = "Graph 0x%x" % id(g)
457
458
459
460
        try:
            vals = ", with values:\n%s" % str(self.fa)
        except ValueError:
            vals = ""
Tiago Peixoto's avatar
Tiago Peixoto committed
461
        return ("<PropertyMap object with key type '%s' and value type '%s',"
462
463
                + " for %s, at 0x%x%s>") % (k, self.value_type(), g, id(self),
                                            vals)
Tiago Peixoto's avatar
Tiago Peixoto committed
464

465
466
467
468
    def copy(self, value_type=None):
        """Return a copy of the property map. If ``value_type`` is specified,
        the value type is converted to the chosen type."""
        return self.get_graph().copy_property(self, value_type=value_type)
469

470
471
472
    def __copy__(self):
        return self.copy()

Tiago Peixoto's avatar
Tiago Peixoto committed
473
474
    def get_graph(self):
        """Get the graph class to which the map refers."""
475
476
477
478
        g = self.__g()
        if g is None:
            g = self.__base_g()
        return g
Tiago Peixoto's avatar
Tiago Peixoto committed
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494

    def key_type(self):
        """Return the key type of the map. Either 'g', 'v' or 'e'."""
        return self.__key_type

    def value_type(self):
        """Return the value type of the map."""
        return self.__map.value_type()

    def python_value_type(self):
        """Return the python-compatible value type of the map."""
        return _python_type(self.__map.value_type())

    def get_array(self):
        """Get a :class:`~graph_tool.PropertyArray` with the property values.

495
496
497
498
        .. note::

           An array is returned *only if* the value type of the property map is
           a scalar. For vector, string or object types, ``None`` is returned
499
500
501
           instead. For vector and string objects, indirect array access is
           provided via the :func:`~graph_tool.PropertyMap.get_2d_array()` and
           :func:`~graph_tool.PropertyMap.set_2d_array()` member functions.
502
503

        .. warning::
Tiago Peixoto's avatar
Tiago Peixoto committed
504
505
506
507
508
509
510
511
512

           The returned array does not own the data, which belongs to the
           property map. Therefore, if the graph changes, the array may become
           *invalid* and any operation on it will fail with a
           :class:`ValueError` exception. Do **not** store the array if
           the graph is to be modified; store a **copy** instead.
        """
        a = self._get_data()
        if a is None:
513
            raise ValueError("Cannot get array for value type: " + self.value_type())
Tiago Peixoto's avatar
Tiago Peixoto committed
514
515
516
        return PropertyArray(a, prop_map=self)

    def _get_data(self):
517
518
        g = self.get_graph()
        if g is None:
519
            raise ValueError("Cannot get array for an orphaned property map")
Tiago Peixoto's avatar
Tiago Peixoto committed
520
        if self.__key_type == 'v':
521
            n = g._Graph__graph.GetNumberOfVertices(False)
Tiago Peixoto's avatar
Tiago Peixoto committed
522
        elif self.__key_type == 'e':
523
            n = g.max_edge_index
Tiago Peixoto's avatar
Tiago Peixoto committed
524
525
526
527
528
529
        else:
            n = 1
        a = self.__map.get_array(n)
        return a

    def __set_array(self, v):
530
531
        a = self.get_array()
        a[:] = v
Tiago Peixoto's avatar
Tiago Peixoto committed
532

533
    a = property(get_array, __set_array,
Tiago Peixoto's avatar
Tiago Peixoto committed
534
                 doc=r"""Shortcut to the :meth:`~PropertyMap.get_array` method
535
536
537
538
                 as an attribute. This makes assignments more convenient, e.g.:

                 >>> g = gt.Graph()
                 >>> g.add_vertex(10)
Tiago Peixoto's avatar
Tiago Peixoto committed
539
                 <...>
540
541
542
543
544
545
546
547
548
549
550
551
552
553
                 >>> prop = g.new_vertex_property("double")
                 >>> prop.a = np.random.random(10)           # Assignment from array
                 """)

    def __get_set_f_array(self, v=None, get=True):
        g = self.get_graph()
        if g is None:
            return None
        a = self.get_array()
        filt = [None]
        if self.__key_type == 'v':
            filt = g.get_vertex_filter()
        elif self.__key_type == 'e':
            filt = g.get_edge_filter()
554
555
556
            if g.get_vertex_filter()[0] is not None:
                filt = (g.new_edge_property("bool"), filt[1])
                u = GraphView(g, directed=True, skip_properties=True)
557
                libcore.mark_edges(u._Graph__graph, _prop("e", u, filt[0]))
558
559
                if filt[1]:
                    filt[0].a = 1 - filt[0].a
560
561
562
563
            elif g._get_max_edge_index() != g.num_edges():
                filt = (g.new_edge_property("bool"), False)
                u = GraphView(g, directed=True, skip_properties=True)
                libcore.mark_edges(u._Graph__graph, _prop("e", u, filt[0]))
564
        if get:
565
566
567
568
            if a is None:
                return a
            if filt[0] is None:
                return a
569
570
            return a[filt[0].a == (not filt[1])]
        else:
571
572
573
            if a is None:
                return
            if filt[0] is None:
574
575
576
577
                try:
                    a[:] = v
                except ValueError:
                    a[:] = v[:len(a)]
578
            else:
579
580
581
582
583
                m = filt[0].a == (not filt[1])
                try:
                    a[m] = v
                except ValueError:
                    a[m] = v[:len(m)][m]
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607

    fa = property(__get_set_f_array,
                  lambda self, v: self.__get_set_f_array(v, False),
                  doc=r"""The same as the :attr:`~PropertyMap.a` attribute, but
                  instead an *indexed* array is returned, which contains only
                  entries for vertices/edges which are not filtered out. If
                  there are no filters in place, the array is not indexed, and
                  is identical to the :attr:`~PropertyMap.a` attribute.

                  Note that because advanced indexing is triggered, a **copy**
                  of the array is returned, not a view, as for the
                  :attr:`~PropertyMap.a` attribute. Nevertheless, the assignment
                  of values to the *whole* array at once works as expected.""")

    def __get_set_m_array(self, v=None, get=True):
        g = self.get_graph()
        if g is None:
            return None
        a = self.get_array()
        filt = [None]
        if self.__key_type == 'v':
            filt = g.get_vertex_filter()
        elif self.__key_type == 'e':
            filt = g.get_edge_filter()
608
609
610
611
612
613
            if g.get_vertex_filter()[0] is not None:
                filt = (g.new_edge_property("bool"), filt[1])
                u = GraphView(g, directed=True, skip_properties=True)
                libcore.mark_edges(u._Graph__graph, _prop("e", g, filt[0]))
                if filt[1]:
                    filt[0].a = 1 - filt[0].a
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
        if filt[0] is None or a is None:
            if get:
                return a
            else:
                return
        ma = numpy.ma.array(a, mask=(filt[0].a == False) if not filt[1] else (filt[0].a == True))
        if get:
            return ma
        else:
            ma[:] = v

    ma = property(__get_set_m_array,
                  lambda self, v: self.__get_set_m_array(v, False),
                  doc=r"""The same as the :attr:`~PropertyMap.a` attribute, but
                  instead a :class:`~numpy.ma.MaskedArray` object is returned,
                  which contains only entries for vertices/edges which are not
                  filtered out. If there are no filters in place, a regular
                  :class:`~graph_tool.PropertyArray` is returned, which is
                  identical to the :attr:`~PropertyMap.a` attribute.""")
Tiago Peixoto's avatar
Tiago Peixoto committed
633

634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
    def get_2d_array(self, pos):
        r"""Return a two-dimensional array with a copy of the entries of the
        vector-valued property map. The parameter ``pos`` must be a sequence of
        integers which specifies the indexes of the property values which will
        be used. """

        if self.key_type() == "g":
            raise ValueError("Cannot create multidimensional array for graph property maps.")
        if "vector" not in self.value_type() and (len(pos) > 1 or pos[0] != 0):
            raise ValueError("Cannot create array of dimension %d (indexes %s) from non-vector property map of type '%s'." \
                             % (len(pos), str(pos), self.value_type()))
        if "string" in self.value_type():
            if "vector" in self.value_type():
                p = ungroup_vector_property(self, pos)
            else:
                p = [self]
            g = self.get_graph()
            if self.key_type() == "v":
                N = g.num_vertices()
            else:
                N = g.num_edges()
            a = [["" for j in range(N)] for i in range(len(p))]
            if self.key_type() == "v":
                iters = g.vertices()
            else:
                iters = g.edges()
            for v in iters:
                for i in range(len(p)):
                    a[i][int(v)] = p[i][v]
            if len(a) == 1:
                a = a[0]
            return numpy.array(a)
666
667
668
669

        try:
            return numpy.array(self.fa)
        except ValueError:
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
            p = ungroup_vector_property(self, pos)
            return numpy.array([x.a for x in p])

    def set_2d_array(self, a, pos=None):
        r"""Set the entries of the vector-valued property map from a
        two-dimensional array ``a``. If given, the parameter ``pos`` must be a
        sequence of integers which specifies the indexes of the property values
        which will be set."""

        if self.key_type() == "g":
            raise ValueError("Cannot set multidimensional array for graph property maps.")
        if "vector" not in self.value_type():
            if len(a.shape) != 1:
                raise ValueError("Cannot set array of shape %s to non-vector property map of type %s" % \
                                 (str(a.shape), self.value_type()))
            if self.value_type() != "string":
                self.fa = a
            else:
                g = self.get_graph()
                if self.key_type() == "v":
                    iters = g.vertices()
                else:
                    iters = g.edges()
                for i, v in enumerate(iters):
                    self[v] = a[i]
            return

        val = self.value_type()[7:-1]
        ps = []
        for i in range(a.shape[0]):
            ps.append(self.get_graph().new_property(self.key_type(), val))
            if self.value_type() != "string":
                ps[-1].fa = a[i]
            else:
                g = self.get_graph()
                if self.key_type() == "v":
                    iters = g.vertices()
                else:
                    iters = g.edges()
                for j, v in enumerate(iters):
                    ps[-1][v] = a[i, j]
        group_vector_property(ps, val, self, pos)

Tiago Peixoto's avatar
Tiago Peixoto committed
713
714
715
716
    def is_writable(self):
        """Return True if the property is writable."""
        return self.__map.is_writable()

717
718
719
720
721
    def __call__(self, a):
        p = self.copy()
        p.fa = a
        return p

722
723
    def __getstate__(self):
        g = self.get_graph()
724
725
        if g is None:
            raise ValueError("cannot pickle orphaned property map")
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
        value_type = self.value_type()
        key_type = self.key_type()
        if not self.is_writable():
            vals = None
        else:
            u = GraphView(g, skip_vfilt=True, skip_efilt=True)
            if key_type == "v":
                vals = [_convert(self, self[v]) for v in u.vertices()]
            elif key_type == "e":
                vals = [_convert(self, self[e]) for e in u.edges()]
            else:
                vals = _convert(self, self[g])

        state = dict(g=g, value_type=value_type,
                     key_type=key_type, vals=vals,
                     is_vindex=self is g.vertex_index,
                     is_eindex=self is g.edge_index)

        return state

    def __setstate__(self, state):
        g = state["g"]
        key_type = state["key_type"]
        value_type = state["value_type"]
        vals = state["vals"]

        if state["is_vindex"]:
            pmap = g.vertex_index
        elif state["is_eindex"]:
            pmap = g.edge_index
        else:
            u = GraphView(g, skip_vfilt=True, skip_efilt=True)
            if key_type == "v":
                pmap = g.new_vertex_property(value_type)
                for i, v in enumerate(u.vertices()):
                    pmap[v] = vals[i]
            elif key_type == "e":
                pmap = g.new_edge_property(value_type)
                for i, e in enumerate(u.edges()):
                    pmap[e] = vals[i]
            else:
                pmap = g.new_graph_property(value_type)
                pmap[g] = vals

        self.__map = pmap.__map
        self.__g = pmap.__g
        self.__base_g = pmap.__base_g
        self.__key_type = key_type
        self.__register_map()

Tiago Peixoto's avatar
Tiago Peixoto committed
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828

def _check_prop_writable(prop, name=None):
    if not prop.is_writable():
        raise ValueError("property map%s is not writable." %\
                         ((" '%s'" % name) if name != None else ""))


def _check_prop_scalar(prop, name=None, floating=False):
    scalars = ["bool", "int32_t", "int64_t", "unsigned long",
               "double", "long double"]
    if floating:
        scalars = ["double", "long double"]

    if prop.value_type() not in scalars:
        raise ValueError("property map%s is not of scalar%s type." %\
                         (((" '%s'" % name) if name != None else ""),
                          (" floating" if floating else "")))


def _check_prop_vector(prop, name=None, scalar=True, floating=False):
    scalars = ["bool", "int32_t", "int64_t", "unsigned long",
               "double", "long double"]
    if not scalar:
        scalars += ["string"]
    if floating:
        scalars = ["double", "long double"]
    vals = ["vector<%s>" % v for v in scalars]
    if prop.value_type() not in vals:
        raise ValueError("property map%s is not of vector%s type." %\
                         (((" '%s'" % name) if name != None else ""),
                          (" floating" if floating else "")))


def group_vector_property(props, value_type=None, vprop=None, pos=None):
    """Group list of properties ``props`` into a vector property map of the same type.

    Parameters
    ----------
    props : list of :class:`~graph_tool.PropertyMap`
        Properties to be grouped.
    value_type : string (optional, default: None)
        If supplied, defines the value type of the grouped property.
    vprop : :class:`~graph_tool.PropertyMap` (optional, default: None)
        If supplied, the properties are grouped into this property map.
    pos : list of ints (optional, default: None)
        If supplied, should contain a list of indexes where each corresponding
        element of ``props`` should be inserted.

    Returns
    -------
    vprop : :class:`~graph_tool.PropertyMap`
       A vector property map with the grouped values of each property map in
       ``props``.
829
830
831
832
833
834

    Examples
    --------
    >>> from numpy.random import seed, randint
    >>> from numpy import array
    >>> seed(42)
Tiago Peixoto's avatar
Tiago Peixoto committed
835
    >>> gt.seed_rng(42)
836
    >>> g = gt.random_graph(100, lambda: (3, 3))
837
838
    >>> props = [g.new_vertex_property("int") for i in range(3)]
    >>> for i in range(3):
839
840
    ...    props[i].a = randint(0, 100, g.num_vertices())
    >>> gprop = gt.group_vector_property(props)
841
    >>> print(gprop[g.vertex(0)].a)
Tiago Peixoto's avatar
Tiago Peixoto committed
842
    [51 25  8]
843
    >>> print(array([p[g.vertex(0)] for p in props]))
Tiago Peixoto's avatar
Tiago Peixoto committed
844
    [51 25  8]
Tiago Peixoto's avatar
Tiago Peixoto committed
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
    """
    g = props[0].get_graph()
    vtypes = set()
    keys = set()
    for i, p in enumerate(props):
        if "vector" in p.value_type():
            raise ValueError("property map 'props[%d]' is a vector property." %
                             i)
        vtypes.add(p.value_type())
        keys.add(p.key_type())
    if len(keys) > 1:
        raise ValueError("'props' must be of the same key type.")
    k = keys.pop()

    if vprop == None:
        if value_type == None and len(vtypes) == 1:
            value_type = vtypes.pop()

        if value_type != None:
            value_type = "vector<%s>" % value_type
            if k == 'v':
                vprop = g.new_vertex_property(value_type)
            elif k == 'e':
                vprop = g.new_edge_property(value_type)
            else:
                vprop = g.new_graph_property(value_type)
        else:
            ValueError("Can't automatically determine property map value" +
                       " type. Please provide the 'value_type' parameter.")
    _check_prop_vector(vprop, name="vprop", scalar=False)

    for i, p in enumerate(props):
        if k != "g":
878
879
            u = GraphView(g, directed=True, reversed=g.is_reversed(),
                          skip_properties=True)
880
            libcore.group_vector_property(u._Graph__graph, _prop(k, g, vprop),
Tiago Peixoto's avatar
Tiago Peixoto committed
881
882
883
884
                                          _prop(k, g, p),
                                          i if pos == None else pos[i],
                                          k == 'e')
        else:
885
            vprop[g][i if pos is None else pos[i]] = p[g]
Tiago Peixoto's avatar
Tiago Peixoto committed
886
887
888
889
890
891
    return vprop


def ungroup_vector_property(vprop, pos, props=None):
    """Ungroup vector property map ``vprop`` into a list of individual property maps.

892
    Parameters
Tiago Peixoto's avatar
Tiago Peixoto committed
893
894
895
    ----------
    vprop : :class:`~graph_tool.PropertyMap`
        Vector property map to be ungrouped.
896
897
898
    pos : list of ints
        A list of indexes corresponding to where each element of ``vprop``
        should be inserted into the ungrouped list.
Tiago Peixoto's avatar
Tiago Peixoto committed
899
900
901
902
903
904
905
906
    props : list of :class:`~graph_tool.PropertyMap`  (optional, default: None)
        If supplied, should contain a list of property maps to which ``vprop``
        should be ungroupped.

    Returns
    -------
    props : list of :class:`~graph_tool.PropertyMap`
       A list of property maps with the ungrouped values of ``vprop``.
907
908
909
910
911
912

    Examples
    --------
    >>> from numpy.random import seed, randint
    >>> from numpy import array
    >>> seed(42)
Tiago Peixoto's avatar
Tiago Peixoto committed
913
    >>> gt.seed_rng(42)
914
915
916
917
918
    >>> g = gt.random_graph(100, lambda: (3, 3))
    >>> prop = g.new_vertex_property("vector<int>")
    >>> for v in g.vertices():
    ...    prop[v] = randint(0, 100, 3)
    >>> uprops = gt.ungroup_vector_property(prop, [0, 1, 2])
919
    >>> print(prop[g.vertex(0)].a)
Tiago Peixoto's avatar
Tiago Peixoto committed
920
    [51 92 14]
921
    >>> print(array([p[g.vertex(0)] for p in uprops]))
Tiago Peixoto's avatar
Tiago Peixoto committed
922
    [51 92 14]
Tiago Peixoto's avatar
Tiago Peixoto committed
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
    """

    g = vprop.get_graph()
    _check_prop_vector(vprop, name="vprop", scalar=False)
    k = vprop.key_type()
    value_type = vprop.value_type().split("<")[1].split(">")[0]
    if props == None:
        if k == 'v':
            props = [g.new_vertex_property(value_type) for i in pos]
        elif k == 'e':
            props = [g.new_edge_property(value_type) for i in pos]
        else:
            props = [g.new_graph_property(value_type) for i in pos]

    for i, p in enumerate(pos):
        if props[i].key_type() != k:
            raise ValueError("'props' must be of the same key type as 'vprop'.")

        if k != 'g':
942
943
944
            u = GraphView(g, directed=True, reversed=g.is_reversed(),
                          skip_properties=True)
            libcore.ungroup_vector_property(u._Graph__graph,
Tiago Peixoto's avatar
Tiago Peixoto committed
945
946
947
948
949
950
951
952
953
954
                                            _prop(k, g, vprop),
                                            _prop(k, g, props[i]),
                                            p, k == 'e')
        else:
            if len(vprop[g]) <= pos[i]:
                vprop[g].resize(pos[i] + 1)
            props[i][g] = vprop[g][pos[i]]
    return props


955
956
957
958
959
960
961
962
963
964
965
966
967
968
def infect_vertex_property(g, prop, vals=None):
    """Propagate the `prop` values of vertices with value `val` to all their
    out-neighbours.

    Parameters
    ----------
    prop : :class:`~graph_tool.PropertyMap`
        Property map to be modified.
    vals : list (optional, default: `None`)
        List of values to be propagated. If not provided, all values
        will be propagated.

    Returns
    -------
969
    None : ``None``
970
971
972
973
974

    Examples
    --------
    >>> from numpy.random import seed
    >>> seed(42)
Tiago Peixoto's avatar
Tiago Peixoto committed
975
    >>> gt.seed_rng(42)
976
    >>> g = gt.random_graph(100, lambda: (3, 3))
Tiago Peixoto's avatar
Tiago Peixoto committed
977
    >>> prop = g.vertex_index.copy("int32_t")
978
    >>> gt.infect_vertex_property(g, prop, [10])
979
    >>> print(sum(prop.a == 10))
Tiago Peixoto's avatar
Tiago Peixoto committed
980
    4
981
982
983
984
    """
    libcore.infect_vertex_property(g._Graph__graph, _prop("v", g, prop),
                                   vals)

Tiago Peixoto's avatar
Tiago Peixoto committed
985
986
987
988
989
990
991
992
993
994

def edge_difference(g, prop, ediff=None):
    """Return an edge property map corresponding to the difference between the
    values of `prop` of target and source vertices of each edge.

    Parameters
    ----------
    prop : :class:`~graph_tool.PropertyMap`
        Vertex property map to be used to compute the difference..
    ediff : :class:`~graph_tool.PropertyMap` (optional, default: `None`)
995
        If provided, the difference values will be stored in this property map.
Tiago Peixoto's avatar
Tiago Peixoto committed
996
997
998
999
1000

    Returns
    -------
    ediff : :class:`~graph_tool.PropertyMap`
        Edge differences.
For faster browsing, not all history is shown. View entire blame