itkConjugateGradientLineSearchOptimizerv4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkConjugateGradientLineSearchOptimizerv4_h
#define __itkConjugateGradientLineSearchOptimizerv4_h

#include "itkGradientDescentLineSearchOptimizerv4.h"
#include "itkOptimizerParameterScalesEstimator.h"
#include "itkWindowConvergenceMonitoringFunction.h"

namespace itk
{
class ITK_EXPORT ConjugateGradientLineSearchOptimizerv4
  : public GradientDescentLineSearchOptimizerv4
{
public:
  typedef ConjugateGradientLineSearchOptimizerv4  Self;
  typedef GradientDescentOptimizerv4              Superclass;
  typedef SmartPointer< Self >                    Pointer;
  typedef SmartPointer< const Self >              ConstPointer;

  itkTypeMacro(ConjugateGradientLineSearchOptimizerv4, GradientDescentLineSearchOptimizerv4);

  itkNewMacro(Self);

  typedef Superclass::DerivativeType      DerivativeType;

  typedef Superclass::MeasureType                  MeasureType;
  typedef Superclass::InternalComputationValueType InternalComputationValueType;

  typedef itk::Function::WindowConvergenceMonitoringFunction<double> ConvergenceMonitoringType;

  virtual void StartOptimization( bool doOnlyInitialization = false );

protected:

  virtual void AdvanceOneStep(void);

  ConjugateGradientLineSearchOptimizerv4();

  virtual ~ConjugateGradientLineSearchOptimizerv4();

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

private:

  DerivativeType               m_LastGradient;
  DerivativeType               m_ConjugateGradient;

  ConjugateGradientLineSearchOptimizerv4( const Self & ); //purposely not implemented
  void operator=( const Self& ); //purposely not implemented

};

} // end namespace itk

#endif