ERC CISST - cisst software

---

nmrFminSolver Class Reference
[Numerical Methods]

Collaboration diagram for nmrFminSolver:

[legend]List of all members.

---

Detailed Description

Definition at line 44 of file nmrFminSolver.h.

Public Member Functions

• nmrFminSolver (void)
• nmrFminSolver (CISSTNETLIB_INTEGER n, CISSTNETLIB_INTEGER nlin, CISSTNETLIB_INTEGER nnonlin, CISSTNETLIB_INTEGER niter, CISSTNETLIB_INTEGER nstep)
• ~nmrFminSolver ()
• void Allocate (CISSTNETLIB_INTEGER n, CISSTNETLIB_INTEGER nlin, CISSTNETLIB_INTEGER nnonlin, CISSTNETLIB_INTEGER niter, CISSTNETLIB_INTEGER nstep)
• O8USERCONFIG & GetOptions (void)
• void SetOptions (struct O8USERCONFIG &userCfg)
• void PrintOptions (void)
• template<int __instanceLine, class __elementType> void Solve (nmrCallBackFunctionF1< __instanceLine, __elementType > &callBack, vctDynamicVector< CISSTNETLIB_DOUBLE > &X) throw (std::runtime_error)
• template<int __instanceLine, class __elementType> void Solve (nmrCallBackFunctionF1< __instanceLine, __elementType > &callBack, vctDynamicVector< CISSTNETLIB_DOUBLE > &X, vctDynamicVector< CISSTNETLIB_DOUBLE > &lbound, vctDynamicVector< CISSTNETLIB_DOUBLE > &ubound, vctDynamicMatrix< CISSTNETLIB_DOUBLE > &alin) throw (std::runtime_error)
• template<int __instanceLineF, class __elementTypeF, int __instanceLineC, class __elementTypeC> void Solve (nmrCallBackFunctionF1< __instanceLineF, __elementTypeF > &callBackF, vctDynamicVector< CISSTNETLIB_DOUBLE > &X, nmrCallBackFunctionC< __instanceLineC, __elementTypeC > &callBackC, vctDynamicVector< CISSTNETLIB_DOUBLE > &lbound, vctDynamicVector< CISSTNETLIB_DOUBLE > &ubound) throw (std::runtime_error)
• template<int __instanceLineF, class __elementTypeF, int __instanceLineC, class __elementTypeC> void Solve (nmrCallBackFunctionF1< __instanceLineF, __elementTypeF > &callBackF, vctDynamicVector< CISSTNETLIB_DOUBLE > &X, nmrCallBackFunctionC< __instanceLineC, __elementTypeC > &callBackC, vctDynamicVector< CISSTNETLIB_DOUBLE > &lbound, vctDynamicVector< CISSTNETLIB_DOUBLE > &ubound, vctDynamicMatrix< CISSTNETLIB_DOUBLE > &alin) throw (std::runtime_error)
• void Solve (void(*efFunctionPointer)(CISSTNETLIB_INTEGER, CISSTNETLIB_DOUBLE[], CISSTNETLIB_DOUBLE *), vctDynamicVector< CISSTNETLIB_DOUBLE > &X, void(*econFunctionPointer)(CISSTNETLIB_INTEGER, CISSTNETLIB_INTEGER, CISSTNETLIB_INTEGER, CISSTNETLIB_INTEGER[], CISSTNETLIB_DOUBLE[], CISSTNETLIB_DOUBLE[], CISSTNETLIB_INTEGER[]), vctDynamicVector< CISSTNETLIB_DOUBLE > &lbound, vctDynamicVector< CISSTNETLIB_DOUBLE > &ubound, vctDynamicMatrix< CISSTNETLIB_DOUBLE > &alin) throw (std::runtime_error)

Protected Attributes

• O8USERFUNC UserFn
• O8USERCONFIG UserCfg
• CISSTNETLIB_INTEGER N
• CISSTNETLIB_INTEGER NLin
• CISSTNETLIB_INTEGER NNonLin
• CISSTNETLIB_INTEGER NIter
• CISSTNETLIB_INTEGER NStep

---

Constructor & Destructor Documentation

nmrFminSolver::nmrFminSolver

(

void

)

[inline]

Default constructor. This constructor doesn't allocate any memory. If you use this constructor, you will need to use one of the Allocate() methods before you can use the Solve method.

Definition at line 59 of file nmrFminSolver.h.

References Allocate().

nmrFminSolver::nmrFminSolver	(	CISSTNETLIB_INTEGER	n,
		CISSTNETLIB_INTEGER	nlin,
		CISSTNETLIB_INTEGER	nnonlin,
		CISSTNETLIB_INTEGER	niter,
		CISSTNETLIB_INTEGER	nstep
	)			[inline]

Constructor with memory allocation. This constructor allocates the memory based on N. It relies on the method Allocate(). The next call to the Solve() method will check that the parameters match the dimension.

Parameters:

	n	Number of variables
	nlin	Number of linear constraints
	nnonlin	Number of non linear constraints
	niter	Max number of iterations
	nstep	(typ. 20) This order will be used for the output as well.

Definition at line 77 of file nmrFminSolver.h.

References Allocate().

---

Member Function Documentation

void nmrFminSolver::Allocate	(	CISSTNETLIB_INTEGER	n,
		CISSTNETLIB_INTEGER	nlin,
		CISSTNETLIB_INTEGER	nnonlin,
		CISSTNETLIB_INTEGER	niter,
		CISSTNETLIB_INTEGER	nstep
	)			[inline]

This method allocates the memory based on N. The next call to the Solve() method will check that the parameters match the dimension.

Parameters:

n

Number of variables

Definition at line 92 of file nmrFminSolver.h.

References N, NIter, NLin, NNonLin, and NStep.

Referenced by nmrFminSolver().

---

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

• nmrFminSolver.h

---