validate_array

(函数来自 pyomo.contrib.pyros.uncertainty_sets)

pyomo.contrib.pyros.uncertainty_sets.validate_array(arr, arr_name, dim, valid_types, valid_type_desc=None, required_shape=None, required_shape_qual='')[source]

验证类似数组对象的形状和条目类型。

Parameters:

  • arr (array_like) – 要验证的对象。

  • arr_name (str) – 用于验证对象的名称/描述符。 通常，这是对象属性的名称， 数组将被设置到该属性。

  • dim (int) – 数组类对象的必需维度。

  • valid_types (set[type]) – 数组中每个条目允许的类型。

  • valid_type_desc (str 或 None, 可选) – 允许类型的描述符。

  • required_shape (list 或 None, 可选) – 指定数组在每个维度的长度。 如果提供 None，则不施加任何规范。 如果提供 list，则列表中的每个条目必须是 一个 int，指定与条目位置对应的维度中的所需长度， 或 None（表示对应维度中的长度没有要求）。

  • required_shape_qual (str, optional) – 表达arr应为required_shape形状的原因的条款/短语，例如“以匹配集合维度”。

Raises:

ValueError – 如果arr转换到的Numpy数组的形状不是required_shape。