HessMatrix Class Reference

Represantation of a Hessian Matrix for a function. More...

#include <func.h>

Inheritance diagram for HessMatrix:
Inheritance graph
[legend]
Collaboration diagram for HessMatrix:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 HessMatrix (Pointer< const Func > f_, Pointer< const UserVector< double > > x0_)
 Constructor for a function and a dvector.
 HessMatrix (const Func &f_, const UserVector< double > &x0_)
void MultV (UserVector< double > &y, const UserVector< double > &x) const
 Computes the product of the Hessian and a UserVector<double>.
void print (ostream &out) const
 Prints some information about this matrix.

Protected Attributes

Pointer< const UserVector
< double > > 
x0
 The UserVector<double> to compute the Hessian for.
Pointer< const Funcf
 The function to compute the Hessian for.

Detailed Description

Represantation of a Hessian Matrix for a function.

So it's like a wrapper-class for Func::HessMult(...)

See also:
Func::HessMult(dvector&, const dvector&, const dvector&)

Definition at line 456 of file func.h.


Constructor & Destructor Documentation

HessMatrix::HessMatrix ( Pointer< const Func f_,
Pointer< const UserVector< double > >  x0_ 
) [inline]

Constructor for a function and a dvector.

Parameters:
f_ The function, which Hessian should be computed.
x0_ The UserVector<double> to compute the Hessian of f_ for.

Definition at line 471 of file func.h.

HessMatrix::HessMatrix ( const Func f_,
const UserVector< double > &  x0_ 
) [inline]

Definition at line 475 of file func.h.


Member Function Documentation

void HessMatrix::MultV ( UserVector< double > &  y,
const UserVector< double > &  x 
) const [inline, virtual]

Computes the product of the Hessian and a UserVector<double>.

Parameters:
y The UserVector<double> to store the result in: $ y = \nabla^2 f(x0) \cdot x $.
x The UserVector<double> to multiply with the Hessian.
See also:
Func::HessMult(dvector&, const dvector&, const dvector&)

Implements UserMatrix.

Definition at line 484 of file func.h.

void HessMatrix::print ( ostream &  out  )  const [inline, virtual]

Prints some information about this matrix.

Prints the dvector x0 and the function.

Parameters:
out The ostream to print to.

Reimplemented from UserMatrix.

Definition at line 494 of file func.h.


Member Data Documentation

Pointer<const UserVector<double> > HessMatrix::x0 [protected]

The UserVector<double> to compute the Hessian for.

Definition at line 460 of file func.h.

Pointer<const Func> HessMatrix::f [protected]

The function to compute the Hessian for.

Definition at line 464 of file func.h.


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

Generated on 10 Mar 2013 for LaGO by  doxygen 1.6.1