power_method.h File Reference

#include "sopt/config.h"
#include <functional>
#include <limits>
#include <memory>
#include <tuple>
#include <utility>
#include "sopt/exception.h"
#include "sopt/linear_transform.h"
#include "sopt/logging.h"
#include "sopt/relative_variation.h"
#include "sopt/types.h"

Include dependency graph for power_method.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	sopt::algorithm::PowerMethod< SCALAR >
	Eigenvalue and eigenvector for eigenvalue with largest magnitude. More...
struct	sopt::algorithm::PowerMethod< SCALAR >::DiagnosticAndResult
	Holds result vector as well. More...

Namespaces
	sopt
	sopt::algorithm

Macros
#define	SOPT_MACRO(NAME, TYPE)

Functions
template<typename T >
std::tuple< t_real, T >	sopt::algorithm::power_method (const sopt::LinearTransform< T > &op, const t_uint niters, const t_real relative_difference, const T &initial_vector)
	Returns the eigenvalue and eigenvector for eigenvalue of the Linear Transform with largest magnitude. More...
template<typename T >
std::tuple< t_real, T, std::shared_ptr< sopt::LinearTransform< T > > >	sopt::algorithm::normalise_operator (const std::shared_ptr< sopt::LinearTransform< T > const > &op, const t_uint &niters, const t_real &relative_difference, const T &initial_vector)
template<typename T >
std::tuple< t_real, T, sopt::LinearTransform< T > >	sopt::algorithm::normalise_operator (const sopt::LinearTransform< T > &op, const t_uint &niters, const t_real &relative_difference, const T &initial_vector)

Macro Definition Documentation

SOPT_MACRO

#define SOPT_MACRO	(		NAME,
			TYPE
	)

Value:

  TYPE const &NAME() const { return NAME##_; }  \
  PowerMethod<SCALAR> &NAME(TYPE const &(NAME)) { \
    NAME##_ = NAME;                             \
    return *this;                               \
  }                                             \
                                                \
 protected:                                     \
  TYPE NAME##_;                                 \
                                                \
 public:

Definition at line 168 of file power_method.h.