Complementarity
===============

(class from :py:mod:`pyomo.mpec.complementarity`)

.. testsetup:: *

   # import everything from the module containing this class so that
   # doctests for the class docstrings see the correct environment
   from pyomo.mpec.complementarity import *
   try:
       from pyomo.mpec.complementarity import _autosummary_doctest_setup
       _autosummary_doctest_setup()
   except ImportError:
       pass

.. currentmodule:: pyomo.mpec.complementarity



.. autoclass:: pyomo.mpec.complementarity::Complementarity
   :members:
   :show-inheritance:
   :inherited-members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~Complementarity.__init__
      ~Complementarity.activate
      ~Complementarity.add
      ~Complementarity.clear
      ~Complementarity.clear_suffix_value
      ~Complementarity.cname
      ~Complementarity.construct
      ~Complementarity.deactivate
      ~Complementarity.dim
      ~Complementarity.display
      ~Complementarity.get_suffix_value
      ~Complementarity.getname
      ~Complementarity.id_index_map
      ~Complementarity.index_set
      ~Complementarity.is_component_type
      ~Complementarity.is_constructed
      ~Complementarity.is_expression_type
      ~Complementarity.is_indexed
      ~Complementarity.is_logical_type
      ~Complementarity.is_named_expression_type
      ~Complementarity.is_numeric_type
      ~Complementarity.is_parameter_type
      ~Complementarity.is_reference
      ~Complementarity.is_variable_type
      ~Complementarity.items
      ~Complementarity.iteritems
      ~Complementarity.iterkeys
      ~Complementarity.itervalues
      ~Complementarity.keys
      ~Complementarity.model
      ~Complementarity.parent_block
      ~Complementarity.parent_component
      ~Complementarity.pprint
      ~Complementarity.reconstruct
      ~Complementarity.register_private_data_initializer
      ~Complementarity.root_block
      ~Complementarity.set_suffix_value
      ~Complementarity.set_value
      ~Complementarity.to_dense_data
      ~Complementarity.type
      ~Complementarity.valid_model_component
      ~Complementarity.values
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~Complementarity.active
      ~Complementarity.ctype
      ~Complementarity.local_name
      ~Complementarity.name
   
   

   .. rubric:: Member Documentation