Base abstract class providing basic structure for minimization optimization of a given function based on its derivatives.
More...
#include <DiffMinimizer.h>
|
| DiffMinimizer (function< OT(IT)> f, vector< function< OT(IT)>> df) |
| Differential minimizer default constructor. More...
|
|
virtual vector< function< OT(IT)> > | getDerivatives () const |
| Obtain the derivatives of the function to be minimized. More...
|
|
virtual void | setDerivatives (vector< function< OT(IT)>> df) |
| Set the derivatives of the function to be minimized. More...
|
|
virtual size_t | numDerivatives () const |
| Obtain the number of available derivatives for the function to be minimized. More...
|
|
virtual function< OT(IT)> | getDerivative (size_t const i) |
| Obtain the i-th derivative for the function being minimized. More...
|
|
virtual void | setDerivative (size_t const i, function< OT(IT)> df) |
| Set the i-th derivative for the function being minimized. More...
|
|
virtual void | removeDerivative (size_t const i) |
| Remove the i-th derivative for the function being minimized. More...
|
|
virtual void | addDerivative (function< OT(IT)> df) |
| Append given derivative. More...
|
|
| Minimizer (function< OT(IT)> f) |
| Minimizer default constructor. More...
|
|
virtual IT | argmin (IT x)=0 |
| Find the argument which minimizes minimizer's function. More...
|
|
virtual function< OT(IT)> | getF () const |
| Obtain the function to be minimized. More...
|
|
virtual void | setF (function< OT(IT)> f) |
| Set the function to be minimized. More...
|
|
|
vector< function< OT(IT)> > | df |
| The derivatives of the function to be minimized such that df[i] corresponds with \(\frac{d^if}{dx^i}\).
|
|
function< OT(IT)> | f |
| The function to be minimized.
|
|
|
template<typename Archive > |
void | serialize (Archive &ar, unsigned int const version) |
| Serialize the differential minimizer to a stream of bytes. More...
|
|
|
class | boost::serialization::access |
|
template<typename IT, typename OT>
class fluxionum::DiffMinimizer< IT, OT >
Base abstract class providing basic structure for minimization optimization of a given function based on its derivatives.
- Author
- Alberto M. Esmoris Pena
- Version
- 1.0
- Template Parameters
-
IT | Type of input for the function to be minimized and its derivatives |
OT | Type of output for the function to be minimized and its derivatives |
- See also
- fluxionum::Minimizer
◆ DiffMinimizer()
template<typename IT , typename OT >
◆ addDerivative()
template<typename IT , typename OT >
◆ getDerivative()
template<typename IT , typename OT >
Obtain the i-th derivative for the function being minimized.
- Parameters
-
i | Index of the derivative to be obtained |
- Returns
- i-th derivative for the function being minimized
- See also
- fluxionum::DiffMinimizer::df
◆ getDerivatives()
template<typename IT , typename OT >
Obtain the derivatives of the function to be minimized.
- Returns
- Derivatives of the function to be minimized
- See also
- fluxionum::DiffMinimizer::df
◆ numDerivatives()
template<typename IT , typename OT >
Obtain the number of available derivatives for the function to be minimized.
- Returns
- Number of available derivatives for the function to be minimized
- See also
- fluxionum::DiffMinimizer::df
◆ removeDerivative()
template<typename IT , typename OT >
Remove the i-th derivative for the function being minimized.
- Parameters
-
i | Index of the derivative to be removed |
- See also
- fluxionum::DiffMinimizer::df
◆ serialize()
template<typename IT , typename OT >
template<typename Archive >
Serialize the differential minimizer to a stream of bytes.
- Template Parameters
-
- Parameters
-
ar | Specific rendering for the stream of bytes |
version | Version number for the differential minimizer |
◆ setDerivative()
template<typename IT , typename OT >
Set the i-th derivative for the function being minimized.
- Parameters
-
i | Index of the derivative to be setted |
df | New i-th derivative for the function being minimized |
- See also
- fluxionum::DiffMinimizer::df
◆ setDerivatives()
template<typename IT , typename OT >
Set the derivatives of the function to be minimized.
- Parameters
-
df | New vector of derivatives of the function to be minimized |
- See also
- fluxionum::DiffMinimizer::df
The documentation for this class was generated from the following file: