python-igraph API 参考

模块文档

无法在其他地方分类的实用函数。

类	`multidict`	类似于字典的对象，经过自定义以处理同一键的多个值。
函数	`consecutive_pairs`	从给定的可迭代对象中返回连续的项目对。
函数	`dbl_epsilon`	逼近双精度的机器epsilon值。
函数	`named_temporary_file`	上下文管理器，用于创建命名的临时文件并返回其名称。
函数	`numpy_to_contiguous_memoryview`	将 NumPy 数组或矩阵转换为连续的 memoryview 对象，该对象适合转发到 Graph 构造函数。
函数	`rescale`	将数字列表重新缩放到给定的范围。
函数	`safemax`	更安全的变体`max()`如果可迭代对象为空，则返回默认值。
函数	`safemin`	更安全的变体`min()`如果可迭代对象为空，则返回默认值。
函数	`_is_running_in_ipython`	内部函数，用于确定 igraph 是否在 IPython 中运行。

def consecutive_pairs(iterable, circular=False): ¶

从给定的可迭代对象中返回连续的项目对。

当circular是True时，还会返回由最后一个和第一个元素组成的对。

示例

>>> list(consecutive_pairs(range(5)))
[(0, 1), (1, 2), (2, 3), (3, 4)]
>>> list(consecutive_pairs(range(5), circular=True))
[(0, 1), (1, 2), (2, 3), (3, 4), (4, 0)]
>>> list(consecutive_pairs([]))
[]
>>> list(consecutive_pairs([], circular=True))
[]
>>> list(consecutive_pairs([0]))
[]
>>> list(consecutive_pairs([0], circular=True))
[(0, 0)]

def dbl_epsilon(): ¶

逼近双精度的机器epsilon值。

@contextmanager
def named_temporary_file(*args, **kwds): ¶

上下文管理器，用于创建命名的临时文件并返回其名称。

所有参数都传递给tempfile.mkstemp，有关更多信息，请参阅其文档。

def numpy_to_contiguous_memoryview(obj): ¶

将 NumPy 数组或矩阵转换为连续的 memoryview 对象，该对象适合转发到 Graph 构造函数。

这在内部用于允许我们在构造 Graph 时直接使用 NumPy 数组或矩阵。

def rescale(values, out_range=(0.0, 1.0), in_range=None, clamp=False, scale=None): ¶

将数字列表重新缩放到给定的范围。

out_range给出输出值的范围；默认情况下，列表中原始数字的最小值将映射到输出范围中的第一个元素，最大值将映射到第二个元素。输入列表中最小值和最大值之间的元素将在输出范围的第一个值和第二个值之间线性插值。

in_range可用于覆盖哪些数字映射到输出范围的第一个和第二个值。这也必须是一个元组，其中第一个元素将映射到输出范围的第一个元素，第二个元素将映射到第二个元素。

如果clamp是True，在给定的out_range之后超出范围的元素将被钳制到输出范围，以确保结果中没有数字超出范围out_range。

如果scale不是None，它将被调用于values的每个元素，并且将在结果上进行重新缩放。例如，这可用于变换原始值的对数而不是实际值。一个典型的用例是将一系列值以对数刻度映射到颜色标识符。缩放也适用于in_range参数（如果存在）。

示例

>>> rescale(range(5), (0, 8))
[0.0, 2.0, 4.0, 6.0, 8.0]
>>> rescale(range(5), (2, 10))
[2.0, 4.0, 6.0, 8.0, 10.0]
>>> rescale(range(5), (0, 4), (1, 3))
[-2.0, 0.0, 2.0, 4.0, 6.0]
>>> rescale(range(5), (0, 4), (1, 3), clamp=True)
[0.0, 0.0, 2.0, 4.0, 4.0]
>>> rescale([0]*5, (1, 3))
[2.0, 2.0, 2.0, 2.0, 2.0]
>>> from math import log10
>>> rescale([1, 10, 100, 1000, 10000], (0, 8), scale=log10)
[0.0, 2.0, 4.0, 6.0, 8.0]
>>> rescale([1, 10, 100, 1000, 10000], (0, 4), (10, 1000), scale=log10)
[-2.0, 0.0, 2.0, 4.0, 6.0]

参数
values	未归档
out_range	输出值的范围
in_range	输入值的范围；这是映射到的范围`out_range`. `None`意味着分别使用输入的最小值和最大值。
clamp	指定当输入值落在`in_range`. `True`之外时要执行的操作；这意味着将值钳制到`in_range`, `的边界；`意味着不钳制。
scale	在将输入值映射到输出范围之前对其执行的可选转换。

def safemax(iterable, default=0): ¶

更安全的变体max()如果可迭代对象为空，则返回默认值。

示例

>>> safemax([-5, 6, 4])
6
>>> safemax([])
0
>>> safemax((), 2)
2

def safemin(iterable, default=0): ¶

更安全的变体min()如果可迭代对象为空，则返回默认值。

示例

>>> safemin([-5, 6, 4])
-5
>>> safemin([])
0
>>> safemin((), 2)
2

def _is_running_in_ipython(): ¶

内部函数，用于确定 igraph 是否在 IPython 中运行。

igraph.utils

`igraph.utils`