W3cubDocs
/Eigen3Eigen::Map
template<typename SparseMatrixType>
class Eigen::Map< SparseMatrixType >
Specialization of class Map for SparseMatrix-like storage.
- Template Parameters
-
SparseMatrixType the equivalent sparse matrix type of the referenced data, it must be a template instance of class SparseMatrix.
- See also
- class Map, class SparseMatrix, class Ref<SparseMatrixType,Options>
| Map (Index rows, Index cols, Index nnz, const StorageIndex *outerIndexPtr, const StorageIndex *innerIndexPtr, const Scalar *valuePtr, const StorageIndex *innerNonZerosPtr=0) | |
| Map (Index rows, Index cols, Index nnz, StorageIndex *outerIndexPtr, StorageIndex *innerIndexPtr, Scalar *valuePtr, StorageIndex *innerNonZerosPtr=0) | |
| ~Map () | |
 Public Member Functions inherited from Eigen::SparseMapBase< Derived, WriteAccessors >
| |
| Scalar & | coeffRef (Index row, Index col) |
| StorageIndex * | innerIndexPtr () |
| StorageIndex * | innerNonZeroPtr () |
| StorageIndex * | outerIndexPtr () |
| Scalar * | valuePtr () |
| ~SparseMapBase () | |
|
Public Member Functions inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >
| |
| Scalar | coeff (Index row, Index col) const |
| Index | cols () const |
| const StorageIndex * | innerIndexPtr () const |
| const StorageIndex * | innerNonZeroPtr () const |
| Index | innerSize () const |
| bool | isCompressed () const |
| Index | nonZeros () const |
| const StorageIndex * | outerIndexPtr () const |
| Index | outerSize () const |
| Index | rows () const |
| const Scalar * | valuePtr () const |
| ~SparseMapBase () | |
|
Public Member Functions inherited from Eigen::SparseCompressedBase< Derived >
| |
| Map< Array< Scalar, Dynamic, 1 > > | coeffs () |
| const Map< const Array< Scalar, Dynamic, 1 > > | coeffs () const |
| StorageIndex * | innerIndexPtr () |
| const StorageIndex * | innerIndexPtr () const |
| StorageIndex * | innerNonZeroPtr () |
| const StorageIndex * | innerNonZeroPtr () const |
| bool | isCompressed () const |
| Index | nonZeros () const |
| StorageIndex * | outerIndexPtr () |
| const StorageIndex * | outerIndexPtr () const |
| Scalar * | valuePtr () |
| const Scalar * | valuePtr () const |
|
Public Member Functions inherited from Eigen::SparseMatrixBase< Derived >
| |
| Index | cols () const |
| const internal::eval< Derived >::type | eval () const |
| Index | innerSize () const |
| bool | isVector () const |
| template<typename OtherDerived > | |
| const Product< Derived, OtherDerived, AliasFreeProduct > | operator* (const SparseMatrixBase< OtherDerived > &other) const |
| Index | outerSize () const |
| const SparseView< Derived > | pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const |
| Index | rows () const |
| Index | size () const |
| SparseSymmetricPermutationProduct< Derived, Upper|Lower > | twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const |
|
Public Member Functions inherited from Eigen::EigenBase< Derived >
| |
| EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
| Derived & | derived () |
| const Derived & | derived () const |
| EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
| EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
|
Public Types inherited from Eigen::SparseMatrixBase< Derived >
| |
| enum | { RowsAtCompileTime , ColsAtCompileTime , SizeAtCompileTime , MaxRowsAtCompileTime , MaxColsAtCompileTime , MaxSizeAtCompileTime , IsVectorAtCompileTime , NumDimensions , Flags , IsRowMajor , InnerSizeAtCompileTime } |
| typedef internal::traits< Derived >::StorageIndex | StorageIndex |
| typedef Scalar | value_type |
|
Public Types inherited from Eigen::EigenBase< Derived >
| |
| typedef Eigen::Index | Index |
| The interface type of indices. More... |
|
|
Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
| |
| SparseCompressedBase () | |
Map() [1/2]
template<typename SparseMatrixType >
| inline |
Constructs a read-write Map to a sparse matrix of size rows x cols, containing nnz non-zero coefficients, stored as a sparse format as defined by the pointers outerIndexPtr, innerIndexPtr, and valuePtr. If the optional parameter innerNonZerosPtr is the null pointer, then a standard compressed format is assumed.
This constructor is available only if SparseMatrixType is non-const.
More details on the expected storage schemes are given in the manual pages.
Map() [2/2]
template<typename SparseMatrixType >
| inline |
This is the const version of the above constructor.
This constructor is available only if SparseMatrixType is const, e.g.:
Map<const SparseMatrix<double> >
~Map()
template<typename SparseMatrixType >
| inline |
Empty destructor
The documentation for this class was generated from the following file:
© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1Map_3_01SparseMatrixType_01_4.html