itkFRPROptimizer.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 itkFRPROptimizer_h
#define itkFRPROptimizer_h
 
#include "itkPowellOptimizer.h"
#include "ITKOptimizersExport.h"
 
namespace itk
{
class FRPROptimizerEnums
{
public:
  enum class Optimization : uint8_t
  {
    FletchReeves,
    PolakRibiere
  };
};
// Define how to print enumeration
extern ITKOptimizers_EXPORT std::ostream &
                            operator<<(std::ostream & out, const FRPROptimizerEnums::Optimization value);

 
class ITKOptimizers_EXPORT FRPROptimizer : public PowellOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FRPROptimizer);
  using Self = FRPROptimizer;
  using Superclass = PowellOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using ParametersType = SingleValuedNonLinearOptimizer::ParametersType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FRPROptimizer);

  using CostFunctionType = SingleValuedCostFunction;
  using CostFunctionPointer = CostFunctionType::Pointer;

  itkSetMacro(UseUnitLengthGradient, bool);
  itkGetConstMacro(UseUnitLengthGradient, bool);
  itkBooleanMacro(UseUnitLengthGradient);

  void
  StartOptimization() override;

  void
  SetToFletchReeves();

  void
  SetToPolakRibiere();
 
protected:
  FRPROptimizer();
  ~FRPROptimizer() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual void
  GetValueAndDerivative(ParametersType & p, double * val, ParametersType * xi);
 
  virtual void
  LineOptimize(ParametersType * p, ParametersType & xi, double * val);
 
  virtual void
  LineOptimize(ParametersType * p, ParametersType & xi, double * val, ParametersType & tempCoord);
 
private:
  using OptimizationEnum = FRPROptimizerEnums::Optimization;
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr OptimizationEnum FletchReeves = OptimizationEnum::FletchReeves;
  static constexpr OptimizationEnum PolakRibiere = OptimizationEnum::PolakRibiere;
#endif
 
  OptimizationEnum m_OptimizationType{};
 
  bool m_UseUnitLengthGradient{};
}; // end of class
} // end of namespace itk
 
#endif