SIMC_MSME_Centered_EnergyFunction< T1, T2, DistType > Class Template Reference

A class written for SIMC non-linear optimization tools. This class redefines the basis set of the energy function, given the degree of freedom. It uses the descrete cosine basis space. More...

#include <SIMC_MSME_Centered_EnergyFunction.h>

Inheritance diagram for SIMC_MSME_Centered_EnergyFunction< T1, T2, DistType >:

List of all members.

Public Member Functions
	SIMC_MSME_Centered_EnergyFunction (StackSet< Stack< short, LinTransStack< T2 > > > &sss, unsigned int nbasis=1)
	Constructor.
	SIMC_MSME_Centered_EnergyFunction (StackSet< Stack< short, LinTransStack< T2 > > > &sss, unsigned int nbasis, const SimpleVTMat< T1 > &basis)
	Constructor.
void	SetNBasis (unsigned int n, const SimpleVTMat< T1 > &basis)
	Sets number of basis, and the basis matrix.
void	SetNBasis (unsigned int n)
	Sets number of basis. It also computes basis functions for given number of degrees-of-freedom (nbasis).
const SimpleVTMat< T1 > &	GetBasisMat ()
	returns the basis matrix
unsigned int	GetMaxNSlice ()
	Returns the number of slices of the stack with max number of slices.
void	SetMask (const SimpleTField< T2 > *mask=NULL)
	sets mask using the pointer
SimpleVTVec< T1 >	GetParam () const
	sets mask using the pointer
void	SetParam (const SimpleVTVec< T1 > &paramB)
	set param
T1	Hess (SimpleVTMat< T1 > &cov) const
	returns the hessian matrix given the number of basis. It uses the Hess function of the SIMC base energy function.
T1	Grad (SimpleVTVec< T1 > &grad) const
	returns the gradient vector. It uses the Grad function of the SIMC base energy function.
T1	GradHess (SimpleVTVec< T1 > &grad, SimpleVTMat< T1 > &cov) const
	returns the gradient and the hessian matrix.
template<>
const char	_versionID []
template<>
const char	_versionID []
Static Public Attributes
static const char	_versionID []
Protected Types
typedef SIMCBaseEnergyFunction < short, T1, T2, DistType >	BaseType
	Alias.
typedef SIMC_MSME_Centered_EnergyFunction < T1, T2, DistType >	SelfType
	Alias.
Protected Attributes
SimpleVTMat< T1 >	_basis
	basis matrix
unsigned int	_nbasis
	number of basis (degrees-of-freedom)
SimpleVTVec< T1 >	_original_dof
	original parameters

---

Detailed Description

template<typename T1 = float, typename T2 = float, typename DistType = L2<T2>>
class SIMC_MSME_Centered_EnergyFunction< T1, T2, DistType >

A class written for SIMC non-linear optimization tools. This class redefines the basis set of the energy function, given the degree of freedom. It uses the descrete cosine basis space.

Author:

Kio Kim 2007-2011

Id:

SIMC_MSME_Centered_EnergyFunction.h,v 1.18 2012/02/24 02:05:29 kio Exp

---

Member Function Documentation

template<typename T1 = float, typename T2 = float, typename DistType = L2<T2>>

SimpleVTVec<T1> SIMC_MSME_Centered_EnergyFunction< T1, T2, DistType >::GetParam

(

)

const [inline]

sets mask using the pointer

getParam

Reimplemented from SIMCBaseEnergyFunction< short, T1, T2, DistType >.