stan::math::vari_view_eigen< Derived > Class Template Reference

Detailed Description

template<typename Derived>
class stan::math::vari_view_eigen< Derived >

This struct is follows the CRTP for methods common to vari_view<> and vari_value<Matrix>.

Template Parameters

Derived

A var_value<> or vari_view with an inner type that has defined methods for subslices of the value and adjoint.

Definition at line 215 of file vari.hpp.

#include <vari.hpp>

Public Member Functions
auto	block (Eigen::Index start_row, Eigen::Index start_col, Eigen::Index num_rows, Eigen::Index num_cols) const
	A block view of the underlying Eigen matrices.
auto	block (Eigen::Index start_row, Eigen::Index start_col, Eigen::Index num_rows, Eigen::Index num_cols)
auto	head (Eigen::Index n) const
	View of the head of Eigen vector types.
auto	head (Eigen::Index n)
auto	tail (Eigen::Index n) const
	View of the tail of the Eigen vector types.
auto	tail (Eigen::Index n)
auto	segment (Eigen::Index i, Eigen::Index n) const
	View block of N elements starting at position i
auto	segment (Eigen::Index i, Eigen::Index n)
auto	transpose () const
	View transpose of eigen matrix.
auto	transpose ()
auto	row (Eigen::Index i) const
	View row of eigen matrices.
auto	row (Eigen::Index i)
auto	col (Eigen::Index i) const
	View column of eigen matrices.
auto	col (Eigen::Index i)
auto	diagonal () const
	View diagonal of eigen matrices.
auto	diagonal ()
auto	coeff (Eigen::Index i, Eigen::Index j) const
	Get coefficient of eigen matrices.
auto	coeff (Eigen::Index i, Eigen::Index j)
auto	coeff (Eigen::Index i) const
	Get coefficient of eigen matrices.
auto	coeff (Eigen::Index i)
auto	operator() (Eigen::Index i) const
	Get coefficient of eigen matrices.
auto	operator() (Eigen::Index i)
auto	operator() (Eigen::Index i, Eigen::Index j) const
	Get coefficient of eigen matrices.
auto	operator() (Eigen::Index i, Eigen::Index j)
auto	rowwise_reverse () const
	Return an expression that operates on the rows of the matrix vari
auto	rowwise_reverse ()
auto	colwise_reverse () const
	Return an expression that operates on the columns of the matrix vari
auto	colwise_reverse ()
auto	reverse () const
	Return an expression to reverse the order of the coefficients inside of a vari matrix.
auto	reverse ()
auto	topRows (Eigen::Index n) const
	Return a block consisting of the top rows.
auto	topRows (Eigen::Index n)
auto	bottomRows (Eigen::Index n) const
	Return a block consisting of the bottom rows.
auto	bottomRows (Eigen::Index n)
auto	middleRows (Eigen::Index start_row, Eigen::Index n) const
	Return a block consisting of rows in the middle.
auto	middleRows (Eigen::Index start_row, Eigen::Index n)
auto	leftCols (Eigen::Index n) const
	Return a block consisting of the left-most columns.
auto	leftCols (Eigen::Index n)
auto	rightCols (Eigen::Index n) const
	Return a block consisting of the right-most columns.
auto	rightCols (Eigen::Index n)
auto	middleCols (Eigen::Index start_col, Eigen::Index n) const
	Return a block consisting of columns in the middle.
auto	middleCols (Eigen::Index start_col, Eigen::Index n)
auto	array () const
	Return an Array expression.
auto	array ()
auto	matrix () const
	Return a Matrix expression.
auto	matrix ()
Eigen::Index	rows () const
	Return the number of rows for this class's val_ member.
Eigen::Index	cols () const
	Return the number of columns for this class's val_ member.
Eigen::Index	size () const
	Return the size of this class's val_ member.

Private Member Functions
	vari_view_eigen ()=default
	Making the base constructor private while making the derived class a friend help's catch if derived types inherit from another derived types base class.
Derived &	derived ()
	Helper function to return a reference to the derived type.
const Derived &	derived () const
	Helper function to return a constant reference to the derived type.

Private Attributes
friend	Derived

---

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

• stan/math/rev/core/vari.hpp