OMDc  1.0.0
created from 0b26fa0 on deploy-documentation
OMDc::LineSearchFunctor Class Reference

Functor for linesearch along geodesic. More...

#include <Functor.hpp>

Public Member Functions

const Eigen::Index costDim ()
 dimension of the cost function vector More...
 
 LineSearchFunctor (DataStore &DS)
 standard constructor More...
 
int cost (Eigen::VectorXd &fvec, const Eigen::MatrixXd &L) const
 evaluates cost function at bases More...
 
double derivative (Eigen::MatrixXd &dF, const Eigen::MatrixXd &L) const
 componentwise derivative w.r.t. given modes More...
 

Detailed Description

Functor for linesearch along geodesic.

Constructor & Destructor Documentation

◆ LineSearchFunctor()

OMDc::LineSearchFunctor::LineSearchFunctor ( DataStore DS)

standard constructor

Parameters
DSreference to data holder

Member Function Documentation

◆ cost()

int OMDc::LineSearchFunctor::cost ( Eigen::VectorXd &  fvec,
const Eigen::MatrixXd &  L 
) const

evaluates cost function at bases

Parameters
fveccost function value (scalar-valued)
Lbases where geodesic is evaluated
Returns
0 for success

◆ costDim()

const Eigen::Index OMDc::LineSearchFunctor::costDim ( )
inline

dimension of the cost function vector

Returns
dim == 1

◆ derivative()

double OMDc::LineSearchFunctor::derivative ( Eigen::MatrixXd &  dF,
const Eigen::MatrixXd &  L 
) const

componentwise derivative w.r.t. given modes

Parameters
dFreference to derivative (n x r)
Lgiven modes (n x r)
Returns
value of the cost function

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

Automatic Control and Systems Theory, Ruhr-Univeristy Bochum