Eigen::Triplet< Scalar, StorageIndex > Class Template Reference

A small structure to hold a non zero as a triplet (i,j,value). More...

#include <SparseUtil.h>

Collaboration diagram for Eigen::Triplet< Scalar, StorageIndex >:

List of all members.

Public Member Functions
	Triplet ()
	Triplet (const StorageIndex &i, const StorageIndex &j, const Scalar &v=Scalar(0))
const StorageIndex &	row () const
const StorageIndex &	col () const
const Scalar &	value () const
Protected Attributes
StorageIndex	m_row
StorageIndex	m_col
Scalar	m_value

---

Detailed Description

template<typename Scalar, typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>
class Eigen::Triplet< Scalar, StorageIndex >

A small structure to hold a non zero as a triplet (i,j,value).

See also:

SparseMatrix::setFromTriplets()

Definition at line 154 of file SparseUtil.h.

---

Constructor & Destructor Documentation

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

Eigen::Triplet< Scalar, StorageIndex >::Triplet

(

)

[inline]

Definition at line 157 of file SparseUtil.h.

: m_row(0), m_col(0), m_value(0) {}

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

Eigen::Triplet< Scalar, StorageIndex >::Triplet	(	const StorageIndex &	i,
		const StorageIndex &	j,
		const Scalar &	v = Scalar(0)
	)		[inline]

Definition at line 159 of file SparseUtil.h.

    : m_row(i), m_col(j), m_value(v)
  {}

---

Member Function Documentation

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

const StorageIndex& Eigen::Triplet< Scalar, StorageIndex >::col

(

)

const [inline]

Returns:

the column index of the element

Definition at line 167 of file SparseUtil.h.

{ return m_col; }

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

const StorageIndex& Eigen::Triplet< Scalar, StorageIndex >::row

(

)

const [inline]

Returns:

the row index of the element

Definition at line 164 of file SparseUtil.h.

{ return m_row; }

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

const Scalar& Eigen::Triplet< Scalar, StorageIndex >::value

(

)

const [inline]

Returns:

the value of the element

Definition at line 170 of file SparseUtil.h.

{ return m_value; }

---

Member Data Documentation

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

StorageIndex Eigen::Triplet< Scalar, StorageIndex >::m_col [protected]

Definition at line 172 of file SparseUtil.h.

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

StorageIndex Eigen::Triplet< Scalar, StorageIndex >::m_row [protected]

Definition at line 172 of file SparseUtil.h.

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>

Scalar Eigen::Triplet< Scalar, StorageIndex >::m_value [protected]

Definition at line 173 of file SparseUtil.h.

---

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

• SparseUtil.h