ncorr::details::nloptimizer_base Class Reference

#include <ncorr.h>

Inheritance diagram for ncorr::details::nloptimizer_base:

Public Types
typedef std::ptrdiff_t	difference_type
typedef std::pair< difference_type, difference_type >	coords

Public Member Functions
	nloptimizer_base () noexcept=default
	nloptimizer_base (const nloptimizer_base &)=default
	nloptimizer_base (nloptimizer_base &&)=default
nloptimizer_base &	operator= (const nloptimizer_base &)=default
nloptimizer_base &	operator= (nloptimizer_base &&)=default
virtual	~nloptimizer_base () noexcept=default
	nloptimizer_base (difference_type order, difference_type num_params)
std::pair< const Array2D< double > &, bool >	global (const Array2D< double > &) const
std::pair< const Array2D< double > &, bool >	operator() (const Array2D< double > &) const

Protected Member Functions
virtual bool	initial_guess () const =0
virtual bool	iterative_search () const =0
virtual bool	newton () const =0
void	chk_input_params_size (const Array2D< double > &) const

Protected Attributes
Array2D< double >	grad_buf
Array2D< double >	hess_buf
Array2D< double >	params
double	cutoff_norm = 1e-6
difference_type	cutoff_iterations = 100

Detailed Description

Definition at line 22 of file ncorr.h.

Member Typedef Documentation

coords

typedef std::pair<difference_type,difference_type> ncorr::details::nloptimizer_base::coords

Definition at line 25 of file ncorr.h.

difference_type

typedef std::ptrdiff_t ncorr::details::nloptimizer_base::difference_type

Definition at line 24 of file ncorr.h.

Constructor & Destructor Documentation

nloptimizer_base() [1/4]

ncorr::details::nloptimizer_base::nloptimizer_base ( )

defaultnoexcept

nloptimizer_base() [2/4]

ncorr::details::nloptimizer_base::nloptimizer_base ( const nloptimizer_base &  )

default

nloptimizer_base() [3/4]

ncorr::details::nloptimizer_base::nloptimizer_base ( nloptimizer_base &&  )

default

~nloptimizer_base()

virtual ncorr::details::nloptimizer_base::~nloptimizer_base ( )

virtualdefaultnoexcept

nloptimizer_base() [4/4]

ncorr::details::nloptimizer_base::nloptimizer_base ( difference_type  order, difference_type  num_params  )

inline

Definition at line 36 of file ncorr.h.

Member Function Documentation

chk_input_params_size()

void ncorr::details::nloptimizer_base::chk_input_params_size ( const Array2D< double > &  params ) const

protected

Definition at line 49 of file ncorr.cpp.

global()

std::pair< const Array2D< double > &, bool > ncorr::details::nloptimizer_base::global

(

const Array2D< double > &

params_init

)

const

Definition at line 24 of file ncorr.cpp.

initial_guess()

virtual bool ncorr::details::nloptimizer_base::initial_guess ( ) const

protectedpure virtual

iterative_search()

virtual bool ncorr::details::nloptimizer_base::iterative_search ( ) const

protectedpure virtual

newton()

virtual bool ncorr::details::nloptimizer_base::newton ( ) const

protectedpure virtual

operator()()

std::pair< const Array2D< double > &, bool > ncorr::details::nloptimizer_base::operator()

(

const Array2D< double > &

params_guess

)

const

Definition at line 37 of file ncorr.cpp.

operator=() [1/2]

nloptimizer_base & ncorr::details::nloptimizer_base::operator= ( const nloptimizer_base &  )

default

operator=() [2/2]

nloptimizer_base & ncorr::details::nloptimizer_base::operator= ( nloptimizer_base &&  )

default

Member Data Documentation

cutoff_iterations

difference_type ncorr::details::nloptimizer_base::cutoff_iterations = 100

protected

Definition at line 56 of file ncorr.h.

cutoff_norm

double ncorr::details::nloptimizer_base::cutoff_norm = 1e-6

protected

Definition at line 55 of file ncorr.h.

grad_buf

Array2D<double> ncorr::details::nloptimizer_base::grad_buf

mutableprotected

Definition at line 52 of file ncorr.h.

hess_buf

Array2D<double> ncorr::details::nloptimizer_base::hess_buf

mutableprotected

Definition at line 53 of file ncorr.h.

params

Array2D<double> ncorr::details::nloptimizer_base::params

mutableprotected

Definition at line 54 of file ncorr.h.

---

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

• include/ncorr.h
• src/ncorr.cpp