get_index_set_except

(function from pyomo.dae.set_utils)

pyomo.dae.set_utils.get_index_set_except(comp, *sets)[source]

Function for getting indices of a component over a product of its indexing sets other than those specified. Indices for the specified sets can be used to construct indices of the proper dimension for the original component via the index_getter function.

Parameters:

comp – Component whose indexing sets are to be manipulated
sets – Sets to omit from the set_except product

Returns:

A dictionary. Maps ‘set_except’ to a Pyomo Set or SetProduct of comp’s index set, excluding those in sets. Maps ‘index_getter’ to a function that returns an index of the proper dimension for comp, given an element of set_except and a value for each set excluded. These values must be provided in the same order their Sets were provided in the sets argument.