simpeg.optimization.BFGS
========================

.. currentmodule:: simpeg.optimization

.. autoclass:: BFGS
  :show-inheritance:

  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         BFGS.bfgs
         BFGS.bfgsrec
         BFGS.doEndIteration
         BFGS.doStartIteration
         BFGS.findSearchDirection
         BFGS.finish
         BFGS.minimize
         BFGS.modifySearchDirection
         BFGS.modifySearchDirectionBreak
         BFGS.printDone
         BFGS.printInit
         BFGS.printIter
         BFGS.projection
         BFGS.recall
         BFGS.remember
         BFGS.save
         BFGS.scaleSearchDirection
         BFGS.startup
         BFGS.stoppingCriteria
      
  

  
  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         BFGS.LScurvature
         BFGS.LSreduction
         BFGS.LSshorten
         BFGS.bfgsH0
         BFGS.callback
         BFGS.comment
         BFGS.counter
         BFGS.debug
         BFGS.debugLS
         BFGS.eps
         BFGS.factor
         BFGS.maxIter
         BFGS.maxIterLS
         BFGS.maxStep
         BFGS.name
         BFGS.nameLS
         BFGS.nbfgs
         BFGS.parent
         BFGS.print_type
         BFGS.stopNextIteration
         BFGS.tolF
         BFGS.tolG
         BFGS.tolX
         BFGS.use_WolfeCurvature
  
  

.. minigallery:: simpeg.optimization.BFGS
    :add-heading: Galleries and Tutorials using ``simpeg.optimization.BFGS``
    :heading-level: -