Unfit  3.1.1
Data fitting and optimization software
Public Member Functions | List of all members
Unfit::TestGenericOptimizer Class Reference
Inheritance diagram for Unfit::TestGenericOptimizer:
Unfit::GenericOptimizer

Public Member Functions

int FindMin (GenericCostFunction &cost_function, std::vector< double > &coordinates)
 
void Reset ()
 
- Public Member Functions inherited from Unfit::GenericOptimizer
 GenericOptimizer ()
 
virtual ~GenericOptimizer ()
 
void ResetGenericOptimizer ()
 
virtual double GetCost (std::size_t index=0) const noexcept
 
virtual bool GetIsPopulationBased () const noexcept
 
virtual std::size_t GetNumberOfIterations () const noexcept
 
virtual std::size_t GetNumberOfFunctionEvaluations () const noexcept
 
virtual std::vector< std::vector< double > > GetPopulation () const
 
virtual std::vector< double > GetSolution (std::size_t index=0) const
 
virtual void SetPopulation (const std::vector< std::vector< double >> &population)
 

Additional Inherited Members

- Public Attributes inherited from Unfit::GenericOptimizer
Unfit::Bounds bounds
 
Unfit::Options options
 
- Protected Member Functions inherited from Unfit::GenericOptimizer
virtual bool CalculateCost (GenericCostFunction &CostFunction, std::vector< double > &x)
 
void GeneratePopulation (GenericCostFunction &CostFunction, std::size_t dimensions)
 
void GenerateRandomEngines ()
 
virtual bool IsConverged (const std::vector< double > &best_member, std::size_t truncated_index=0) const
 Checks to see if the population has converged. More...
 
virtual void PrintInitialOutput (double best_cost) const
 
virtual void PrintIterationOutput (double best_cost) const
 
virtual void PrintFinalOutput () const
 
virtual void SortPopulation () noexcept
 
- Protected Attributes inherited from Unfit::GenericOptimizer
std::vector< std::vector< double > > population_
 
std::vector< std::mt19937 > random_engines_
 
std::atomic< std::size_t > function_evaluations_
 
std::atomic< std::size_t > iterations_
 
bool is_population_based_
 

Detailed Description

A dummy optimizer class that is used to test GenericOptimizer. This is needed because GenericOptimizer has pure virtual methods and therefore cannot be instantiated directly.

Member Function Documentation

◆ FindMin()

int Unfit::TestGenericOptimizer::FindMin ( GenericCostFunction cost_function,
std::vector< double > &  coordinates 
)
inlinevirtual

A dummy implementation of FindMin, which is a pure virtual method in the base GenericOptimizer class.

Parameters
cost_functionThe function used to calculate the residuals
coordinatesThe initial guess on entry, the result on exit
Returns
an integer; zero for success, one for failure.

Implements Unfit::GenericOptimizer.

◆ Reset()

void Unfit::TestGenericOptimizer::Reset ( )
inlinevirtual

A dummy implementation of Reset, which is a pure virtual method in the base GenericOptimizer class.

Implements Unfit::GenericOptimizer.


The documentation for this class was generated from the following file: