vtkAmoebaMinimizer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkAmoebaMinimizer_h
#define vtkAmoebaMinimizer_h
 
#include "vtkCommonMathModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONMATH_EXPORT vtkAmoebaMinimizer : public vtkObject
{
public:
  static vtkAmoebaMinimizer* New();
  vtkTypeMacro(vtkAmoebaMinimizer, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetFunction(void (*f)(void*), void* arg);
 
  void SetFunctionArgDelete(void (*f)(void*));
 
 
  void SetParameterValue(const char* name, double value);
  void SetParameterValue(int i, double value);
 
 
  void SetParameterScale(const char* name, double scale);
  double GetParameterScale(const char* name);
  void SetParameterScale(int i, double scale);
  double GetParameterScale(int i) { return this->ParameterScales[i]; }
 
 
  double GetParameterValue(const char* name);
  double GetParameterValue(int i) { return this->ParameterValues[i]; }
 
  const char* GetParameterName(int i) { return this->ParameterNames[i]; }
 
  int GetNumberOfParameters() { return this->NumberOfParameters; }
 
  void Initialize();
 
  virtual void Minimize();
 
  virtual int Iterate();
 
 
  vtkSetMacro(FunctionValue, double);
  double GetFunctionValue() { return this->FunctionValue; }
 
 
  vtkSetClampMacro(ContractionRatio, double, 0.5, 1.0);
  vtkGetMacro(ContractionRatio, double);
 
 
  vtkSetClampMacro(ExpansionRatio, double, 1.0, 2.0);
  vtkGetMacro(ExpansionRatio, double);
 
 
  vtkSetMacro(Tolerance, double);
  vtkGetMacro(Tolerance, double);
 
 
  vtkSetMacro(ParameterTolerance, double);
  vtkGetMacro(ParameterTolerance, double);
 
 
  vtkSetMacro(MaxIterations, int);
  vtkGetMacro(MaxIterations, int);
 
 
  vtkGetMacro(Iterations, int);
 
 
  vtkGetMacro(FunctionEvaluations, int);
 
  void EvaluateFunction();
 
protected:
  vtkAmoebaMinimizer();
  ~vtkAmoebaMinimizer() override;
 
  void (*Function)(void*);
  void (*FunctionArgDelete)(void*);
  void* FunctionArg;
 
  int NumberOfParameters;
  char** ParameterNames;
  double* ParameterValues;
  double* ParameterScales;
  double FunctionValue;
 
  double ContractionRatio;
  double ExpansionRatio;
 
  double Tolerance;
  double ParameterTolerance;
  int MaxIterations;
  int Iterations;
  int FunctionEvaluations;
 
private:
  // specific to amoeba simplex minimization
 
  double** AmoebaVertices;
  double* AmoebaValues;
  double* AmoebaSum;
  double AmoebaSize;
  double AmoebaHighValue;
  int AmoebaNStepsNoImprovement;
 
  void InitializeAmoeba();
  void GetAmoebaParameterValues();
  void TerminateAmoeba();
  double TryAmoeba(double sum[], int high, double fac);
  int PerformAmoeba();
  int CheckParameterTolerance();
 
  vtkAmoebaMinimizer(const vtkAmoebaMinimizer&) = delete;
  void operator=(const vtkAmoebaMinimizer&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif