itkConjugateGradientLineSearchOptimizerv4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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
{
template <typename TInternalComputationValueType>
class ITK_TEMPLATE_EXPORT ConjugateGradientLineSearchOptimizerv4Template
  : public GradientDescentLineSearchOptimizerv4Template<TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ConjugateGradientLineSearchOptimizerv4Template);

  using Self = ConjugateGradientLineSearchOptimizerv4Template;
  using Superclass = GradientDescentLineSearchOptimizerv4Template<TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ConjugateGradientLineSearchOptimizerv4Template);

  itkNewMacro(Self);

  using InternalComputationValueType = TInternalComputationValueType;

  using typename Superclass::DerivativeType;

  using typename Superclass::MeasureType;

  using ConvergenceMonitoringType = itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType>;
 
  void
  StartOptimization(bool doOnlyInitialization = false) override;
 
protected:
  void
  AdvanceOneStep() override;

  ConjugateGradientLineSearchOptimizerv4Template() = default;

  ~ConjugateGradientLineSearchOptimizerv4Template() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  DerivativeType m_LastGradient{};
  DerivativeType m_ConjugateGradient{};
};

using ConjugateGradientLineSearchOptimizerv4 = ConjugateGradientLineSearchOptimizerv4Template<double>;
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkConjugateGradientLineSearchOptimizerv4.hxx"
#endif
 
#endif