Main Content

matlab::data::SparseArray<T>

MATLAB スパース配列内のデータにアクセスするための、テンプレート化された C++ クラス

説明

SparseArray オブジェクトを使用して、スパース MATLAB® 配列を操作します。SparseArray を作成するには、ArrayFactory クラスの createSparseArray を呼び出します。

クラスの詳細

名前空間:

matlab::data

基底クラス:

matlab::data::Array

インクルード:

SparseArray.hpp

テンプレート パラメーター

T

参照先の要素の型。次のように指定します。

  • bool

  • double

  • std::complex<double>

コンストラクター

コピー コンストラクター

SparseArray(const SparseArray<T>& rhs)

SparseArray(const Array& rhs)

説明

SparseArray オブジェクトの共有データ コピーを作成します。

パラメーター

const SparseArray<T>& rhs

コピーする値。

const Array& rhs

ArrayType::SPARSE_LOGICAL、ArrayType::SPARSE_DOUBLE、または ArrayType::SPARSE_COMPLEX_DOUBLE の Array として指定される値。

スロー

matlab::data::InvalidArrayTypeException

入力 Array の型がスパースではありません。

代入演算子のコピー

SparseArray& operator=(const SparseArray<T>& rhs)

SparseArray& operator=(const Array& rhs)

説明

SparseArray オブジェクトに共有データ コピーを代入します。

パラメーター

const SparseArray<T>& rhs

コピーする値。

const Array& rhs

ArrayType::SPARSE_LOGICAL、ArrayType::SPARSE_DOUBLE、または ArrayType::SPARSE_COMPLEX_DOUBLE 型の Array として指定される値。

戻り値

SparseArray&

更新されたインスタンス。

スロー

matlab::data::InvalidArrayTypeException

入力 Array の型がスパースではありません。

移動コンストラクター

SparseArray(SparseArray&& rhs)

SparseArray(Array&& rhs)

説明

SparseArray オブジェクトの内容を新しいインスタンスに移動させます。

パラメーター

const SparseArray<T>& rhs

移動させる値。

const Array& rhs

ArrayType::SPARSE_LOGICAL、ArrayType::SPARSE_DOUBLE、または ArrayType::SPARSE_COMPLEX_DOUBLE 型の Array として指定される値。

スロー

matlab::data::InvalidArrayTypeException

入力 Array の型がスパースではありません。

移動代入演算子

SparseArray& operator=(SparseArray<T>&& rhs)

SparseArray& operator=(Array&& rhs)

説明

この SparseArray オブジェクトに入力を代入します。

パラメーター

const SparseArray<T>& rhs

移動させる値。

const Array& rhs

ArrayType::SPARSE_LOGICAL、ArrayType::SPARSE_DOUBLE、または ArrayType::SPARSE_COMPLEX_DOUBLE 型の Array として指定される値。

戻り値

SparseArray&

更新されたインスタンス。

スロー

matlab::data::InvalidArrayTypeException

入力 Array の型がスパースではありません。

反復子

開始反復子

iterator begin()

const_iterator begin() const

const_iterator cbegin() const

戻り値

iterator

配列の先頭の反復子。TypedIterator<T> として指定します。

const_iterator

反復子。TypedIterator<typename std::add_const<T>::type> として指定します。

スロー

なし

終了反復子

iterator end()

const_iterator end() const

const_iterator cend() const

戻り値

iterator

配列の終端の反復子。TypedIterator<T> として指定します。

const_iterator

反復子。TypedIterator<typename std::add_const<T>::type> として指定します。

スロー

なし

メンバー関数

getNumberOfNonZeroElements

size_t getNumberOfNonZeroElements() const
説明

配列内の非ゼロ要素の数を返します。

戻り値

size_t

配列内の非ゼロ要素の数。

スロー

なし

getIndex

SparseIndex getIndex(const TypedIterator<T>& it)
SparseIndex getIndex(const TypedIterator<T const>& it)
説明

反復子が指す非ゼロ エントリの行座標と列座標を返します。

パラメーター

const TypedIterator<T>& it

スパース行列内の現在のエントリを指す反復子。

const TypedIterator<T const>& it

戻り値

SparseIndex

反復子が指している非ゼロ エントリの行座標と列座標。SparseIndex は std::pair<size_t, size_t> として定義されます。

スロー

なし

バージョン履歴

R2017b で導入

参考

|