RVL::ResidualOperator< Scalar > Class Template Reference

Given an input vector d, and an operator G, this operator implements $F(x) = G(x)-d$. More...

#include <ls.hh>

Inheritance diagram for RVL::ResidualOperator< Scalar >:

RVL::Operator< Scalar > RVL::Writeable List of all members.

Public Member Functions

 ResidualOperator (Operator< Scalar > const &GG, Vector< Scalar > const &dd)
 Usual constructor; just needs a pointer to the linear operator.
 ResidualOperator (ResidualOperator< Scalar > const &a)
 ~ResidualOperator ()
const Space< Scalar > & getDomain () const
 access to domain, range
const Space< Scalar > & getRange () const
Scalar getMaxStep (const Vector< Scalar > &x, const Vector< Scalar > &dx) const
ostream & write (ostream &str) const

Protected Member Functions

void apply (const Vector< Scalar > &x, Vector< Scalar > &y) const
void applyDeriv (const Vector< Scalar > &x, const Vector< Scalar > &dx, Vector< Scalar > &dy) const
void applyAdjDeriv (const Vector< Scalar > &x, const Vector< Scalar > &dy, Vector< Scalar > &dx) const
virtual Operator< Scalar > * clone () const

Detailed Description

template<class Scalar>
class RVL::ResidualOperator< Scalar >

Given an input vector d, and an operator G, this operator implements $F(x) = G(x)-d$.

Definition at line 124 of file ls.hh.


Constructor & Destructor Documentation

template<class Scalar>
RVL::ResidualOperator< Scalar >::ResidualOperator ( Operator< Scalar > const &  GG,
Vector< Scalar > const &  dd 
)

Usual constructor; just needs a pointer to the linear operator.

Definition at line 178 of file ls.hh.

template<class Scalar>
RVL::ResidualOperator< Scalar >::ResidualOperator ( ResidualOperator< Scalar > const &  a  ) 

Definition at line 191 of file ls.hh.

template<class Scalar>
RVL::ResidualOperator< Scalar >::~ResidualOperator (  ) 

Definition at line 192 of file ls.hh.


Member Function Documentation

template<class Scalar>
void RVL::ResidualOperator< Scalar >::apply ( const Vector< Scalar > &  x,
Vector< Scalar > &  y 
) const [protected, virtual]

Implements RVL::Operator< Scalar >.

Definition at line 135 of file ls.hh.

References RVL::Operator< Scalar >::export_apply(), and RVL::Vector< Scalar >::linComb().

template<class Scalar>
void RVL::ResidualOperator< Scalar >::applyDeriv ( const Vector< Scalar > &  x,
const Vector< Scalar > &  dx,
Vector< Scalar > &  dy 
) const [protected, virtual]

Implements RVL::Operator< Scalar >.

Definition at line 147 of file ls.hh.

References RVL::Operator< Scalar >::export_applyDeriv().

template<class Scalar>
void RVL::ResidualOperator< Scalar >::applyAdjDeriv ( const Vector< Scalar > &  x,
const Vector< Scalar > &  dy,
Vector< Scalar > &  dx 
) const [protected, virtual]

Implements RVL::Operator< Scalar >.

Definition at line 159 of file ls.hh.

References RVL::Operator< Scalar >::export_applyAdjDeriv().

template<class Scalar>
virtual Operator<Scalar>* RVL::ResidualOperator< Scalar >::clone (  )  const [protected, virtual]

Implements RVL::Operator< Scalar >.

Definition at line 172 of file ls.hh.

template<class Scalar>
const Space<Scalar>& RVL::ResidualOperator< Scalar >::getDomain (  )  const [virtual]

access to domain, range

Implements RVL::Operator< Scalar >.

Definition at line 195 of file ls.hh.

template<class Scalar>
const Space<Scalar>& RVL::ResidualOperator< Scalar >::getRange (  )  const [virtual]

Implements RVL::Operator< Scalar >.

Definition at line 196 of file ls.hh.

template<class Scalar>
Scalar RVL::ResidualOperator< Scalar >::getMaxStep ( const Vector< Scalar > &  x,
const Vector< Scalar > &  dx 
) const [virtual]

Reimplemented from RVL::Operator< Scalar >.

Definition at line 198 of file ls.hh.

template<class Scalar>
ostream& RVL::ResidualOperator< Scalar >::write ( ostream &  str  )  const [virtual]

Implements RVL::Writeable.

Definition at line 203 of file ls.hh.


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for RVL by  doxygen 1.4.7