WPILibC++ 2023.4.3
Public Member Functions | Protected Attributes | List of all members
Eigen::Triplet< Scalar, StorageIndex > Class Template Reference
SparseCore module

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/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

◆ 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

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

◆ 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

◆ 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

Member Data Documentation

◆ m_col

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

◆ m_row

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

◆ m_value

template<typename Scalar , typename StorageIndex = typename SparseMatrix<Scalar>::StorageIndex>
Scalar Eigen::Triplet< Scalar, StorageIndex >::m_value
protected
The documentation for this class was generated from the following file: