An interface for function minimizers. More...

#include <IFuncMinimizer.h>

Inheritance diagram for Mantid::API::IFuncMinimizer:

Public Member Functions
virtual double	costFunctionVal ()=0
	Get value of cost function.

virtual void	finalize ()
	Finalize minimization, eg store additional outputs.

virtual std::string	getError () const
	Get the error string.

virtual void	initialize (API::ICostFunction_sptr function, size_t maxIterations=1000)=0
	Initialize minimizer.

virtual bool	iterate (size_t iteration)=0
	Do one iteration.

virtual bool	minimize (size_t maxIterations=1000)
	Perform iteration with minimizer and return true if successful.

virtual std::string	name () const =0
	Get name of minimizer.

Public Member Functions inherited from Mantid::Kernel::PropertyManager
::Json::Value	asJson (bool withDefaultValues=false) const override
	Return the property manager serialized as a json object.

std::string	asString (bool withDefaultValues=false) const override
	Return the property manager serialized as a string.

void	clear () override final
	Clears the whole property map.

PropertyManager *	cloneInTimeROI (const Kernel::TimeROI &timeROI)
	Create a partial copy of this object such that every time series property is cloned according to the input TimeROI.

void	declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="") override
	Add or replace a property in the list of managed properties.

void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.

void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.

template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.

template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.

void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="") override
	Add a property to the list of managed properties.

virtual void	declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
	Function to declare properties (i.e. store them)

bool	existsProperty (const std::string &name) const override
	Checks whether the named property is already in the list of managed property.

void	filterByProperty (Mantid::Kernel::LogFilter *logFilter, const std::vector< std::string > &excludedFromFiltering=std::vector< std::string >()) override
	Filter the managed properties by the given boolean property mask.

std::vector< std::string >	getDeclaredPropertyNames () const noexcept override
	Return the list of declared property names.

Property *	getPointerToProperty (const std::string &name) const override
	Get a property by name.

const std::vector< Property * > &	getProperties () const override
	Get the list of managed properties.

TypedValue	getProperty (const std::string &name) const override
	Get the value of a property.

std::string	getPropertyValue (const std::string &name) const override
	Get the value of a property as a string.

bool	operator!= (const PropertyManager &other) const

PropertyManager &	operator+= (const PropertyManager &rhs)
	Addition operator.

PropertyManager &	operator= (const PropertyManager &)
	Assignment operator - performs a deep copy.

bool	operator== (const PropertyManager &other) const

size_t	propertyCount () const override
	Count the number of properties under management.

	PropertyManager ()
	Default constructor.

	PropertyManager (const PropertyManager &)
	copy constructor

void	removeDataOutsideTimeROI (const Kernel::TimeROI &timeROI)
	For time series properties, remove time values outside of TimeROI regions, each defined as [roi_begin,roi_end].

void	removeProperty (const std::string &name, const bool delproperty=true) override
	removes the property from properties map

void	resetProperties () override
	Reset property values back to initial values (blank or default values)

void	setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Set the ordered list of properties by a json value collection.

void	setProperties (const ::Json::Value &jsonValue, IPropertyManager *targetPropertyManager, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)
	Set the ordered list of properties by a json value collection.

void	setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
	Set the ordered list of properties by one string of values, separated by semicolons.

void	setProperties (const std::string &propertiesJson, IPropertyManager *targetPropertyManager, const std::unordered_set< std::string > &ignoreProperties, bool createMissing=false)
	Set the ordered list of properties by one string of values, separated by semicolons.

void	setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >()) override
	Sets all the declared properties from a string.

void	setPropertyOrdinal (const int &index, const std::string &value) override
	Set the value of a property by an index N.B.

void	setPropertyValue (const std::string &name, const std::string &value) override
	Set the value of a property by string N.B.

void	setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
	Set the value of a property by Json::Value.

std::unique_ptr< Property >	takeProperty (const size_t index) override
	removes the property from the properties map and returns a pointer to it

bool	validateProperties () const override
	Validates all the properties in the collection.

virtual	~PropertyManager () override
	Virtual destructor.

Public Member Functions inherited from Mantid::Kernel::IPropertyManager
void	declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

void	declareProperty (const std::string &name, const char *value, const unsigned int direction)
	Add a property of string type to the list of managed properties.

void	declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
	Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).

template<typename T >
void	declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
	Add a property to the list of managed properties with no validator.

template<typename T >
void	declareProperty (const std::string &name, T value, const unsigned int direction)
	Add a property of the template type to the list of managed properties.

template<typename T >
void	declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
	Add a property of the template type to the list of managed properties.

std::vector< Property * >	getPropertiesInGroup (const std::string &group) const
	Get the list of managed properties in a given group.

IPropertyManager *	setProperty (const std::string &name, const char *value)
	Specialised version of setProperty template method to handle const char *.

IPropertyManager *	setProperty (const std::string &name, const std::string &value)
	Specialised version of setProperty template method to handle std::string.

template<typename T >
IPropertyManager *	setProperty (const std::string &name, const T &value)
	Templated method to set the value of a PropertyWithValue.

template<typename T >
IPropertyManager *	setProperty (const std::string &name, std::unique_ptr< T > value)
	Templated method to set the value of a PropertyWithValue from a std::unique_ptr.

void	setPropertyGroup (const std::string &name, const std::string &group)
	Set the group for a given property.

void	setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)

void	updatePropertyValues (const IPropertyManager &other)
	Update values of the existing properties.

virtual	~IPropertyManager ()=default

Protected Attributes
std::string	m_errorString
	Error string.

Additional Inherited Members
Static Public Member Functions inherited from Mantid::Kernel::PropertyManager
static std::string	getInvalidValuesFilterLogName (const std::string &logName)
	Gets the correct log name for the matching invalid values log for a given log name.

static std::string	getLogNameFromInvalidValuesFilter (const std::string &logName)

static bool	isAnInvalidValuesFilterLog (const std::string &logName)
	Determine if the log's name has a substring indicating it should not be filtered.

Static Public Attributes inherited from Mantid::Kernel::PropertyManager
static const std::string	INVALID_VALUES_SUFFIX = "_invalid_values"

Protected Member Functions inherited from Mantid::Kernel::PropertyManager
Property *	getPointerToPropertyOrdinal (const int &index) const override
	Get a property by an index.

Property *	getPointerToPropertyOrNull (const std::string &name) const
	Get a property by name.

Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void	afterPropertySet (const std::string &)
	Override this method to perform a custom action right after a property was set.

template<typename T >
T	getValue (const std::string &name) const
	Templated method to get the value of a property.

template<>
MANTID_KERNEL_DLL PropertyManager_sptr	getValue (const std::string &name) const

template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr	getValue (const std::string &name) const

Detailed Description

An interface for function minimizers.

Minimizers minimize cost functions.

Author: Anders Markvardsen, ISIS, RAL

Date: 11/12/2009

Definition at line 26 of file IFuncMinimizer.h.

Member Function Documentation

◆ costFunctionVal()

virtual double Mantid::API::IFuncMinimizer::costFunctionVal ( )

pure virtual

Get value of cost function.

Implemented in Mantid::CurveFitting::FuncMinimisers::DampedGaussNewtonMinimizer, Mantid::CurveFitting::FuncMinimisers::DerivMinimizer, Mantid::CurveFitting::FuncMinimisers::FABADAMinimizer, Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMDMinimizer, Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMinimizer, Mantid::CurveFitting::FuncMinimisers::SimplexMinimizer, and Mantid::CurveFitting::FuncMinimisers::TrustRegionMinimizer.

◆ finalize()

virtual void Mantid::API::IFuncMinimizer::finalize ( )

inlinevirtual

Finalize minimization, eg store additional outputs.

Reimplemented in Mantid::CurveFitting::FuncMinimisers::FABADAMinimizer.

Definition at line 52 of file IFuncMinimizer.h.

◆ getError()

virtual std::string Mantid::API::IFuncMinimizer::getError ( ) const

inlinevirtual

Get the error string.

Definition at line 46 of file IFuncMinimizer.h.

◆ initialize()

virtual void Mantid::API::IFuncMinimizer::initialize	(	API::ICostFunction_sptr	function,
		size_t	maxIterations = `1000`
	)

pure virtual

Initialize minimizer.

Parameters

function	:: Function to minimize
maxIterations	:: Maximum number of iterations.

Implemented in Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMinimizer, Mantid::CurveFitting::FuncMinimisers::TrustRegionMinimizer, Mantid::CurveFitting::FuncMinimisers::FABADAMinimizer, Mantid::CurveFitting::FuncMinimisers::DampedGaussNewtonMinimizer, Mantid::CurveFitting::FuncMinimisers::DerivMinimizer, Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMDMinimizer, and Mantid::CurveFitting::FuncMinimisers::SimplexMinimizer.

◆ iterate()

virtual bool Mantid::API::IFuncMinimizer::iterate ( size_t iteration )

pure virtual

Do one iteration.

Parameters

iteration :: Current iteration number. 0 <= iteration < maxIterations

Returns: :: true if iterations should be continued or false to stop

Implemented in Mantid::CurveFitting::FuncMinimisers::FABADAMinimizer, Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMDMinimizer, Mantid::CurveFitting::FuncMinimisers::DampedGaussNewtonMinimizer, Mantid::CurveFitting::FuncMinimisers::DerivMinimizer, Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMinimizer, Mantid::CurveFitting::FuncMinimisers::SimplexMinimizer, and Mantid::CurveFitting::FuncMinimisers::TrustRegionMinimizer.

Referenced by minimize().

◆ minimize()

bool Mantid::API::IFuncMinimizer::minimize ( size_t maxIterations = 1000 )

virtual

Perform iteration with minimizer and return true if successful.

Do minimization of the set function.

Parameters

maxIterations :: Maximum number of iterations.

Returns: :: true if successful, false otherwise. Call getError() to see the error message string.

Definition at line 20 of file IFuncMinimizer.cpp.

References iterate(), m_errorString, and std::to_string().

◆ name()

virtual std::string Mantid::API::IFuncMinimizer::name ( ) const

pure virtual

Get name of minimizer.

Referenced by Mantid::CurveFitting::FuncMinimisers::DerivMinimizer::iterate().

Member Data Documentation

◆ m_errorString

std::string Mantid::API::IFuncMinimizer::m_errorString

protected

Error string.

Definition at line 56 of file IFuncMinimizer.h.

Referenced by Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMDMinimizer::iterate(), Mantid::CurveFitting::FuncMinimisers::DampedGaussNewtonMinimizer::iterate(), Mantid::CurveFitting::FuncMinimisers::DerivMinimizer::iterate(), Mantid::CurveFitting::FuncMinimisers::LevenbergMarquardtMinimizer::iterate(), Mantid::CurveFitting::FuncMinimisers::SimplexMinimizer::iterate(), Mantid::CurveFitting::FuncMinimisers::TrustRegionMinimizer::iterate(), and minimize().

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

Framework/API/inc/MantidAPI/IFuncMinimizer.h
Framework/API/src/IFuncMinimizer.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ costFunctionVal()

◆ finalize()

◆ getError()

◆ initialize()

◆ iterate()

◆ minimize()

◆ name()

Member Data Documentation

◆ m_errorString