oops::SaddlePointMinimizer< MODEL, OBS > Class Template Reference

SaddlePoint Minimizer. More...

#include <SaddlePointMinimizer.h>

Inheritance diagram for oops::SaddlePointMinimizer< MODEL, OBS >:

Collaboration diagram for oops::SaddlePointMinimizer< MODEL, OBS >:

Public Member Functions
const std::string	classname () const override
	SaddlePointMinimizer (const eckit::Configuration &, const CostFct_ &J)
	~SaddlePointMinimizer ()
Public Member Functions inherited from oops::Minimizer< MODEL, OBS >
	Minimizer (const CostFct_ &J)
virtual	~Minimizer ()
ControlIncrement< MODEL, OBS > *	minimize (const eckit::Configuration &)

Private Types
typedef ControlIncrement< MODEL, OBS >	CtrlInc_
typedef CostFunction< MODEL, OBS >	CostFct_
typedef Minimizer< MODEL, OBS >	Minimizer_
typedef DualVector< MODEL, OBS >	Multipliers_

Private Member Functions
CtrlInc_ *	doMinimize (const eckit::Configuration &) override

Private Attributes
const CostFct_ &	J_
std::unique_ptr< CtrlInc_ >	gradJb_
std::vector< SaddlePointVector< MODEL, OBS > >	xyVEC_
std::vector< SaddlePointVector< MODEL, OBS > >	pqVEC_

Detailed Description

template<typename MODEL, typename OBS>
class oops::SaddlePointMinimizer< MODEL, OBS >

SaddlePoint Minimizer.

Implements the SaddlePoint algorithm.

Definition at line 43 of file SaddlePointMinimizer.h.

Member Typedef Documentation

CostFct_

template<typename MODEL , typename OBS >

typedef CostFunction<MODEL, OBS> oops::SaddlePointMinimizer< MODEL, OBS >::CostFct_

private

Definition at line 45 of file SaddlePointMinimizer.h.

CtrlInc_

template<typename MODEL , typename OBS >

typedef ControlIncrement<MODEL, OBS> oops::SaddlePointMinimizer< MODEL, OBS >::CtrlInc_

private

Definition at line 44 of file SaddlePointMinimizer.h.

Minimizer_

template<typename MODEL , typename OBS >

typedef Minimizer<MODEL, OBS> oops::SaddlePointMinimizer< MODEL, OBS >::Minimizer_

private

Definition at line 46 of file SaddlePointMinimizer.h.

Multipliers_

template<typename MODEL , typename OBS >

typedef DualVector<MODEL, OBS> oops::SaddlePointMinimizer< MODEL, OBS >::Multipliers_

private

Definition at line 47 of file SaddlePointMinimizer.h.

Constructor & Destructor Documentation

SaddlePointMinimizer()

template<typename MODEL , typename OBS >

oops::SaddlePointMinimizer< MODEL, OBS >::SaddlePointMinimizer ( const eckit::Configuration &  , const CostFct_ &  J  )

inline

Definition at line 52 of file SaddlePointMinimizer.h.

~SaddlePointMinimizer()

template<typename MODEL , typename OBS >

oops::SaddlePointMinimizer< MODEL, OBS >::~SaddlePointMinimizer ( )

inline

Definition at line 54 of file SaddlePointMinimizer.h.

Member Function Documentation

classname()

template<typename MODEL , typename OBS >

const std::string oops::SaddlePointMinimizer< MODEL, OBS >::classname ( ) const

inlineoverridevirtual

Implements oops::Minimizer< MODEL, OBS >.

Definition at line 51 of file SaddlePointMinimizer.h.

doMinimize()

template<typename MODEL , typename OBS >

ControlIncrement< MODEL, OBS > * oops::SaddlePointMinimizer< MODEL, OBS >::doMinimize ( const eckit::Configuration &  config )

overrideprivatevirtual

Implements oops::Minimizer< MODEL, OBS >.

Definition at line 70 of file SaddlePointMinimizer.h.

Here is the call graph for this function:

Member Data Documentation

gradJb_

template<typename MODEL , typename OBS >

std::unique_ptr<CtrlInc_> oops::SaddlePointMinimizer< MODEL, OBS >::gradJb_

private

Definition at line 60 of file SaddlePointMinimizer.h.

J_

template<typename MODEL , typename OBS >

const CostFct_& oops::SaddlePointMinimizer< MODEL, OBS >::J_

private

Definition at line 59 of file SaddlePointMinimizer.h.

pqVEC_

template<typename MODEL , typename OBS >

std::vector< SaddlePointVector<MODEL, OBS> > oops::SaddlePointMinimizer< MODEL, OBS >::pqVEC_

private

Definition at line 63 of file SaddlePointMinimizer.h.

xyVEC_

template<typename MODEL , typename OBS >

std::vector< SaddlePointVector<MODEL, OBS> > oops::SaddlePointMinimizer< MODEL, OBS >::xyVEC_

private

Definition at line 62 of file SaddlePointMinimizer.h.

---

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

• SaddlePointMinimizer.h