itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.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 itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader_h
#define itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader_h
 
#include "itkDomainThreader.h"
#include "itkThreadedIndexedContainerPartitioner.h"
 
namespace itk
{
template <typename TInternalComputationValueType>
class ITK_FORWARD_EXPORT GradientDescentOptimizerBasev4Template;

 
template <typename TInternalComputationValueType>
class ITK_TEMPLATE_EXPORT GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate
  : public DomainThreader<ThreadedIndexedContainerPartitioner,
                          GradientDescentOptimizerBasev4Template<TInternalComputationValueType>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate);

  using Self = GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate;
  using Superclass = DomainThreader<ThreadedIndexedContainerPartitioner,
                                    GradientDescentOptimizerBasev4Template<TInternalComputationValueType>>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkOverrideGetNameOfClassMacro(GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate);
 
  itkNewMacro(Self);
 
  using typename Superclass::DomainType;
  using typename Superclass::AssociateType;
  using IndexRangeType = DomainType;
 
protected:
  void
  ThreadedExecution(const IndexRangeType & subrange, const ThreadIdType threadId) override;
 
  GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate() = default;
  ~GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate() override = default;
};

using GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader =
  GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate<double>;
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.hxx"
#endif
 
#endif