MOAB  4.9.3pre
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Member Functions
Eigen::SparseCompressedBase< Derived > Class Template Reference

Common base class for sparse [compressed]-{row|column}-storage format. More...

#include <SparseCompressedBase.h>

Inheritance diagram for Eigen::SparseCompressedBase< Derived >:
Inheritance graph
[legend]
Collaboration diagram for Eigen::SparseCompressedBase< Derived >:
Collaboration graph
[legend]

List of all members.

Classes

class  InnerIterator
class  ReverseInnerIterator

Public Types

typedef SparseMatrixBase< Derived > Base

Public Member Functions

Index nonZeros () const
const Scalar * valuePtr () const
Scalar * valuePtr ()
const StorageIndex * innerIndexPtr () const
StorageIndex * innerIndexPtr ()
const StorageIndex * outerIndexPtr () const
StorageIndex * outerIndexPtr ()
const StorageIndex * innerNonZeroPtr () const
StorageIndex * innerNonZeroPtr ()
bool isCompressed () const

Protected Types

typedef Base::IndexVector IndexVector

Protected Member Functions

Eigen::Map< IndexVector > innerNonZeros ()
const Eigen::Map< const
IndexVector > 		innerNonZeros () const
 SparseCompressedBase ()

Private Member Functions

template<typename OtherDerived >
 SparseCompressedBase (const SparseCompressedBase< OtherDerived > &)

Detailed Description

template<typename Derived>
class Eigen::SparseCompressedBase< Derived >

Common base class for sparse [compressed]-{row|column}-storage format.

This class defines the common interface for all derived classes implementing the compressed sparse storage format, such as:

  • SparseMatrix
  • Ref<SparseMatrixType,Options>
  • Map<SparseMatrixType>

Definition at line 36 of file SparseCompressedBase.h.

Member Typedef Documentation

template<typename Derived>
typedef SparseMatrixBase<Derived> Eigen::SparseCompressedBase< Derived >::Base

Reimplemented from Eigen::SparseMatrixBase< Derived >.

Reimplemented in Eigen::BlockImpl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true, Sparse >, Eigen::BlockImpl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true, Sparse >, Eigen::SparseMapBase< Derived, WriteAccessors >, Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 40 of file SparseCompressedBase.h.

template<typename Derived>
typedef Base::IndexVector Eigen::SparseCompressedBase< Derived >::IndexVector [protected]

Reimplemented from Eigen::SparseMatrixBase< Derived >.

Reimplemented in Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, and Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >.

Definition at line 46 of file SparseCompressedBase.h.

Constructor & Destructor Documentation

template<typename Derived>
Eigen::SparseCompressedBase< Derived >::SparseCompressedBase ( ) [inline, protected]

Default constructor. Do nothing.

Definition at line 111 of file SparseCompressedBase.h.

{}
template<typename Derived>
template<typename OtherDerived >
Eigen::SparseCompressedBase< Derived >::SparseCompressedBase ( const SparseCompressedBase< OtherDerived > &  ) [explicit, private]

Member Function Documentation

template<typename Derived>
const StorageIndex* Eigen::SparseCompressedBase< Derived >::innerIndexPtr ( ) const [inline]
Returns:
a const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.
See also:
valuePtr(), outerIndexPtr()

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 80 of file SparseCompressedBase.h.

{ return derived().innerIndexPtr(); }
template<typename Derived>
StorageIndex* Eigen::SparseCompressedBase< Derived >::innerIndexPtr ( ) [inline]
Returns:
a non-const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.
See also:
valuePtr(), outerIndexPtr()

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMapBase< Derived, WriteAccessors >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 84 of file SparseCompressedBase.h.

{ return derived().innerIndexPtr(); }
template<typename Derived>
const StorageIndex* Eigen::SparseCompressedBase< Derived >::innerNonZeroPtr ( ) const [inline]
Returns:
a const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.
Warning:
it returns the null pointer 0 in compressed mode

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 100 of file SparseCompressedBase.h.

{ return derived().innerNonZeroPtr(); }
template<typename Derived>
StorageIndex* Eigen::SparseCompressedBase< Derived >::innerNonZeroPtr ( ) [inline]
Returns:
a non-const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.
Warning:
it returns the null pointer 0 in compressed mode

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseMapBase< Derived, WriteAccessors >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 104 of file SparseCompressedBase.h.

{ return derived().innerNonZeroPtr(); }
template<typename Derived>
Eigen::Map<IndexVector> Eigen::SparseCompressedBase< Derived >::innerNonZeros ( ) [inline, protected]

Definition at line 50 of file SparseCompressedBase.h.

{ return Eigen::Map<IndexVector>(innerNonZeroPtr(), isCompressed()?0:derived().outerSize()); }
template<typename Derived>
const Eigen::Map<const IndexVector> Eigen::SparseCompressedBase< Derived >::innerNonZeros ( ) const [inline, protected]

Definition at line 51 of file SparseCompressedBase.h.

{ return Eigen::Map<const IndexVector>(innerNonZeroPtr(), isCompressed()?0:derived().outerSize()); }
template<typename Derived>
bool Eigen::SparseCompressedBase< Derived >::isCompressed ( ) const [inline]
Returns:
whether *this is in compressed form.

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, and Eigen::SparseMapBase< Derived, ReadOnlyAccessors >.

Definition at line 107 of file SparseCompressedBase.h.

{ return innerNonZeroPtr()==0; }
template<typename Derived>
Index Eigen::SparseCompressedBase< Derived >::nonZeros ( ) const [inline]
Returns:
the number of non zero coefficients

Reimplemented in Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 56 of file SparseCompressedBase.h.

    {
      if(Derived::IsVectorAtCompileTime && outerIndexPtr()==0)
        return derived().nonZeros();
      else if(isCompressed())
        return outerIndexPtr()[derived().outerSize()]-outerIndexPtr()[0];
      else if(derived().outerSize()==0)
        return 0;
      else
        return innerNonZeros().sum();
    }
template<typename Derived>
const StorageIndex* Eigen::SparseCompressedBase< Derived >::outerIndexPtr ( ) const [inline]
Returns:
a const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.
Warning:
it returns the null pointer 0 for SparseVector
See also:
valuePtr(), innerIndexPtr()

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 90 of file SparseCompressedBase.h.

{ return derived().outerIndexPtr(); }
template<typename Derived>
StorageIndex* Eigen::SparseCompressedBase< Derived >::outerIndexPtr ( ) [inline]
Returns:
a non-const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.
Warning:
it returns the null pointer 0 for SparseVector
See also:
valuePtr(), innerIndexPtr()

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMapBase< Derived, WriteAccessors >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 95 of file SparseCompressedBase.h.

{ return derived().outerIndexPtr(); }
template<typename Derived>
const Scalar* Eigen::SparseCompressedBase< Derived >::valuePtr ( ) const [inline]
Returns:
a const pointer to the array of values. This function is aimed at interoperability with other libraries.
See also:
innerIndexPtr(), outerIndexPtr()

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 71 of file SparseCompressedBase.h.

{ return derived().valuePtr(); }
template<typename Derived>
Scalar* Eigen::SparseCompressedBase< Derived >::valuePtr ( ) [inline]
Returns:
a non-const pointer to the array of values. This function is aimed at interoperability with other libraries.
See also:
innerIndexPtr(), outerIndexPtr()

Reimplemented in Eigen::internal::sparse_matrix_block_impl< SparseMatrixType, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::internal::sparse_matrix_block_impl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols >, Eigen::SparseMapBase< Derived, WriteAccessors >, Eigen::SparseMatrix< _Scalar, _Options, _Index >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, and Eigen::internal::SparseTransposeImpl< MatrixType, CompressedAccessBit >.

Definition at line 75 of file SparseCompressedBase.h.

{ return derived().valuePtr(); }
The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines