/usr/include/openturns/swig/BipartiteGraph_doc.i is in libopenturns-dev 1.9-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | %feature("docstring") OT::BipartiteGraph
"Bipartite red/black graph.
Available constructors:
BipartiteGraph(*size=0*)
BipartiteGraph(*sequence*)
Parameters
----------
size : int, :math:`size \\\\geq 0`
Size of the collection.
sequence : sequence of :class:`~openturns.Indices`
Cliques of the red nodes.
Notes
-----
A bipartite graph is an undirected graph in which the nodes can be colored in two colors such that no edge has its two ends with the same colors. Here we force the :math:`n` red nodes to be numbered in consecutive order from 0 to :math:`n-1` and for each red node we give the list of black nodes that are the other end of the edges starting from this red node.
Examples
--------
>>> import openturns as ot
Use the first constructor:
>>> ot.BipartiteGraph(3)
[[],[],[]]
Use the second constructor:
>>> graph = ot.BipartiteGraph([[1, 3], [2, 0], [5, 4]])
>>> graph
[[1,3],[2,0],[5,4]]
Use some functionalities:
>>> graph[1] = [3, 4]
>>> graph
[[1,3],[3,4],[5,4]]
>>> graph.add([1, 6])
>>> graph
[[1,3],[3,4],[5,4],[1,6]]"
// ---------------------------------------------------------------------
%feature("docstring") OT::BipartiteGraph::getBlackNodes
"Accessor to the graph black nodes.
Returns
-------
black : sequence of int, :class:`~openturns.Indices`"
// ---------------------------------------------------------------------
%feature("docstring") OT::BipartiteGraph::getRedNodes
"Accessor to the graph red nodes.
Returns
-------
red : sequence of int, :class:`~openturns.Indices`"
// ---------------------------------------------------------------------
%feature("docstring") OT::BipartiteGraph::draw
"Draw the graph.
Returns
-------
graph : a :class:`~openturns.Graph`
View of the bipartite graph as a set of red nodes linked to black nodes."
|