itkRegularStepGradientDescentOptimizer.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 itkRegularStepGradientDescentOptimizer_h
#define itkRegularStepGradientDescentOptimizer_h

#include "itkRegularStepGradientDescentBaseOptimizer.h"
#include "ITKOptimizersExport.h"

namespace itk
{
class ITKOptimizers_EXPORT RegularStepGradientDescentOptimizer:
  public RegularStepGradientDescentBaseOptimizer
{
public:
  typedef RegularStepGradientDescentOptimizer     Self;
  typedef RegularStepGradientDescentBaseOptimizer Superclass;
  typedef SmartPointer< Self >                    Pointer;
  typedef SmartPointer< const Self >              ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(RegularStepGradientDescentOptimizer,
               RegularStepGradientDescentBaseOptimizer);

  typedef Superclass::CostFunctionType CostFunctionType;
  typedef CostFunctionType::Pointer    CostFunctionPointer;

protected:
  RegularStepGradientDescentOptimizer() {}
  virtual ~RegularStepGradientDescentOptimizer() {}

  virtual void StepAlongGradient(
    double factor,
    const DerivativeType & transformedGradient) ITK_OVERRIDE;

private:
  RegularStepGradientDescentOptimizer(const Self &); //purposely not implemented
  void operator=(const Self &);                      //purposely not implemented
};
} // end namespace itk

#endif