TupleContainer

(class from pyomo.core.kernel.tuple_container)

class pyomo.core.kernel.tuple_container.TupleContainer(*args)

Bases: IHomogeneousContainer, Sequence

A partial implementation of the IHomogeneousContainer interface that provides tuple-like storage functionality.

Complete implementations need to set the _ctype property at the class level and initialize the remaining ICategorizedObject attributes during object creation. If using __slots__, a slot named “_data” must be included.

Note that this implementation allows nested storage of other ICategorizedObjectContainer implementations that are defined with the same ctype.

__init__(*args)

Methods

__init__(*args)
activate([shallow])	Activate this container.
child(key)	Get the child object associated with a given storage key for this container.
children()	A generator over the children of this container.
clone()	Returns a copy of this object with the parent pointer set to None.
components([active])	Generates an efficient traversal of all components stored under this container.
count(value)
deactivate([shallow])	Deactivate this container.
getname([fully_qualified, name_buffer, ...])	Dynamically generates a name for this object.
index(value, [start, [stop]])	Raises ValueError if the value is not present.

Attributes

active	The active status of this object.
ctype	The object's category type.
local_name	The object's local name within the context of its parent.
name	The object's fully qualified name.
parent	The object's parent (possibly None).
storage_key	The object's storage key within its parent

Member Documentation

activate(shallow=True)

Activate this container.

child(key)

Get the child object associated with a given storage key for this container.

Raises:

KeyError – if the argument is not a storage key for any children of this container

children()

A generator over the children of this container.

clone()

Returns a copy of this object with the parent pointer set to None.

A clone is almost equivalent to deepcopy except that any categorized objects encountered that are not descendents of this object will reference the same object on the clone.

components(active=True)

Generates an efficient traversal of all components stored under this container. Components are categorized objects that are either (1) not containers, or (2) are heterogeneous containers.

Parameters:

active (True/None) – Controls whether or not to filter the iteration to include only the active part of the storage tree. The default is True. Setting this keyword to None causes the active status of objects to be ignored.

Returns:

iterator of components in the storage tree

count(value) → integer -- return number of occurrences of value

deactivate(shallow=True)

Deactivate this container.

getname(fully_qualified=False, name_buffer={}, convert=<class 'str'>, relative_to=None)

Dynamically generates a name for this object.

Parameters:

• fully_qualified (bool) – Generate a full name by iterating through all ancestor containers. Default is False.

• convert (function) – A function that converts a storage key into a string representation. Default is the built-in function str.

• relative_to – When generating a fully qualified name, generate the name relative to this block.

Returns:

If a parent exists, this method returns a string representing the name of the object in the context of its parent; otherwise (if no parent exists), this method returns None.

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

property active

The active status of this object.

property ctype

The object’s category type.

property local_name

The object’s local name within the context of its parent. Alias for obj.getname(fully_qualified=False).

property name

The object’s fully qualified name. Alias for obj.getname(fully_qualified=True).

property parent

The object’s parent (possibly None).

property storage_key

The object’s storage key within its parent