Public Member Functions | Protected Attributes | List of all members
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>

Public Member Functions

const StorageIndex & col () const
 
const StorageIndex & row () const
 
 Triplet ()
 
 Triplet (const StorageIndex &i, const StorageIndex &j, const Scalar &v=Scalar(0))
 
const Scalarvalue () const
 

Protected Attributes

StorageIndex m_col
 
StorageIndex m_row
 
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 162 of file SparseUtil.h.

Constructor & Destructor Documentation

◆ Triplet() [1/2]

template<typename Scalar, typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>
Eigen::Triplet< Scalar, StorageIndex >::Triplet ( )
inline

Definition at line 165 of file SparseUtil.h.

◆ 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

Definition at line 167 of file SparseUtil.h.

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

Definition at line 175 of file SparseUtil.h.

◆ 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

Definition at line 172 of file SparseUtil.h.

◆ 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

Definition at line 178 of file SparseUtil.h.

Member Data Documentation

◆ m_col

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

Definition at line 180 of file SparseUtil.h.

◆ m_row

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

Definition at line 180 of file SparseUtil.h.

◆ m_value

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

Definition at line 181 of file SparseUtil.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:44:19