Package transsys :: Module optim :: Class OptimisationResult
[hide private]
[frames] | no frames]

Class OptimisationResult

source code

object --+
         |
        OptimisationResult

Base class for returning results of an optimisation.

An optimisation result consists of the optimised version of the transsys program, its objective function value, and, optionally, an optimisation log.

The optimisation log is a list of optimisation records with a structure that depends on the optimiser. Optimisation records can be printed on a line, and they provide a table header. This allows the optimisation log to be dumped in a format ready for R's read.table function.

Nested Classes [hide private]
  recordClass
class of the records in the log list
Instance Methods [hide private]
 
__init__(self, tp, objectiveOptimum, optimisation_log=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
write_log(self, f, column_prefix='', write_header=True, header_prefix='') source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables [hide private]
  objectiveOptimum
The result of evaluating the optimised transsys program using the objective function.
  optimisation_log
A trace of the optimisation process, provided as a list of tuples.
  optimised_transsys_program
The transsys program resulting from the optimisation process.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, tp, objectiveOptimum, optimisation_log=None)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)