RVL::NullFunctional< Scalar > Class Template Reference

Null-functional. More...

#include <functional.hh>

Inheritance diagram for RVL::NullFunctional< Scalar >:

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

Public Member Functions

 NullFunctional (const Space< Scalar > &sp)
 NullFunctional (const Functional< Scalar > &_f)
 ~NullFunctional ()
virtual Functional< Scalar > * clone () const
 virtual copy constructor: make a complete new copy including internal workspace.
virtual const Space< Scalar > & getDomain () const
virtual ostream & write (ostream &str) const

Protected Member Functions

virtual void apply (const Vector< Scalar > &x, Scalar &val) const
 $val = F(x)$
virtual void applyGradient (const Vector< Scalar > &x, Vector< Scalar > &g) const
 $g = grad F(x)$
virtual void applyHessian (const Vector< Scalar > &x, const Vector< Scalar > &dx, Vector< Scalar > &dy) const
 $dy = Hess F(x) dx$

Detailed Description

template<class Scalar>
class RVL::NullFunctional< Scalar >

Null-functional.

$f(x) = 0 $.

Definition at line 1669 of file functional.hh.


Constructor & Destructor Documentation

template<class Scalar>
RVL::NullFunctional< Scalar >::NullFunctional ( const Space< Scalar > &  sp  ) 

Definition at line 1699 of file functional.hh.

template<class Scalar>
RVL::NullFunctional< Scalar >::NullFunctional ( const Functional< Scalar > &  _f  ) 

Definition at line 1702 of file functional.hh.

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

Definition at line 1705 of file functional.hh.


Member Function Documentation

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

$val = F(x)$

Implements RVL::Functional< Scalar >.

Definition at line 1679 of file functional.hh.

template<class Scalar>
virtual void RVL::NullFunctional< Scalar >::applyGradient ( const Vector< Scalar > &  x,
Vector< Scalar > &  g 
) const [protected, virtual]

$g = grad F(x)$

Implements RVL::Functional< Scalar >.

Definition at line 1685 of file functional.hh.

References RVL::Vector< Scalar >::zero().

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

$dy = Hess F(x) dx$

Implements RVL::Functional< Scalar >.

Definition at line 1691 of file functional.hh.

References RVL::Vector< Scalar >::zero().

template<class Scalar>
virtual Functional<Scalar>* RVL::NullFunctional< Scalar >::clone (  )  const [virtual]

virtual copy constructor: make a complete new copy including internal workspace.

Virtual to permit override.

Implements RVL::Functional< Scalar >.

Definition at line 1711 of file functional.hh.

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

Implements RVL::Functional< Scalar >.

Definition at line 1716 of file functional.hh.

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

Implements RVL::Writeable.

Definition at line 1720 of file functional.hh.


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