NamedExpressionData

(class from pyomo.core.base.expression)

class pyomo.core.base.expression.NamedExpressionData

Bases: NumericValue

An object that defines a generic “named expression”.

This is the base class for both ExpressionData and ObjectiveData.

__init__()

Methods

__init__()
arg(index)
clone()	Return a clone of this expression (no-op).
create_node_with_local_data(values[, classtype])	Construct a simple expression after constructing the contained expression.
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
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_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
nargs()
polynomial_degree()	A tuple of subexpressions involved in this expressions operation.
set_value(expr)	Set the expression on this expression.
to_string([verbose, labeler, smap, ...])	Return a string representation of the expression tree.

Attributes

PRECEDENCE
args
expr
local_name
name

Member Documentation

clone()

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

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.

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

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_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

polynomial_degree()

A tuple of subexpressions involved in this expressions operation.

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.