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

The Saddle-point matrix. More...

#include <SaddlePointMatrix.h>

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

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

Public Member Functions
	SaddlePointMatrix (const CostFct_ &j)
void	multiply (const SPVector_ &, SPVector_ &) const

Private Types
typedef ControlIncrement< MODEL, OBS >	CtrlInc_
typedef CostFunction< MODEL, OBS >	CostFct_
typedef SaddlePointVector< MODEL, OBS >	SPVector_

Private Attributes
CostFct_ const &	j_

Detailed Description

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

The Saddle-point matrix.

The solvers represent matrices as objects that implement a "multiply" method. This class defines objects that apply the saddle-point matrix.

Definition at line 34 of file SaddlePointMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 36 of file SaddlePointMatrix.h.

CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 35 of file SaddlePointMatrix.h.

SPVector_

template<typename MODEL , typename OBS >

typedef SaddlePointVector<MODEL, OBS> oops::SaddlePointMatrix< MODEL, OBS >::SPVector_

private

Definition at line 37 of file SaddlePointMatrix.h.

Constructor & Destructor Documentation

SaddlePointMatrix()

template<typename MODEL , typename OBS >

oops::SaddlePointMatrix< MODEL, OBS >::SaddlePointMatrix ( const CostFct_ &  j )

inlineexplicit

Definition at line 40 of file SaddlePointMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL , typename OBS >

void oops::SaddlePointMatrix< MODEL, OBS >::multiply	(	const SPVector_ &	x,
		SPVector_ &	z
	)		const

Definition at line 50 of file SaddlePointMatrix.h.

Here is the call graph for this function:

Member Data Documentation

j_

template<typename MODEL , typename OBS >

CostFct_ const& oops::SaddlePointMatrix< MODEL, OBS >::j_

private

Definition at line 44 of file SaddlePointMatrix.h.

---

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

• SaddlePointMatrix.h