A functor object to work with Eigen's non-linear solver to numerically solve for the kappa parameter of a von Mises distribution. More...

Public Member Functions
	vonMisesKappaFunctor (float Rin)
	Constructor. More...

int	operator() (const Eigen::VectorXd &x, Eigen::VectorXd &fvec) const
	Calculates the value of the function to be solved. More...

int	df (const Eigen::VectorXd &x, Eigen::MatrixXd &fjac) const
	Calculates the value of the derivative of the function to be solved. More...

Public Attributes
float	R
	R parameter of the problem (magnitude of the resultant vector)

Detailed Description

A functor object to work with Eigen's non-linear solver to numerically solve for the kappa parameter of a von Mises distribution.

Constructor & Destructor Documentation

canopy::vonMisesKappaFunctor::vonMisesKappaFunctor ( float Rin )

inline

Constructor.

Parameters

R	The R parameter of the problem (magnitude of the resultant vector)

int canopy::vonMisesKappaFunctor::df	(	const Eigen::VectorXd &	x,
		Eigen::MatrixXd &	fjac
	)		const

inline

Calculates the value of the derivative of the function to be solved.

Parameters

x	Array containing the (single) parameter of the function
fjac	Array in which the value of the derivative of the function at x is returned by reference

int canopy::vonMisesKappaFunctor::operator()	(	const Eigen::VectorXd &	x,
		Eigen::VectorXd &	fvec
	)		const

inline

Calculates the value of the function to be solved.

Parameters

x	Array containing the (single) parameter of the function
fvec	Array in which the value of the function at x is returned by reference

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