R/optimbase.histget.R

In optimbase: R Port of the 'Scilab' Optimbase Module

# Copyright (C) 2008-2009 - INRIA - Michael Baudin
# Copyright (C) 2009-2010 - DIGITEO - Michael Baudin
# Copyright (C) 2010-2022 - Sebastien Bihorel
#
# This file must be used under the terms of the CeCILL.
# This source file is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at
# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
#
# This source code is a R port of the optimbase component
# originally written by Michael Baudin for Scilab.

optimbase.histget <- function(this=NULL,iter=NULL,key=NULL){

  if (!this$storehistory)
    stop('optimbase_histget: History disabled ; turn on -storehistory option.',
         call.=FALSE)

  if (iter < 1)
    stop(sprintf('optimbase_histget: Negative iteration index %d is not allowed.',iter),
         call.=FALSE)

  if (!any(key=c('historyxopt','historyfopt')))
    stop(sprintf('optimbase_histget: Unknown key %s',key),
         call.=FALSE)

  if (key=='historyxopt'){
    value <- this$historyxopt[[iter]]
  }
  if (key=='historyfopt'){
    value = this$historyfopt[iter]
  }

  return(value)

}