ObjectiveData

(class from pyomo.core.base.objective)

class pyomo.core.base.objective.ObjectiveData(expr=None, sense=ObjectiveSense.minimize, component=None)

Bases: NamedExpressionData, ActiveComponentData

This class defines the data for a single objective.

Note that this is a subclass of NumericValue to allow objectives to be used as part of expressions.

Parameters:

• expr – The Pyomo expression stored in this objective.

• sense – The direction for this objective.

• component (Objective) – The Objective object that owns this data.

expr

The Pyomo expression for this objective

__init__(expr=None, sense=ObjectiveSense.minimize, component=None)

Methods

__init__([expr, sense, component])
activate()	Set the active attribute to True
arg(index)
clear_suffix_value(suffix_or_name[, expand])	Set the suffix value for this component data
clone()	Return a clone of this expression (no-op).
cname(*args, **kwds)	DEPRECATED.
create_node_with_local_data(values[, classtype])	Construct a simple expression after constructing the contained expression.
deactivate()	Set the active attribute to False
get_suffix_value(suffix_or_name[, default])	Get the suffix value for this component data
getname(*args, **kwargs)	If this is a component, return the component's name on the owning block; otherwise return the value converted to a string
index()	Returns the index of this ComponentData instance relative to the parent component index set.
is_component_type()	Return True if this class is a Pyomo component
is_constant()	A boolean indicating whether this expression is constant.
is_expression_type([expression_system])	A boolean indicating whether this in an expression.
is_fixed()	A boolean indicating whether this expression is fixed.
is_indexed()	Return True if this numeric value is an indexed object
is_logical_type()	Return True if this class is a Pyomo Boolean object.
is_minimizing()	Return True if this is a minimization objective.
is_named_expression_type()	A boolean indicating whether this in a named expression.
is_numeric_type()	Return True if this class is a Pyomo numeric object
is_parameter_type()	Return False unless this class is a parameter object
is_potentially_variable()	Return True if variables can appear in this expression
is_reference()	Return True if this object is a reference.
is_relational()	DEPRECATED.
is_variable_type()	Return False unless this class is a variable object
model()	Return the model of the component that owns this data.
nargs()
parent_block()	Return the parent of the component that owns this data.
parent_component()	Returns the component associated with this object.
polynomial_degree()	A tuple of subexpressions involved in this expressions operation.
pprint([ostream, verbose, prefix])	Print component information
set_sense(sense)	Set the sense (direction) of this objective.
set_suffix_value(suffix_or_name, value[, expand])	Set the suffix value for this component data
set_value(expr)	Set the expression on this expression.
to_string([verbose, labeler, smap, ...])	Return a string representation of the expression tree.
type()	DEPRECATED.

Attributes

PRECEDENCE
active	Return the active attribute
args
ctype	Return the class type for this component
expr
local_name	Get the component name only within the context of the immediate parent container.
name	Get the fully qualified component name.
sense	Access sense (direction) of this objective.

Member Documentation

activate()

Set the active attribute to True

clear_suffix_value(suffix_or_name, expand=True)

Set the suffix value for this component data

clone()

Return a clone of this expression (no-op).

cname(*args, **kwds)

DEPRECATED.

Deprecated since version 5.0: The cname() method has been renamed to getname(). The preferred method of obtaining a component name is to use the .name property, which returns the fully qualified component name. The .local_name property will return the component name only within the context of the immediate parent container.

create_node_with_local_data(values, classtype=None)

Construct a simple expression after constructing the contained expression.

This class provides a consistent interface for constructing a node, which is used in tree visitor scripts.

deactivate()

Set the active attribute to False

get_suffix_value(suffix_or_name, default=None)

Get the suffix value for this component data

getname(*args, **kwargs)

If this is a component, return the component’s name on the owning block; otherwise return the value converted to a string

index()

Returns the index of this ComponentData instance relative to the parent component index set. None is returned if this instance does not have a parent component, or if - for some unknown reason - this instance does not belong to the parent component’s index set.

is_component_type()

Return True if this class is a Pyomo component

is_constant()

A boolean indicating whether this expression is constant.

is_expression_type(expression_system=None)

A boolean indicating whether this in an expression.

is_fixed()

A boolean indicating whether this expression is fixed.

is_indexed()

Return True if this numeric value is an indexed object

is_logical_type()

Return True if this class is a Pyomo Boolean object.

Boolean objects include constants, variables, or logical expressions.

is_minimizing()

Return True if this is a minimization objective.

is_named_expression_type()

A boolean indicating whether this in a named expression.

is_numeric_type()

Return True if this class is a Pyomo numeric object

is_parameter_type()

Return False unless this class is a parameter object

is_potentially_variable()

Return True if variables can appear in this expression

is_reference()

Return True if this object is a reference.

is_relational()

DEPRECATED.

Return True if this numeric value represents a relational expression.

Deprecated since version 6.4.3: is_relational() is deprecated in favor of is_expression_type(ExpressionType.RELATIONAL)

is_variable_type()

Return False unless this class is a variable object

model()

Return the model of the component that owns this data.

parent_block()

Return the parent of the component that owns this data.

parent_component()

Returns the component associated with this object.

polynomial_degree()

A tuple of subexpressions involved in this expressions operation.

pprint(ostream=None, verbose=False, prefix='')

Print component information

Note that this method is generally only reachable through ComponentData objects in an IndexedComponent container. Components, including unindexed Component derivatives and both scalar and indexed IndexedComponent derivatives will see Component.pprint()

set_sense(sense)

Set the sense (direction) of this objective.

set_suffix_value(suffix_or_name, value, expand=True)

Set the suffix value for this component data

set_value(expr)

Set the expression on this expression.

to_string(verbose=None, labeler=None, smap=None, compute_values=False)

Return a string representation of the expression tree.

Parameters:

• verbose (bool) – If True, then the string representation consists of nested functions. Otherwise, the string representation is an infix algebraic equation. Defaults to False.

• labeler – An object that generates string labels for non-constant in the expression tree. Defaults to None.

• smap – A SymbolMap instance that stores string labels for non-constant nodes in the expression tree. Defaults to None.

• compute_values (bool) – If True, then fixed expressions are evaluated and the string representation of the resulting value is returned.

Returns:

A string representation for the expression tree.

type()

DEPRECATED.

Return the class type for this component

Deprecated since version 5.7: Component.type() method has been replaced by the .ctype property.

property active

Return the active attribute

property ctype

Return the class type for this component

property local_name

Get the component name only within the context of the immediate parent container.

property name

Get the fully qualified component name.

property sense

Access sense (direction) of this objective.