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

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

  itkOverrideGetNameOfClassMacro(ParticleSwarmOptimizerBase);
 
  using ParameterBoundsType = std::vector<std::pair<ParametersType::ValueType, ParametersType::ValueType>>;
 
  struct ParticleData
  {
    ParametersType                m_CurrentParameters;
    ParametersType                m_CurrentVelocity;
    CostFunctionType::MeasureType m_CurrentValue;
    ParametersType                m_BestParameters;
    CostFunctionType::MeasureType m_BestValue;
  };
 
  using SwarmType = std::vector<ParticleData>;
  using NumberOfIterationsType = unsigned int;
  using NumberOfParticlesType = unsigned int;
  using NumberOfGenerationsType = unsigned int;
  using MeasureType = CostFunctionType::MeasureType;
  using ValueType = ParametersType::ValueType;
  using RandomVariateGeneratorType = Statistics::MersenneTwisterRandomVariateGenerator;

  itkSetMacro(InitializeNormalDistribution, bool);
  itkGetMacro(InitializeNormalDistribution, bool);
  itkBooleanMacro(InitializeNormalDistribution);
  void
  SetInitialSwarm(const SwarmType & initialSwarm);
  void
  ClearSwarm();
  itkSetMacro(PrintSwarm, bool);
  itkGetMacro(PrintSwarm, bool);
  itkBooleanMacro(PrintSwarm);
  void
  StartOptimization() override;
 

  void
  SetNumberOfParticles(NumberOfParticlesType n);
  itkGetMacro(NumberOfParticles, NumberOfParticlesType);
  itkSetMacro(MaximalNumberOfIterations, NumberOfIterationsType);
  itkGetMacro(MaximalNumberOfIterations, NumberOfIterationsType);
  itkSetMacro(NumberOfGenerationsWithMinimalImprovement, NumberOfGenerationsType);
  itkGetMacro(NumberOfGenerationsWithMinimalImprovement, NumberOfGenerationsType);
  virtual void
  SetParameterBounds(ParameterBoundsType & bounds);
  void
  SetParameterBounds(std::pair<ParametersType::ValueType, ParametersType::ValueType> & bounds, unsigned int n);
  ParameterBoundsType
  GetParameterBounds() const;

  itkSetMacro(FunctionConvergenceTolerance, MeasureType);
  itkGetMacro(FunctionConvergenceTolerance, MeasureType);

  void
  SetParametersConvergenceTolerance(ValueType convergenceTolerance, unsigned int sz);
  itkSetMacro(ParametersConvergenceTolerance, ParametersType);
  itkGetMacro(ParametersConvergenceTolerance, ParametersType);
  itkGetMacro(PercentageParticlesConverged, double);
  itkSetMacro(PercentageParticlesConverged, double);
  itkSetMacro(Seed, RandomVariateGeneratorType::IntegerType);
  itkGetMacro(Seed, RandomVariateGeneratorType::IntegerType);
  itkSetMacro(UseSeed, bool);
  itkGetMacro(UseSeed, bool);
  itkBooleanMacro(UseSeed);
  MeasureType
  GetValue() const;

  std::string
  GetStopConditionDescription() const override;

  void
  PrintSwarm(std::ostream & os, Indent indent) const;
 
protected:
  ParticleSwarmOptimizerBase();
  ~ParticleSwarmOptimizerBase() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
  void
  PrintParamtersType(const ParametersType & x, std::ostream & os) const;

  virtual void
  UpdateSwarm() = 0;
 
  virtual void
  ValidateSettings();

  virtual void
  Initialize();
 
  void
  RandomInitialization();
  void
  FileInitialization();
 
  bool                                    m_PrintSwarm{};
  std::ostringstream                      m_StopConditionDescription{};
  bool                                    m_InitializeNormalDistribution{};
  NumberOfParticlesType                   m_NumberOfParticles{};
  NumberOfIterationsType                  m_MaximalNumberOfIterations{};
  NumberOfGenerationsType                 m_NumberOfGenerationsWithMinimalImprovement{};
  ParameterBoundsType                     m_ParameterBounds{};
  ParametersType                          m_ParametersConvergenceTolerance{};
  double                                  m_PercentageParticlesConverged{};
  CostFunctionType::MeasureType           m_FunctionConvergenceTolerance{};
  std::vector<ParticleData>               m_Particles{};
  CostFunctionType::MeasureType           m_FunctionBestValue{ 0 };
  std::vector<MeasureType>                m_FunctionBestValueMemory{};
  ParametersType                          m_ParametersBestValue{};
  NumberOfIterationsType                  m_IterationIndex{ 0 };
  RandomVariateGeneratorType::IntegerType m_Seed{};
  bool                                    m_UseSeed{};
};
} // end namespace itk
 
#endif