itkParticleSwarmOptimizer.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 itkParticleSwarmOptimizer_h
#define itkParticleSwarmOptimizer_h
 
#include "itkParticleSwarmOptimizerBase.h"
#include "ITKOptimizersExport.h"
 
namespace itk
{
class ITKOptimizers_EXPORT ParticleSwarmOptimizer : public ParticleSwarmOptimizerBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ParticleSwarmOptimizer);

  using Self = ParticleSwarmOptimizer;
  using Superclass = ParticleSwarmOptimizerBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ParticleSwarmOptimizer);

  itkSetMacro(InertiaCoefficient, double);
  itkGetMacro(InertiaCoefficient, double);
  itkSetMacro(PersonalCoefficient, double);
  itkGetMacro(PersonalCoefficient, double);
  itkSetMacro(GlobalCoefficient, double);
  itkGetMacro(GlobalCoefficient, double);
 
protected:
  ParticleSwarmOptimizer();
  ~ParticleSwarmOptimizer() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
  void
  UpdateSwarm() override;
 
private:
  ParametersType::ValueType m_InertiaCoefficient{};
  ParametersType::ValueType m_PersonalCoefficient{};
  ParametersType::ValueType m_GlobalCoefficient{};
};
 
} // end namespace itk
 
#endif