Spec-Zone.ru › Eigen3

Eigen::SparseVector

template<typename _Scalar, int _Options, typename _StorageIndex>
class Eigen::SparseVector< _Scalar, _Options, _StorageIndex >

класс разреженного вектора

Шаблонные параметры
_Scalar скалярный тип, т.е. тип коэффициентов

См. http://www.netlib.org/linalg/html_templates/node91.html для получения подробной информации о схеме хранения.

Этот класс может быть расширен с помощью механизма плагинов, описанного на странице Extending MatrixBase (and other classes) путем определения препроцессорного символа EIGEN_SPARSEVECTOR_PLUGIN.

Inheritance graph
Скаляр & coeffRef (Index i)
void conservativeResize (Index newSize)
Index nonZeros () const
void prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
void resize (Index newSize)
void resize (Index rows, Index cols)
Scalar sum () const
void swap (SparseVector &other)
~SparseVector ()
- Public Member Functions inherited from Eigen::SparseCompressedBase< SparseVector< _Scalar, _Options, _StorageIndex > >
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< SparseVector< _Scalar, _Options, _StorageIndex > >
Index cols () const
const internal::eval< SparseVector< _Scalar, _Options, _StorageIndex > >::type eval () const
Index innerSize () const
bool isVector () const
const Product< SparseVector< _Scalar, _Options, _StorageIndex >, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
Index outerSize () const
const SparseView< SparseVector< _Scalar, _Options, _StorageIndex > > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Index rows () const
Index size () const
SparseSymmetricPermutationProduct< SparseVector< _Scalar, _Options, _StorageIndex >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
- Public Member Functions inherited from Eigen::EigenBase< SparseVector< _Scalar, _Options, _StorageIndex > >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
SparseVector< _Scalar, _Options, _StorageIndex > & derived ()
const SparseVector< _Scalar, _Options, _StorageIndex > & derived () const
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
- Публичные типы, унаследованные от Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >
typedef internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::StorageIndex StorageIndex
typedef Scalar value_type
- Публичные типы, унаследованные от Eigen::EigenBase< SparseVector< _Scalar, _Options, _StorageIndex > >
typedef Eigen::Index Index
Тип интерфейса индексов. Подробнее...
- Защищенные функции-члены, унаследованные от Eigen::SparseCompressedBase< SparseVector< _Scalar, _Options, _StorageIndex > >
SparseCompressedBase ()

~SparseVector()

template<typename _Scalar , int _Options, typename _StorageIndex >
Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::~SparseVector ( )
inline

Деструктор

coeffRef()

template<typename _Scalar , int _Options, typename _StorageIndex >
Scalar& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::coeffRef ( Index i )
inline
Возвращает
ссылку на значение коэффициента с заданным индексом i Эта операция включает бинарный поиск log(rho*size). Если коэффициент еще не существует, то выполняется отсортированная вставка в последовательный буфер.

Эта вставка может быть очень дорогостоящей, если число ненулевых элементов выше i велико.

conservativeResize()

template<typename _Scalar , int _Options, typename _StorageIndex >
void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::conservativeResize ( Index newSize )
inline

Изменяет размер разреженного вектора до newSize, оставляя старые значения без изменений.

Если размер вектора уменьшается, то хранилище коэффициентов вне границ сохраняется и резервируется. Вызовите .data().squeeze(), чтобы освободить лишнюю память.

См. также
reserve(), setZero()

nonZeros()

template<typename _Scalar , int _Options, typename _StorageIndex >
Index Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::nonZeros ( ) const
inline
Возвращает
число ненулевых коэффициентов

prune()

template<typename _Scalar , int _Options, typename _StorageIndex >
void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::prune ( const Scalar & reference,
const RealScalar & epsilon = NumTraits<RealScalar>::dummy_precision()
)
inline

Подавляет все ненулевые значения, которые намного меньше reference в пределах допуска epsilon

resize() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >
void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::resize ( Index newSize )
inline

Изменяет размер разреженного вектора до newSize Этот метод удаляет все записи, оставляя пустой разреженный вектор

См. также
conservativeResize(), setZero()

resize() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >
void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::resize ( Index rows,
Index cols
)
inline

Изменяет размер разреженного вектора до rows x cols

Этот метод предоставляется для совместимости с матрицами. Для вектора-столбца cols должно быть равно 1. Для вектора-строки rows должно быть равно 1.

См. также
resize(Index)

sum()

template<typename _Scalar , int _Options, typename _Index >
internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar Eigen::SparseVector< _Scalar, _Options, _Index >::sum

Перегружено для повышения производительности

swap()

template<typename _Scalar , int _Options, typename _StorageIndex >
void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::swap ( SparseVector< _Scalar, _Options, _StorageIndex > & other )
inline

Обменивает значения *this и other. Перегружено для повышения производительности: эта версия выполняет поверхностный обмен, обменивая только указатели и атрибуты.

См. также
SparseMatrixBase::swap()

Документация для этого класса была сгенерирована из следующих файлов:
  • SparseUtil.h
  • SparseVector.h
  • SparseRedux.h

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1SparseVector.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API