ScalarObjective
===============

(class from :py:mod:`pyomo.core.base.objective`)

.. testsetup:: *

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

.. currentmodule:: pyomo.core.base.objective



.. autoclass:: pyomo.core.base.objective::ScalarObjective
   :members:
   :show-inheritance:
   :inherited-members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~ScalarObjective.__init__
      ~ScalarObjective.activate
      ~ScalarObjective.add
      ~ScalarObjective.arg
      ~ScalarObjective.clear
      ~ScalarObjective.clear_suffix_value
      ~ScalarObjective.clone
      ~ScalarObjective.cname
      ~ScalarObjective.construct
      ~ScalarObjective.create_node_with_local_data
      ~ScalarObjective.deactivate
      ~ScalarObjective.dim
      ~ScalarObjective.display
      ~ScalarObjective.get_suffix_value
      ~ScalarObjective.getname
      ~ScalarObjective.id_index_map
      ~ScalarObjective.index
      ~ScalarObjective.index_set
      ~ScalarObjective.is_component_type
      ~ScalarObjective.is_constant
      ~ScalarObjective.is_constructed
      ~ScalarObjective.is_expression_type
      ~ScalarObjective.is_fixed
      ~ScalarObjective.is_indexed
      ~ScalarObjective.is_logical_type
      ~ScalarObjective.is_minimizing
      ~ScalarObjective.is_named_expression_type
      ~ScalarObjective.is_numeric_type
      ~ScalarObjective.is_parameter_type
      ~ScalarObjective.is_potentially_variable
      ~ScalarObjective.is_reference
      ~ScalarObjective.is_relational
      ~ScalarObjective.is_variable_type
      ~ScalarObjective.items
      ~ScalarObjective.iteritems
      ~ScalarObjective.iterkeys
      ~ScalarObjective.itervalues
      ~ScalarObjective.keys
      ~ScalarObjective.model
      ~ScalarObjective.nargs
      ~ScalarObjective.parent_block
      ~ScalarObjective.parent_component
      ~ScalarObjective.polynomial_degree
      ~ScalarObjective.pprint
      ~ScalarObjective.reconstruct
      ~ScalarObjective.root_block
      ~ScalarObjective.set_sense
      ~ScalarObjective.set_suffix_value
      ~ScalarObjective.set_value
      ~ScalarObjective.to_dense_data
      ~ScalarObjective.to_string
      ~ScalarObjective.type
      ~ScalarObjective.valid_model_component
      ~ScalarObjective.values
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~ScalarObjective.PRECEDENCE
      ~ScalarObjective.active
      ~ScalarObjective.args
      ~ScalarObjective.ctype
      ~ScalarObjective.expr
      ~ScalarObjective.local_name
      ~ScalarObjective.name
      ~ScalarObjective.rule
      ~ScalarObjective.sense
   
   

   .. rubric:: Member Documentation