itkLBFGSBOptimizer.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLBFGSBOptimizer.h,v $
  Language:  C++
  Date:      $Date: 2007/03/22 21:39:37 $
  Version:   $Revision: 1.7 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkLBFGSBOptimizer_h
#define __itkLBFGSBOptimizer_h

#include "itkSingleValuedNonLinearOptimizer.h"
#include <string>

namespace itk
{
  
class ITK_EXPORT LBFGSBOptimizer : 
    public SingleValuedNonLinearOptimizer
{
public:
  typedef LBFGSBOptimizer                     Self;
  typedef SingleValuedNonLinearOptimizer      Superclass;
  typedef SmartPointer<Self>                  Pointer;
  typedef SmartPointer<const Self>            ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( LBFGSBOptimizer, SingleValuedNonLinearOptimizer );

  typedef Array<double>             BoundValueType;

  typedef Array<long>                BoundSelectionType;

  void StartOptimization( void );

  typedef  SingleValuedCostFunction         CostFunctionType;
  typedef  CostFunctionType::Pointer        CostFunctionPointer;
  typedef  CostFunctionType::MeasureType    MeasureType;

  virtual void SetLowerBound( const BoundValueType & value );
  virtual const BoundValueType & GetLowerBound();

  virtual void SetUpperBound( const BoundValueType & value );
  virtual const BoundValueType & GetUpperBound();

  virtual void SetBoundSelection( const BoundSelectionType & select );
  virtual const BoundSelectionType & GetBoundSelection();

  itkSetMacro( CostFunctionConvergenceFactor, double );
  itkGetMacro( CostFunctionConvergenceFactor, double );

  itkSetMacro( ProjectedGradientTolerance, double );
  itkGetMacro( ProjectedGradientTolerance, double );

  itkSetMacro( MaximumNumberOfIterations, unsigned int );
  itkGetMacro( MaximumNumberOfIterations, unsigned int );

  itkSetMacro( MaximumNumberOfEvaluations, unsigned int );
  itkGetMacro( MaximumNumberOfEvaluations, unsigned int );

  itkSetMacro( MaximumNumberOfCorrections, unsigned int );
  itkGetMacro( MaximumNumberOfCorrections, unsigned int );

  void SetScales( const ScalesType & )
    {
    itkExceptionMacro( << "This optimizer does not support scales." );
    }

  itkGetConstReferenceMacro( CurrentIteration, unsigned int );

  itkGetConstReferenceMacro( Value, MeasureType );

  itkGetConstReferenceMacro( InfinityNormOfProjectedGradient, double );

protected:
  LBFGSBOptimizer();
  virtual ~LBFGSBOptimizer();
  void PrintSelf(std::ostream& os, Indent indent) const;


private:
  LBFGSBOptimizer(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  BoundValueType        m_LowerBound;
  BoundValueType        m_UpperBound;
  BoundSelectionType    m_BoundSelection;

  double                m_CostFunctionConvergenceFactor;
  double                m_ProjectedGradientTolerance;
  unsigned int          m_MaximumNumberOfIterations;
  unsigned int          m_MaximumNumberOfEvaluations;
  unsigned int          m_MaximumNumberOfCorrections;

  unsigned int          m_CurrentIteration;
  MeasureType           m_Value;
  double                m_InfinityNormOfProjectedGradient;

};

} // end namespace itk

#endif

---