stan::math::KinsolFixedPointEnv< F > Struct Template Reference

Detailed Description

template<typename F>
struct stan::math::KinsolFixedPointEnv< F >

KINSOL algebraic system data holder that handles construction & destruction of SUNDIALS data, as well as auxiliary data that will be used for functor evaluation.

Template Parameters

F	functor type for system function.

Definition at line 35 of file algebra_solver_fp.hpp.

#include <algebra_solver_fp.hpp>

Public Member Functions
template<typename T , typename T_u , typename T_f >
	KinsolFixedPointEnv (const F &f, const Eigen::Matrix< T, -1, 1 > &x, const Eigen::VectorXd &y, const std::vector< double > &x_r, const std::vector< int > &x_i, std::ostream *msgs, const std::vector< T_u > &u_scale, const std::vector< T_f > &f_scale)
	Constructor when y is data.
template<typename T , typename T_u , typename T_f >
	KinsolFixedPointEnv (const F &f, const Eigen::Matrix< T, -1, 1 > &x, const Eigen::Matrix< stan::math::var, -1, 1 > &y, const std::vector< double > &x_r, const std::vector< int > &x_i, std::ostream *msgs, const std::vector< T_u > &u_scale, const std::vector< T_f > &f_scale)
	Constructor when y is param.
	~KinsolFixedPointEnv ()

Static Public Member Functions
static int	kinsol_f_system (N_Vector x, N_Vector f, void *user_data)
	Implements the user-defined function passed to KINSOL.

Public Attributes
sundials::Context	sundials_context_
	Sundials context.
const F &	f_
	RHS functor.
const Eigen::VectorXd	y_dummy
	val of params for y_ to refer to when params are var type
const Eigen::VectorXd &	y_
	ref to val of params
const size_t	N_
	system size
const size_t	M_
	nb.
const std::vector< double > &	x_r_
	real data
const std::vector< int > &	x_i_
	integer data
std::ostream *	msgs_
	message stream
void *	mem_
	KINSOL memory block.
N_Vector	nv_x_
	NVECTOR for unknowns.
N_Vector	nv_u_scal_
	NVECTOR for scaling u.
N_Vector	nv_f_scal_
	NVECTOR for scaling f.

---

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

• stan/math/rev/functor/algebra_solver_fp.hpp