Results

(class from pyomo.contrib.solver.results)

class pyomo.contrib.solver.results.Results(description=None, doc=None, implicit=False, implicit_domain=None, visibility=0)[source]

Bases: ConfigDict

Base class for all solver results

solution_loader

Object for loading the solution back into the model.

Type:: .SolutionLoaderBase

termination_condition

The reason the solver exited. This is a member of the TerminationCondition enum.

Type:: TerminationCondition

solution_status

The result of the solve call. This is a member of the SolutionStatus enum.

Type:: SolutionStatus

incumbent_objective

If a feasible solution was found, this is the objective value of the best solution found. If no feasible solution was found, this is None.

Type:: float

objective_bound

The best objective bound found. For minimization problems, this is the lower bound. For maximization problems, this is the upper bound. For solvers that do not provide an objective bound, this should be -inf (minimization) or inf (maximization)

Type:: float

solver_name

The name of the solver in use.

Type:: str

solver_version

A tuple representing the version of the solver in use.

Type:: tuple

iteration_count

The total number of iterations.

Type:: int

timing_info

A ConfigDict containing three pieces of information:

start_timestamp: UTC timestamp of when run was initiated

wall_time: elapsed wall clock time for entire process

timer: a HierarchicalTimer object containing timing data about the solve

Specific solvers may add other relevant timing information, as appropriate.

Type:: ConfigDict

extra_info

A ConfigDict to store extra information such as solver messages.

Type:: ConfigDict

solver_configuration

A copy of the SolverConfig ConfigDict, for later inspection/reproducibility.

Type:: ConfigDict

solver_log

(ADVANCED OPTION) Any solver log messages.

Type:: str

__init__(description=None, doc=None, implicit=False, implicit_domain=None, visibility=0)[source]

Methods

`__init__`([description, doc, implicit, ...])
`add`(name, config)
`declare`(name, config)
`declare_as_argument`(args, *kwds)	Map this Config item to an argparse argument.
`declare_from`(other[, skip])
`display`([content_filter, indent_spacing, ...])
`domain_name`()
`generate_documentation`([block_start, ...])
`generate_yaml_template`([indent_spacing, ...])
`get`(k[,d])
`import_argparse`(parsed_args)
`initialize_argparse`(parser)
`items`()
`iteritems`()	DEPRECATED.
`iterkeys`()	DEPRECATED.
`itervalues`()	DEPRECATED.
`keys`()
`name`([fully_qualified])
`reset`()
`set_default_value`(default)
`set_domain`(domain)
`set_value`(value[, skip_implicit])
`setdefault`(key[, default])
`unused_user_values`()
`user_values`()
`value`([accessValue])
`values`()

Attributes

content_filters

Member Documentation

declare_as_argument(*args, **kwds)

Map this Config item to an argparse argument.

Valid arguments include all valid arguments to argparse’s ArgumentParser.add_argument() with the exception of ‘default’. In addition, you may provide a group keyword argument to either pass in a pre-defined option group or subparser, or else pass in the string name of a group, subparser, or (subparser, group).

get(k[, d]) → D[k] if k in D, else d. d defaults to None.

items() → a set-like object providing a view on D's items

iteritems(): DEPRECATED.

Deprecated since version 6.0: The iteritems method is deprecated. Use dict.keys().

iterkeys(): DEPRECATED.

Deprecated since version 6.0: The iterkeys method is deprecated. Use dict.keys().

itervalues(): DEPRECATED.

Deprecated since version 6.0: The itervalues method is deprecated. Use dict.keys().

keys() → a set-like object providing a view on D's keys

values() → an object providing a view on D's values