comando package

Subpackages

• comando.interfaces package
  • Submodules
    • comando.interfaces.baron module
      • BaronParser
      • apply_cse()
      • baron_pow_callback()
      • con_name()
      • constraints_section()
      • get_results()
      • get_times_and_bounds()
      • handle_tanh()
      • normalize()
      • objective_section()
      • options_section()
      • solve()
      • start_section()
      • var_name()
      • variables_section()
      • write_bar_file()
    • comando.interfaces.dyos module
    • comando.interfaces.gams module
      • GamsParser
      • gams_pow_callback()
      • get_results()
      • literal()
      • populate_sym_map()
      • solve()
      • write_equations_section()
      • write_gms_file()
      • write_objective()
      • write_parameters_section()
      • write_sets_section()
      • write_variables_section()
    • comando.interfaces.gurobi module
    • comando.interfaces.maingo_ale module
      • AleParser
      • call_maingo()
      • get_results()
      • maingo_pow_callback()
      • solve()
      • write_ale_file()
      • write_settings_file()
    • comando.interfaces.maingo_api module
    • comando.interfaces.modelica module
      • ModelicaParser
      • Modifier
      • raise_()
      • write_mo_file()
    • comando.interfaces.pyomo module
    • comando.interfaces.pyomo_dae module
    • comando.interfaces.quboify module
    • comando.interfaces.scip module
  • Module contents

Submodules

• comando.core module
  • Component
    • Component.add_connector()
    • Component.add_connectors()
    • Component.add_eq_constraint()
    • Component.add_expression()
    • Component.add_ge_constraint()
    • Component.add_input()
    • Component.add_le_constraint()
    • Component.add_output()
    • Component.constraints
    • Component.constraints_dict
    • Component.declare_state()
    • Component.design_variables
    • Component.design_variables_dict
    • Component.existing_components
    • Component.expressions
    • Component.expressions_dict
    • Component.get_expression()
    • Component.label
    • Component.make_design_variable()
    • Component.make_operational_variable()
    • Component.make_parameter()
    • Component.make_state()
    • Component.operational_variables
    • Component.operational_variables_dict
    • Component.parameters
    • Component.parameters_dict
    • Component.states
    • Component.states_dict
  • Connector
  • ConnectorUnion
    • ConnectorUnion.expr
  • DataProxy
    • DataProxy.Callable
    • DataProxy.Optional
    • DataProxy.getter
    • DataProxy.setter
  • DiscretizationParameters
  • ImpossibleConstraintException
  • Parameter
    • Parameter.elements
    • Parameter.expand()
    • Parameter.expansion
    • Parameter.indices
    • Parameter.is_indexed
    • Parameter.items
    • Parameter.parent
    • Parameter.value
  • Problem
    • Problem.T
    • Problem.add_symbols()
    • Problem.data
    • Problem.design
    • Problem.design_objective
    • Problem.get_constraint_violations()
    • Problem.index
    • Problem.initial_states
    • Problem.load_variable_values()
    • Problem.num_cons
    • Problem.num_vars
    • Problem.objective
    • Problem.operation
    • Problem.operational_objective
    • Problem.scenario_weights
    • Problem.scenarios
    • Problem.store_variable_values()
    • Problem.subs()
    • Problem.timesteps
    • Problem.weighted_sum()
  • SlotSerializationMixin
  • Symbol
    • Symbol.is_indexed
    • Symbol.value
  • System
    • System.add()
    • System.aggregate_component_expressions()
    • System.close_connector()
    • System.components
    • System.connect()
    • System.constraints
    • System.constraints_dict
    • System.create_problem()
    • System.design_variables
    • System.design_variables_dict
    • System.detach()
    • System.expose_connector()
    • System.expressions
    • System.expressions_dict
    • System.extend_connection()
    • System.get_open_connectors()
    • System.operational_variables
    • System.operational_variables_dict
    • System.parameters
    • System.parameters_dict
    • System.remove()
    • System.states
    • System.states_dict
  • Variable
    • Variable.bounds
    • Variable.discretization
    • Variable.domain
    • Variable.fix()
    • Variable.init_val
    • Variable.is_binary
    • Variable.is_integer
    • Variable.is_negative
    • Variable.is_nonnegative
    • Variable.is_nonpositive
    • Variable.is_positive
    • Variable.lb
    • Variable.parent
    • Variable.ub
    • Variable.unfix()
    • Variable.value
  • VariableVector
    • VariableVector.bounds
    • VariableVector.discretization
    • VariableVector.domain
    • VariableVector.elements
    • VariableVector.expansion
    • VariableVector.fix()
    • VariableVector.indices
    • VariableVector.init_val
    • VariableVector.instantiate()
    • VariableVector.is_binary
    • VariableVector.is_expanded
    • VariableVector.is_indexed
    • VariableVector.is_integer
    • VariableVector.is_negative
    • VariableVector.is_nonnegative
    • VariableVector.is_nonpositive
    • VariableVector.is_positive
    • VariableVector.items
    • VariableVector.lb
    • VariableVector.ub
    • VariableVector.unfix()
    • VariableVector.value
  • is_trivial()
• comando.linearization module
• comando.utility module
  • DefaultStringMap
  • RootFindingError
  • StrParser
    • StrParser.cached_parse()
    • StrParser.parse_args()
  • as_numer_denom()
  • bEq()
  • bGe()
  • bLe()
  • bounds()
  • bounds_cost_turton()
  • canonical_file_name()
  • check_reuse_or_overwrite()
  • cleanup()
  • cont_univ_bounds()
  • define_function()
  • depth()
  • evaluate()
  • floor_substitute_bounds()
  • fuzzy_not()
  • get_index()
  • get_latest()
  • get_pars()
  • get_type_name()
  • get_vars()
  • handle_state_equations()
  • identity()
  • is_indexed()
  • is_negated()
  • lambdify()
  • lmtd_bounds()
  • make_function()
  • make_mayer_objective()
  • make_str_func()
  • make_tac_objective()
  • mul_bounds()
  • parse()
  • pow_bounds()
  • precedence()
  • prod()
  • prod_bounds()
  • rlmtd_bounds()
  • silence()
  • smooth_abs()
  • smooth_max()
  • smooth_min()
  • split()
  • str_parse()
  • sum_bounds()
  • syscall()
• comando.visualization module

Module contents

Configuration of the backends for COMANDO.

class comando.Domain(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Simple Enum for variable domains, specify other types via bounds.

BINARY = 3

INTEGER = 2

REAL = 1

class comando.Symbol(name, **assumptions)

Bases: SlotSerializationMixin, Symbol

A placeholder for a value which can occur within expressions.

property is_indexed

Check if the Symbol is indexed.

property value

Get the Symbol’s value.

comando.evaluate(expr, idx=None)

Evaluate the given expression at the symbols’ current values.

Note

To allow for indexed espressions to be evaluated, evaluate uses numpy and thus double arithmetic instead of the arbitrary precision arithmetic usually used by sympy or symengine backends. This can result in different results in comparison to those obtained by other tools such as solvers or AMLs interfaced to COMANDO.

Arguments:

• expr (comando.Expr) – The expression to be evaluated

• idx (double, str, list, tuple) – The index at which to evaluate

• returns

• result (float or pandas.Series) – The numerical result of the evaluation

comando.prod(*args)

Return the product of the elements in args.

class comando.Parameter(name, value=nan, parent=None)

Bases: Symbol

A Symbol representing a parameter whose value is known.

property elements

expand(data)

Expand the Parameter with indexed data.

expansion

property indices

property is_indexed

Check whether the Parameter is indexed or not.

property items

property parent

Return the parent of this parameter.

property value

Return the value or values of the Parameter.

class comando.Variable(name, domain=Domain.REAL, bounds=(None, None), discretization: DiscretizationParameters = None, init_val=None, indexed=False, parent=None)

Bases: Symbol

A Symbol representing a variable whose value is unknown.

property bounds

property discretization

property domain

fix(value=None)

Fix the variable by setting both bounds to value.

property init_val

property is_binary

property is_integer

property is_negative

Check if all possible values of the variable are negative.

We can assert negativity if the upper bound is negative, otherwise we can assert nonnegativity if the lower bound is nonnegative. If we cannot assert either of these facts, the variable may contain both positive and negative values. To reflect this we return None.

property is_nonnegative

Check if all possible values of the variable are negative.

This is the fuzzy not of self.is_negative

property is_nonpositive

Check if all possible values of the variable are negative.

This is the fuzzy not of self.is_negative

property is_positive

Check if all possible values of the variable are positive.

We can assert positivity if the lower bound is positive, otherwise we can assert nonpositivity if the upper bound is nonpositive. If we cannot assert either of these facts, the variable may contain both positive and negative values. To reflect this we return None.

property lb

property parent

Return the parent of this variable.

property ub

unfix()

Recover the original bounds.

property value

Get the Symbol’s value.

class comando.VariableVector(name, domain=Domain.REAL, bounds=(None, None), discretization: DiscretizationParameters = None, init_val=None)

Bases: Symbol

A Symbol representing a vector of Variables.

property bounds

property discretization

property domain

property elements

expansion

fix(value=None)

Fix self.elements by setting both bounds to value.

property indices

property init_val

instantiate(index)

Create Variable instances for every element in index.

property is_binary

property is_expanded

property is_indexed

Check if the Symbol is indexed.

property is_integer

property is_negative

Check if all possible values of the variable are negative.

We can assert negativity if the upper bound is negative, otherwise we can assert nonnegativity if the lower bound is nonnegative. If we cannot assert either of these facts, the variable may contain both positive and negative values. To reflect this we return None.

property is_nonnegative

Check if all possible values of the variable are negative.

This is the fuzzy not of self.is_negative

property is_nonpositive

Check if all possible values of the variable are negative.

This is the fuzzy not of self.is_negative

property is_positive

Check if all possible values of the variable are positive.

We can assert positivity if the lower bound is positive, otherwise we can assert nonpositivity if the upper bound is nonpositive. If we cannot assert either of these facts, the variable may contain both positive and negative values. To reflect this we return None.

property items

property lb

property ub

unfix()

Recover the original bounds.

property value

Get the Symbol’s value.