Public Member Functions | Protected Attributes | List of all members
Eigen::Triplet< Scalar, StorageIndex > Class Template Reference
Sparse linear algebra » Reference » SparseCore_Module

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

#include <SparseUtil.h>

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()

Constructor & Destructor Documentation

◆ Triplet() [1/2]

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>
Eigen::Triplet< Scalar, StorageIndex >::Triplet ( )
inline
189 : m_row(0), m_col(0), m_value(0) {}
Eigen::Triplet::m_row
StorageIndex m_row
Definition: SparseUtil.h:203
Eigen::Triplet::m_col
StorageIndex m_col
Definition: SparseUtil.h:203
Eigen::Triplet::m_value
Scalar m_value
Definition: SparseUtil.h:204

◆ Triplet() [2/2]

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
191 : m_row(i), m_col(j), m_value(v) {}
v
Array< int, Dynamic, 1 > v
Definition: Array_initializer_list_vector_cxx11.cpp:1
i
int i
Definition: BiCGSTAB_step_by_step.cpp:9
j
std::ptrdiff_t j
Definition: tut_arithmetic_redux_minmax.cpp:2

Member Function Documentation

◆ col()

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
197 { return m_col; }

References Eigen::Triplet< Scalar, StorageIndex >::m_col.

◆ row()

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
194 { return m_row; }

References Eigen::Triplet< Scalar, StorageIndex >::m_row.

◆ value()

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>
const Scalar& Eigen::Triplet< Scalar, StorageIndex >::value ( ) const
inline
Returns
the value of the element
200 { return m_value; }

References Eigen::Triplet< Scalar, StorageIndex >::m_value.

Member Data Documentation

◆ m_col

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

Referenced by Eigen::Triplet< Scalar, StorageIndex >::col().

◆ m_row

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

Referenced by Eigen::Triplet< Scalar, StorageIndex >::row().

◆ m_value

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

Referenced by Eigen::Triplet< Scalar, StorageIndex >::value().

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