itkParticleSwarmOptimizer.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 itkParticleSwarmOptimizer_h
#define itkParticleSwarmOptimizer_h

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

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

  itkNewMacro( Self )


  itkTypeMacro( ParticleSwarmOptimizer, ParticleSwarmOptimizerBase )

  itkSetMacro( InertiaCoefficient, double )
  itkGetMacro( InertiaCoefficient, double )
  itkSetMacro( PersonalCoefficient, double )
  itkGetMacro( PersonalCoefficient, double )
  itkSetMacro( GlobalCoefficient, double )
  itkGetMacro( GlobalCoefficient, double )

protected:
  ParticleSwarmOptimizer();
  virtual ~ParticleSwarmOptimizer();
  virtual void PrintSelf(std::ostream& os, Indent indent) const ITK_OVERRIDE;
  virtual void UpdateSwarm() ITK_OVERRIDE;

private:
  ParticleSwarmOptimizer(const Self&); //purposely not implemented
  void operator=(const Self&);//purposely not implemented

  ParametersType::ValueType                    m_InertiaCoefficient;
  ParametersType::ValueType                    m_PersonalCoefficient;
  ParametersType::ValueType                    m_GlobalCoefficient;
};

} // end namespace itk

#endif