python-igraph API 参考

python-igraph 中所有类、函数和方法的列表

模块文档

未归档

函数 _construct_graph_from_adjacency_file 基于给定文件的邻接矩阵构造图。
函数 _construct_graph_from_dimacs_file 从符合 DIMACS 最小成本流文件格式的文件中读取图。
函数 _construct_graph_from_file 用于图的统一读取函数。
函数 _construct_graph_from_graphmlz_file 从压缩的 GraphML 文件中读取图。
函数 _construct_graph_from_pickle_file 从 Python pickle 格式读取图
函数 _construct_graph_from_picklez_file 从压缩的 Python pickle 格式读取图,并即时解压缩。
函数 _identify_format _identify_format(filename)
函数 _write_graph_to_adjacency_file 将图的邻接矩阵写入给定的文件
函数 _write_graph_to_dimacs_file 以 DIMACS 格式将图写入给定的文件。
函数 _write_graph_to_file 用于图的统一写入函数。
函数 _write_graph_to_graphmlz_file 将图写入压缩的 GraphML 文件。
函数 _write_graph_to_pickle_file 以 Python pickle 格式保存图
函数 _write_graph_to_picklez_file 以 Python pickle 格式保存图,并使用 gzip 压缩。
def _construct_graph_from_adjacency_file(cls, f, sep=None, comment_char='#', attribute=None, *args, **kwds):

基于给定文件的邻接矩阵构造图。

此处未提及的其他位置参数和关键字参数将完整传递给 Graph.Adjacency

参数
cls未归档
f要读取的文件名或文件对象
sep分隔行中矩阵元素的字符串。None表示任意顺序的空格字符。
comment_char以此字符串开头的行被视为注释。
attribute边属性名称,其中存储了加权邻接矩阵情况下的边权重。如果None,则不存储权重,大于 1 的值被视为边重数。
*args未归档
**kwds未归档
返回值
创建的图
def _construct_graph_from_dimacs_file(cls, f, directed=False):

从符合 DIMACS 最小成本流文件格式的文件中读取图。

有关格式的确切定义,请参见 http://lpsolve.sourceforge.net/5.5/DIMACS.htm

与格式的官方描述相比,存在以下限制

  • igraph 的 DIMACS 读取器在弧定义中仅需要三个字段,描述边的源节点和目标节点及其容量。
  • 源顶点由 FLOW 字段中的“s”标识,目标顶点由“t”标识。
  • 节点索引从 1 开始。仅允许单个源节点和目标节点。
参数
cls未归档
f文件的名称或 Python 文件句柄
有向生成的图是否应为有向图。
返回值
生成的图。源顶点和目标顶点的索引作为图属性附加来源目标,边容量存储在capacity边属性。
def _construct_graph_from_file(cls, f, format=None, *args, **kwds):

用于图的统一读取函数。

此方法尝试识别第一个参数中给出的图的格式,并调用相应的读取器方法。

剩余的参数将没有任何更改地传递给读取器方法。

参数
cls未归档
f包含要加载的图的文件
format文件的格式(如果事先已知)。None表示自动检测。可能的值是"ncol"(NCOL 格式),"lgl"(LGL 格式),"graphdb"(GraphDB 格式),"graphml", "graphmlz"(GraphML 和 gzipped GraphML 格式),"gml"(GML 格式),"net", "pajek"(Pajek 格式),"dimacs"(DIMACS 格式),"edgelist", "edges"之一或"edge"(边列表),"adjacency"(邻接矩阵),"dl"(UCINET 使用的 DL 格式),"pickle"(Python pickle 格式),"picklez"(gzipped Python pickle 格式)
*args未归档
**kwds未归档
引发
IOError如果无法识别文件格式,并且未给出任何格式。
def _construct_graph_from_graphmlz_file(cls, f, index=0):

从压缩的 GraphML 文件中读取图。

参数
cls未归档
f文件的名称
index如果 GraphML 文件包含多个图,则指定应加载的图。图索引从零开始,因此如果要加载第一个图,请在此处指定 0。
返回值
加载的图对象
def _construct_graph_from_pickle_file(cls, fname=None):

从 Python pickle 格式读取图

参数
cls未归档
fname文件的名称、要从中读取的流或包含 pickle 数据的字符串。
返回值
创建的图对象。
def _construct_graph_from_picklez_file(cls, fname):

从压缩的 Python pickle 格式读取图,并即时解压缩。

参数
cls未归档
fname文件的名称或要从中读取的流。
返回值
创建的图对象。
def _identify_format(filename):

_identify_format(filename)

尝试识别存储在给定文件名的文件中的图形格式。它主要根据文件的扩展名(而不是语法评估)来识别大多数文件格式。唯一的例外是邻接矩阵格式和边列表格式:评估文件的前几行以决定两者之间的选择。

参数
filename文件名或文件对象,其name属性已设置。
返回值
文件格式,以字符串表示。
注意
内部函数,不应直接调用。
def _write_graph_to_adjacency_file(graph, f, sep=' ', eol='\n', *args, **kwds):

将图的邻接矩阵写入给定的文件

此处未提及的所有剩余参数将完整传递给 Graph.get_adjacency

参数
未归档
f要写入的文件的名称。
sep分隔行中矩阵元素的字符串
eol分隔矩阵行的字符串。请注意,当且仅当这是一个换行符时,igraph 才能读回写入的邻接矩阵
*args未归档
**kwds未归档
def _write_graph_to_dimacs_file(graph, f, source=None, target=None, capacity='capacity'):

以 DIMACS 格式将图写入给定的文件。

参数
未归档
f要写入的文件的名称或 Python 文件句柄。
来源源顶点 ID。 如果None,igraph 将尝试从来源图属性中推断它。
目标目标顶点 ID。 如果None,igraph 将尝试从目标图属性中推断它。
capacity列表中边的容量或保存容量的边属性的名称。如果没有这样的边属性,则每条边的容量为 1。
def _write_graph_to_file(graph, f, format=None, *args, **kwds):

用于图的统一写入函数。

此方法尝试根据第一个参数中给定的图的格式(基于扩展名)来识别它,并调用相应的写入方法。

其余参数将传递给写入方法,没有任何更改。

参数
未归档
f包含要保存的图的文件
format

文件的格式(如果要覆盖从文件名扩展名确定的格式,或者文件名本身是一个流)。None表示自动检测。可能的值是

  • "adjacency":邻接矩阵格式
  • "dimacs":DIMACS 格式
  • "dot", "graphviz":GraphViz DOT 格式
  • "edgelist", "edges"之一或"edge":数字边列表格式
  • "gml":GML 格式
  • "graphml""graphmlz":标准和 gzip 压缩的 GraphML 格式
  • "gw", "leda", "lgr":LEDA 本机格式
  • "lgl":LGL 格式
  • "ncol":NCOL 格式
  • "net", "pajek":Pajek 格式
  • "pickle", "picklez":标准和 gzip 压缩的 Python pickle 格式
  • "svg":SVG 格式
*args未归档
**kwds未归档
引发
IOError如果无法识别文件格式,并且未给出任何格式。
def _write_graph_to_graphmlz_file(graph, f, compresslevel=9):

将图写入压缩的 GraphML 文件。

该库使用 gzip 压缩算法,因此可以使用常规 gzip 解压缩(例如gunzip之一或zcat来自 Unix 命令行)或 Pythongzip模块解压缩生成的文件。

使用临时文件来存储中间 GraphML 数据,因此请确保您有足够的可用空间来存储解压缩的 GraphML 文件。

参数
未归档
f要写入的文件的名称。
compresslevel压缩级别。1 最快并且产生的压缩最少,而 9 最慢并且产生的压缩最多。
def _write_graph_to_pickle_file(graph, fname=None, version=-1):

以 Python pickle 格式保存图

参数
未归档
fname要保存到的文件的名称或流。如果None,则将图保存到字符串并返回该字符串。
version要使用的 pickle 协议版本。如果为 -1,则使用最高可用协议
返回值
None如果图已成功保存到给定文件,或者如果fname为字符串。None.
def _write_graph_to_picklez_file(graph, fname=None, version=-1):

以 Python pickle 格式保存图,并使用 gzip 压缩。

以这种格式保存比以没有压缩的 Python pickle 格式保存慢一些,但最终文件占用的硬盘空间要少得多。

参数
未归档
fname要保存到的文件的名称或流。
version要使用的 pickle 协议版本。如果为 -1,则使用最高可用协议
返回值
None如果图已成功保存到给定文件。