ScalarParam
===========

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

.. testsetup:: *

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

.. currentmodule:: pyomo.core.base.param



.. autoclass:: pyomo.core.base.param::ScalarParam
   :members:
   :show-inheritance:
   :inherited-members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~ScalarParam.__init__
      ~ScalarParam.clear
      ~ScalarParam.clear_suffix_value
      ~ScalarParam.cname
      ~ScalarParam.construct
      ~ScalarParam.default
      ~ScalarParam.dim
      ~ScalarParam.display
      ~ScalarParam.extract_values
      ~ScalarParam.extract_values_sparse
      ~ScalarParam.get_suffix_value
      ~ScalarParam.get_units
      ~ScalarParam.getname
      ~ScalarParam.id_index_map
      ~ScalarParam.index
      ~ScalarParam.index_set
      ~ScalarParam.is_component_type
      ~ScalarParam.is_constant
      ~ScalarParam.is_constructed
      ~ScalarParam.is_expression_type
      ~ScalarParam.is_fixed
      ~ScalarParam.is_indexed
      ~ScalarParam.is_logical_type
      ~ScalarParam.is_named_expression_type
      ~ScalarParam.is_numeric_type
      ~ScalarParam.is_parameter_type
      ~ScalarParam.is_potentially_variable
      ~ScalarParam.is_reference
      ~ScalarParam.is_relational
      ~ScalarParam.is_variable_type
      ~ScalarParam.items
      ~ScalarParam.iteritems
      ~ScalarParam.iterkeys
      ~ScalarParam.itervalues
      ~ScalarParam.keys
      ~ScalarParam.model
      ~ScalarParam.parent_block
      ~ScalarParam.parent_component
      ~ScalarParam.polynomial_degree
      ~ScalarParam.pprint
      ~ScalarParam.reconstruct
      ~ScalarParam.root_block
      ~ScalarParam.set_default
      ~ScalarParam.set_suffix_value
      ~ScalarParam.set_value
      ~ScalarParam.sparse_items
      ~ScalarParam.sparse_iteritems
      ~ScalarParam.sparse_iterkeys
      ~ScalarParam.sparse_itervalues
      ~ScalarParam.sparse_keys
      ~ScalarParam.sparse_values
      ~ScalarParam.store_values
      ~ScalarParam.to_dense_data
      ~ScalarParam.to_string
      ~ScalarParam.type
      ~ScalarParam.valid_model_component
      ~ScalarParam.values
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~ScalarParam.DefaultMutable
      ~ScalarParam.active
      ~ScalarParam.ctype
      ~ScalarParam.local_name
      ~ScalarParam.mutable
      ~ScalarParam.name
      ~ScalarParam.value
   
   

   .. rubric:: Member Documentation