Cite Us
pyOpt

Previous topic

Gradient

Next topic

Optimizers

History

class pyOpt_history.History(filename, mode, optimizer=None, opt_prob=None, *args, **kwargs)

Abstract Class for Optimizer History Object

Optimizer History Class Initialization

Arguments:

  • filename -> STR: Name for .bin and .cue file
  • mode -> STR: Either read (‘r’) or write (‘w’) mode

Keyword arguments:

  • optimizer -> INST: Opimizer class instance, Default = None
  • opt_prob -> STR: Optimization Problem Name, Default = None

Documentation last updated: April. 14, 2010 - Peter W. Jansen

close()

Close Optimizer History Files

Documentation last updated: December. 11, 2009 - Ruben E. Perez

overwrite(bin_data, index)

Overwrite Data on Optimizer History Files

Arguments:

  • bin_data -> ARRAY: Data to overwrite old data
  • index -> INT: Starting index of old data

Documentation last updated: Feb. 03, 2011 - Peter W. Jansen

read(index=[], ident=['obj'])

Read Data from Optimizer History Files

Keyword arguments:

  • index -> LIST,SCALAR: Index (list), [0,-1] for all, [] internal count, -1 for last, Default = []
  • ident -> STR: Indentifier, Default = ‘obj’

Documentation last updated: April. 14, 2010 - Peter W. Jansen

write(bin_data, cue_data)

Write Data to Optimizer History Files

Arguments:

  • bin_data -> LIST/ARRAY: Data to be written to binary file
  • cue_data -> STR: Variable identifier for cue file

Documentation last updated: Feb. 07, 2011 - Peter W. Jansen