itkConjugateGradientOptimizer.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 itkConjugateGradientOptimizer_h
#define itkConjugateGradientOptimizer_h

#include "itkIntTypes.h"
#include "itkSingleValuedNonLinearVnlOptimizer.h"
#include "vnl/algo/vnl_conjugate_gradient.h"
#include "ITKOptimizersExport.h"

namespace itk
{
class ITKOptimizers_EXPORT ConjugateGradientOptimizer:
  public SingleValuedNonLinearVnlOptimizer

{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ConjugateGradientOptimizer);

  using Self = ConjugateGradientOptimizer;
  using Superclass = SingleValuedNonLinearVnlOptimizer;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(ConjugateGradientOptimizer, SingleValuedNonLinearOptimizer);

  using InternalParametersType = vnl_vector< double >;

  using InternalOptimizerType = vnl_conjugate_gradient;

  vnl_conjugate_gradient * GetOptimizer();

  void StartOptimization() override;

  void SetCostFunction(SingleValuedCostFunction *costFunction) override;

  SizeValueType GetNumberOfIterations() const;

  SizeValueType GetCurrentIteration() const;

  MeasureType GetValue() const;

protected:
  ConjugateGradientOptimizer();
  ~ConjugateGradientOptimizer() override;

  using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;

private:
  bool                   m_OptimizerInitialized;
  InternalOptimizerType *m_VnlOptimizer;
};
} // end namespace itk

#endif