itkSingleValuedNonLinearVnlOptimizer.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 itkSingleValuedNonLinearVnlOptimizer_h
#define itkSingleValuedNonLinearVnlOptimizer_h
 
#include "itkSingleValuedNonLinearOptimizer.h"
#include "itkSingleValuedVnlCostFunctionAdaptor.h"
#include "itkCommand.h"
#include "ITKOptimizersExport.h"
 
#include <memory> // For unique_ptr.
 
namespace itk
{
class ITKOptimizers_EXPORT SingleValuedNonLinearVnlOptimizer : public SingleValuedNonLinearOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SingleValuedNonLinearVnlOptimizer);

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

  itkOverrideGetNameOfClassMacro(SingleValuedNonLinearVnlOptimizer);

  using CommandType = ReceptorMemberCommand<Self>;

  void
  SetCostFunction(SingleValuedCostFunction * costFunction) override = 0;

  itkGetConstReferenceMacro(Maximize, bool);
  itkSetMacro(Maximize, bool);
  itkBooleanMacro(Maximize);
  bool
  GetMinimize() const
  {
    return !m_Maximize;
  }
  void
  SetMinimize(bool v)
  {
    this->SetMaximize(!v);
  }
  void
  MinimizeOn()
  {
    this->MaximizeOff();
  }
  void
  MinimizeOff()
  {
    this->MaximizeOn();
  }

  itkGetConstReferenceMacro(CachedValue, MeasureType);
  itkGetConstReferenceMacro(CachedDerivative, DerivativeType);
  itkGetConstReferenceMacro(CachedCurrentPosition, ParametersType);
  virtual bool
  CanUseScales() const
  {
    return true;
  }
 
protected:
  SingleValuedNonLinearVnlOptimizer();
  ~SingleValuedNonLinearVnlOptimizer() override;
 
  using CostFunctionAdaptorType = SingleValuedVnlCostFunctionAdaptor;
 
  void
  SetCostFunctionAdaptor(CostFunctionAdaptorType * adaptor);
 
  const CostFunctionAdaptorType *
  GetCostFunctionAdaptor() const;
 
  CostFunctionAdaptorType *
  GetCostFunctionAdaptor();

  CostFunctionAdaptorType *
  GetNonConstCostFunctionAdaptor() const;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  void
  IterationReport(const EventObject & event);
 
  std::unique_ptr<CostFunctionAdaptorType> m_CostFunctionAdaptor;
 
  bool m_Maximize{};
 
  CommandType::Pointer m_Command{};
 
  mutable ParametersType m_CachedCurrentPosition{};
  mutable MeasureType    m_CachedValue{};
  mutable DerivativeType m_CachedDerivative{};
};
} // end namespace itk
 
#endif