itkInitializationBiasedParticleSwarmOptimizer.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 itkInitializationBiasedParticleSwarmOptimizer_h
#define itkInitializationBiasedParticleSwarmOptimizer_h

#include "itkParticleSwarmOptimizerBase.h"
#include "ITKOptimizersExport.h"

namespace itk
{
class ITKOptimizers_EXPORT InitializationBiasedParticleSwarmOptimizer :
  public ParticleSwarmOptimizerBase
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(InitializationBiasedParticleSwarmOptimizer);

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

  using CoefficientType = double;

  itkNewMacro( Self )


  itkTypeMacro( InitializationBiasedParticleSwarmOptimizer,
                ParticleSwarmOptimizerBase )

  itkSetMacro( InertiaCoefficient, CoefficientType )
  itkGetMacro( InertiaCoefficient, CoefficientType )
  itkSetMacro( PersonalCoefficient, CoefficientType )
  itkGetMacro( PersonalCoefficient, CoefficientType )
  itkSetMacro( GlobalCoefficient, CoefficientType )
  itkGetMacro( GlobalCoefficient, CoefficientType )
  itkSetMacro( InitializationCoefficient, CoefficientType )
  itkGetMacro( InitializationCoefficient, CoefficientType )

protected:
  InitializationBiasedParticleSwarmOptimizer();
  ~InitializationBiasedParticleSwarmOptimizer() override = default;
  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;
  ParametersType::ValueType                    m_InitializationCoefficient;
};

} // end namespace itk

#endif