itkLBFGSBOptimizerv4.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 itkLBFGSBOptimizerv4_h
#define itkLBFGSBOptimizerv4_h
 
#include "itkLBFGSOptimizerBasev4.h"
#include "vnl/algo/vnl_lbfgsb.h"
#include "ITKOptimizersv4Export.h"
 
namespace itk
{
/* Necessary forward declaration */
// Forward reference because of private implementation
class ITK_FORWARD_EXPORT LBFGSBOptimizerHelperv4;

class ITKOptimizersv4_EXPORT LBFGSBOptimizerv4 : public LBFGSOptimizerBasev4<vnl_lbfgsb>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LBFGSBOptimizerv4);

  using Self = LBFGSBOptimizerv4;
  using Superclass = LBFGSOptimizerBasev4<vnl_lbfgsb>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using MetricType = Superclass::MetricType;
  using ParametersType = Superclass::ParametersType;
  using ScalesType = Superclass::ScalesType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(LBFGSBOptimizerv4);
 
  enum BoundSelectionValues
  {
    UNBOUNDED = 0,
    LOWERBOUNDED = 1,
    BOTHBOUNDED = 2,
    UPPERBOUNDED = 3
  };

  using BoundValueType = Array<double>;

  using BoundSelectionType = Array<long>;

  void
  SetInitialPosition(const ParametersType & param);

  ParametersType &
  GetInitialPosition()
  {
    return m_InitialPosition;
  }

  void
  StartOptimization(bool doOnlyInitialization = false) override;

  void
  SetMetric(MetricType * metric) override;

  void
  SetLowerBound(const BoundValueType & value);
 
  itkGetConstReferenceMacro(LowerBound, BoundValueType);

  void
  SetUpperBound(const BoundValueType & value);
 
  itkGetConstReferenceMacro(UpperBound, BoundValueType);

  void
  SetBoundSelection(const BoundSelectionType & value);
 
  itkGetConstReferenceMacro(BoundSelection, BoundSelectionType);

  virtual void
  SetCostFunctionConvergenceFactor(double);
 
  itkGetConstMacro(CostFunctionConvergenceFactor, double);

  virtual void
  SetMaximumNumberOfCorrections(unsigned int);
 
  itkGetConstMacro(MaximumNumberOfCorrections, unsigned int);

  void
  SetScales(const ScalesType &) override;

  itkGetConstReferenceMacro(InfinityNormOfProjectedGradient, double);

  bool
  CanUseScales() const override
  {
    return false;
  }
 
protected:
  LBFGSBOptimizerv4();
  ~LBFGSBOptimizerv4() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;

  using InternalOptimizerType = LBFGSBOptimizerHelperv4;
 
  friend class LBFGSBOptimizerHelperv4;
 
private:
  unsigned int m_MaximumNumberOfCorrections{ 5 };
 
  ParametersType     m_InitialPosition{};
  BoundValueType     m_LowerBound{};
  BoundValueType     m_UpperBound{};
  BoundSelectionType m_BoundSelection{};
};
} // end namespace itk
#endif