ocra::RowFunction< T > Class Template Reference

RowFunction class. More...

#include <RowFunction.h>

Inheritance diagram for ocra::RowFunction< T >:

Collaboration diagram for ocra::RowFunction< T >:

Public Types
typedef T	functionType_t

Public Member Functions
	RowFunction (T *function, const cfl_size_t index)
	RowFunction (T *function, const std::vector< int > &indices)

Protected Member Functions
virtual void	computeValue (void) const
virtual void	computeGradient (void) const
virtual void	computeHessian (void) const
virtual void	computeJdot (void) const
virtual void	computeJdotXdot (void) const
virtual void	doUpdateSize (void)

Protected Attributes
Function *	_f
std::vector< int >	_indices

Detailed Description

template<class T>
class ocra::RowFunction< T >

RowFunction class.

Warning

None

A single row of an other Function. Be careful with this class, it still implies the full computation of the original function, and it involves a copy. TODO [mineur] : modify this comment in case this row functionality is implemented directly in the Function class

Definition at line 35 of file RowFunction.h.

Member Typedef Documentation

template<class T >

typedef T ocra::RowFunction< T >::functionType_t

Definition at line 39 of file RowFunction.h.

Constructor & Destructor Documentation

template<class T >

ocra::RowFunction< T >::RowFunction ( T *  function, const cfl_size_t  index  )

inline

Definition at line 102 of file RowFunction.h.

template<class T >

ocra::RowFunction< T >::RowFunction ( T *  function, const std::vector< int > &  indices  )

inline

Definition at line 113 of file RowFunction.h.

Member Function Documentation

template<class T >

void ocra::RowFunction< T >::computeGradient ( void  ) const

inlineprotectedvirtual

Definition at line 132 of file RowFunction.h.

template<class T >

void ocra::RowFunction< T >::computeHessian ( void  ) const

inlineprotectedvirtual

Definition at line 145 of file RowFunction.h.

template<class T >

void ocra::RowFunction< T >::computeJdot ( void  ) const

inlineprotectedvirtual

Definition at line 156 of file RowFunction.h.

template<class T >

void ocra::RowFunction< T >::computeJdotXdot ( void  ) const

inlineprotectedvirtual

Definition at line 169 of file RowFunction.h.

template<class T >

void ocra::RowFunction< T >::computeValue ( void  ) const

inlineprotectedvirtual

Definition at line 124 of file RowFunction.h.

template<class T >

void ocra::RowFunction< T >::doUpdateSize ( void  )

inlineprotectedvirtual

Definition at line 179 of file RowFunction.h.

Member Data Documentation

template<class T >

Function* ocra::RowFunction< T >::_f

protected

Definition at line 88 of file RowFunction.h.

template<class T >

std::vector<int> ocra::RowFunction< T >::_indices

protected

Definition at line 89 of file RowFunction.h.

---

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

• RowFunction.h