Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex > Class Template Reference

#include <SparseCompressedBase.h>

Public Types

using iterator_category = std::random_access_iterator_tag
 
using reference = StorageRef< Scalar, StorageIndex >
 
using difference_type = Index
 
using value_type = typename reference::value_type
 
using pointer = value_type *
 

Public Member Functions

 CompressedStorageIterator ()=delete
 
 CompressedStorageIterator (difference_type index, StorageIndex *innerIndexPtr, Scalar *valuePtr)
 
 CompressedStorageIterator (difference_type index, reference data)
 
 CompressedStorageIterator (const CompressedStorageIterator &other)
 
 CompressedStorageIterator (CompressedStorageIterator &&other)=default
 
CompressedStorageIterator & operator= (const CompressedStorageIterator &other)
 
CompressedStorageIterator operator+ (difference_type offset) const
 
CompressedStorageIterator operator- (difference_type offset) const
 
difference_type operator- (const CompressedStorageIterator &other) const
 
CompressedStorageIterator & operator++ ()
 
CompressedStorageIterator & operator-- ()
 
CompressedStorageIterator & operator+= (difference_type offset)
 
CompressedStorageIterator & operator-= (difference_type offset)
 
reference operator* () const
 

Protected Attributes

difference_type m_index
 
reference m_data
 

Member Typedef Documentation

◆ difference_type

template<typename Scalar , typename StorageIndex >
using Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::difference_type = Index

◆ iterator_category

template<typename Scalar , typename StorageIndex >
using Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::iterator_category = std::random_access_iterator_tag

◆ pointer

template<typename Scalar , typename StorageIndex >
using Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::pointer = value_type*

◆ reference

template<typename Scalar , typename StorageIndex >
using Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::reference = StorageRef<Scalar, StorageIndex>

◆ value_type

template<typename Scalar , typename StorageIndex >
using Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::value_type = typename reference::value_type

Constructor & Destructor Documentation

◆ CompressedStorageIterator() [1/5]

template<typename Scalar , typename StorageIndex >
Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::CompressedStorageIterator ( )
delete

Referenced by Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator+(), and Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator-().

◆ CompressedStorageIterator() [2/5]

template<typename Scalar , typename StorageIndex >
Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::CompressedStorageIterator ( difference_type  index,
StorageIndex *  innerIndexPtr,
Scalar *  valuePtr 
)
inline
449  : m_index(index), m_data(innerIndexPtr, valuePtr) {}
Eigen::internal::CompressedStorageIterator::m_data
reference m_data
Definition: SparseCompressedBase.h:496
Eigen::internal::CompressedStorageIterator::m_index
difference_type m_index
Definition: SparseCompressedBase.h:495

◆ CompressedStorageIterator() [3/5]

template<typename Scalar , typename StorageIndex >
Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::CompressedStorageIterator ( difference_type  index,
reference  data 
)
inline
450 : m_index(index), m_data(data) {}
data
int data[]
Definition: Map_placement_new.cpp:1

◆ CompressedStorageIterator() [4/5]

template<typename Scalar , typename StorageIndex >
Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::CompressedStorageIterator ( const CompressedStorageIterator< Scalar, StorageIndex > &  other)
inline
451 : m_index(other.m_index), m_data(other.m_data) {}

◆ CompressedStorageIterator() [5/5]

template<typename Scalar , typename StorageIndex >
Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::CompressedStorageIterator ( CompressedStorageIterator< Scalar, StorageIndex > &&  other)
default

Member Function Documentation

◆ operator*()

template<typename Scalar , typename StorageIndex >
reference Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator* ( ) const
inline
482 { return reference(m_data.keyPtr() + m_index, m_data.valuePtr() + m_index); }
Eigen::internal::CompressedStorageIterator::reference
StorageRef< Scalar, StorageIndex > reference
Definition: SparseCompressedBase.h:442

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_data, and Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator+()

template<typename Scalar , typename StorageIndex >
CompressedStorageIterator Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator+ ( difference_type  offset) const
inline
459  {
460  return CompressedStorageIterator(m_index + offset, m_data);
461  }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::CompressedStorageIterator(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_data, and Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator++()

template<typename Scalar , typename StorageIndex >
CompressedStorageIterator& Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator++ ( )
inline
466  {
467  ++m_index;
468  return *this;
469  }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator+=()

template<typename Scalar , typename StorageIndex >
CompressedStorageIterator& Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator+= ( difference_type  offset)
inline
474  {
475  m_index += offset;
476  return *this;
477  }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator-() [1/2]

template<typename Scalar , typename StorageIndex >
difference_type Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator- ( const CompressedStorageIterator< Scalar, StorageIndex > &  other) const
inline
465 { return m_index - other.m_index; }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator-() [2/2]

template<typename Scalar , typename StorageIndex >
CompressedStorageIterator Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator- ( difference_type  offset) const
inline
462  {
463  return CompressedStorageIterator(m_index - offset, m_data);
464  }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::CompressedStorageIterator(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_data, and Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator--()

template<typename Scalar , typename StorageIndex >
CompressedStorageIterator& Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator-- ( )
inline
470  {
471  --m_index;
472  return *this;
473  }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator-=()

template<typename Scalar , typename StorageIndex >
CompressedStorageIterator& Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator-= ( difference_type  offset)
inline
478  {
479  m_index -= offset;
480  return *this;
481  }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

◆ operator=()

template<typename Scalar , typename StorageIndex >
CompressedStorageIterator& Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator= ( const CompressedStorageIterator< Scalar, StorageIndex > &  other)
inline
453  {
454  m_index = other.m_index;
455  m_data = other.m_data;
456  return *this;
457  }

References Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_data, and Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index.

Member Data Documentation

◆ m_data

template<typename Scalar , typename StorageIndex >
reference Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_data
protected

Referenced by Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator*(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator+(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator-(), and Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator=().

◆ m_index

template<typename Scalar , typename StorageIndex >
difference_type Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::m_index
protected

Referenced by Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator*(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator+(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator++(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator+=(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator-(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator--(), Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator-=(), and Eigen::internal::CompressedStorageIterator< Scalar, StorageIndex >::operator=().

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