Changeset 3103


Ignore:
Timestamp:
Oct 15, 2010 12:26:20 AM (11 years ago)
Author:
wehart
Message:

Adding documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • coopr.pyomo/trunk/coopr/pyomo/base/numvalue.py

    r3071 r3103  
    3434def value(obj):
    3535    """
    36     A utility function that returns the value of an expression
    37         # NOTE: This is a terminal class, so no need to pop the keyword/argument
    38         #       I would actually argue that we just need to make the inputs named
    39         #       keywords, to by-pass all of this overhead.    """
     36    A utility function that returns the value of a Pyomo object or expression.
     37
     38    If the argument is None, a numeric value or a string, then this function simply
     39    returns the argument.  Otherwise, if the argument is a NumericValue then the
     40    __call__ method is executed.
     41    """
    4042    if obj is None:
    4143        return None
Note: See TracChangeset for help on using the changeset viewer.