cv::SparseMat クラス

SparseMat クラスは多次元のスパース数値配列を表す。 詳細...

#include <opencv2/core/mat.hpp>

Collaboration diagram for cv::SparseMat:

クラス
struct	Hdr
	疎行列ヘッダ 続きを読む...
struct	Node
	疎行列ノード - ハッシュテーブルの要素 続きを読む...

公開型
enum	{   MAGIC_VAL =0x42FD0000 ,   MAX_DIM =32 ,   HASH_SCALE =0x5bd1e995 ,   HASH_BIT =0x80000000 }
typedef SparseMatConstIterator	const_iterator
typedef SparseMatIterator	iterator

公開メンバ関数
	SparseMat ()
	さまざまな SparseMat コンストラクタ。
	SparseMat (const Mat &m)
	SparseMat (const SparseMat &m)
	SparseMat (int dims, const int *_sizes, int _type)
	~SparseMat ()
	デストラクタ
void	addref ()
	ヘッダの参照カウンタを手動でインクリメントする。
void	assignTo (SparseMat &m, int type=-1) const
int	channels () const
	チャンネル数を返す
void	clear ()
	疎行列のすべての要素を0に設定する。すなわちハッシュテーブルをクリアする。
CV_NODISCARD_STD SparseMat	clone () const
	行列の完全なコピーを作成する
void	convertTo (Mat &m, int rtype, double alpha=1, double beta=0) const
	疎行列を密なn次元行列に変換する。型変換とスケーリングは省略可能。
void	convertTo (SparseMat &m, int rtype, double alpha=1) const
	行列のすべての要素を指定したスケール係数 alpha で乗算し、結果を指定したデータ型に変換する
void	copyTo (Mat &m) const
	疎行列を密行列に変換する。
void	copyTo (SparseMat &m) const
	すべてのデータをコピー先の行列にコピーする。m の以前の内容はすべて消去される
void	create (int dims, const int *_sizes, int _type)
	疎行列を再割り当てする。
int	depth () const
	疎行列要素のビット深度を返す
int	dims () const
	行列の次元数を返す
size_t	elemSize () const
	疎行列を旧スタイルの表現に変換する。すべての要素がコピーされる。
size_t	elemSize1 () const
	elemSize()/channels() を返す
SparseMatIterator	end ()
	行列の末尾を指す疎行列イテレータを返す
template<typename _Tp >
SparseMatIterator_< _Tp >	end ()
	行列の末尾を指す型付き疎行列イテレータを返す
SparseMatConstIterator	end () const
	行列の末尾を指す読み取り専用の疎行列イテレータを返す
template<typename _Tp >
SparseMatConstIterator_< _Tp >	end () const
	行列の末尾を指す型付き読み取り専用の疎行列イテレータを返す
void	erase (const int *idx, size_t *hashval=0)
	指定した要素を消去する（nDの場合）
void	erase (int i0, int i1, int i2, size_t *hashval=0)
	指定した要素を消去する（3Dの場合）
void	erase (int i0, int i1, size_t *hashval=0)
	指定した要素を消去する（2Dの場合）
size_t	hash (const int *idx) const
	要素のハッシュ値を計算する（nDの場合）
size_t	hash (int i0) const
	要素のハッシュ値を計算する（1Dの場合）
size_t	hash (int i0, int i1) const
	要素のハッシュ値を計算する（2Dの場合）
size_t	hash (int i0, int i1, int i2) const
	要素のハッシュ値を計算する（3Dの場合）
uchar *	newNode (const int *idx, size_t hashval)
Node *	node (size_t nidx)
const Node *	node (size_t nidx) const
size_t	nzcount () const
	非ゼロ要素の数（=ハッシュテーブルのノード数）を返す
SparseMat &	operator= (const Mat &m)
	対応するコンストラクタと等価
SparseMat &	operator= (const SparseMat &m)
	代入演算子。これは O(1) の操作であり、データはコピーされない
void	release ()
void	removeNode (size_t hidx, size_t nidx, size_t previdx)
void	resizeHashTab (size_t newsize)
const int *	size () const
	サイズの配列を返す。行列が割り当てられていない場合は NULL を返す
int	size (int i) const
	i番目の行列次元のサイズ（または0）を返す
int	type () const
	疎行列要素の型を返す
template<typename _Tp >
const _Tp &	value (const Node *n) const
	疎行列ノードに格納された値を返す
template<typename _Tp >
_Tp &	value (Node *n)
	疎行列ノードに格納された値を返す
uchar *	ptr (int i0, bool createMissing, size_t *hashval=0)
	指定した要素へのポインタを返す（1Dの場合）
uchar *	ptr (int i0, int i1, bool createMissing, size_t *hashval=0)
	指定した要素へのポインタを返す（2Dの場合）
uchar *	ptr (int i0, int i1, int i2, bool createMissing, size_t *hashval=0)
	指定した要素へのポインタを返す（3Dの場合）
uchar *	ptr (const int *idx, bool createMissing, size_t *hashval=0)
	指定した要素へのポインタを返す（nDの場合）
template<typename _Tp >
_Tp &	ref (int i0, size_t *hashval=0)
	指定した要素への参照を返す（1Dの場合）
template<typename _Tp >
_Tp &	ref (int i0, int i1, size_t *hashval=0)
	指定した要素への参照を返す（2Dの場合）
template<typename _Tp >
_Tp &	ref (int i0, int i1, int i2, size_t *hashval=0)
	指定した要素への参照を返す（3Dの場合）
template<typename _Tp >
_Tp &	ref (const int *idx, size_t *hashval=0)
	指定した要素への参照を返す（nDの場合）
template<typename _Tp >
_Tp	value (int i0, size_t *hashval=0) const
	指定した要素の値を返す（1Dの場合）
template<typename _Tp >
_Tp	value (int i0, int i1, size_t *hashval=0) const
	指定した要素の値を返す（2Dの場合）
template<typename _Tp >
_Tp	value (int i0, int i1, int i2, size_t *hashval=0) const
	指定した要素の値を返す（3Dの場合）
template<typename _Tp >
_Tp	value (const int *idx, size_t *hashval=0) const
	指定した要素の値を返す（nDの場合）
template<typename _Tp >
const _Tp *	find (int i0, size_t *hashval=0) const
	指定した要素へのポインタを返す（1Dの場合）
template<typename _Tp >
const _Tp *	find (int i0, int i1, size_t *hashval=0) const
	指定した要素へのポインタを返す（2Dの場合）
template<typename _Tp >
const _Tp *	find (int i0, int i1, int i2, size_t *hashval=0) const
	指定した要素へのポインタを返す（3Dの場合）
template<typename _Tp >
const _Tp *	find (const int *idx, size_t *hashval=0) const
	指定した要素へのポインタを返す（nDの場合）
SparseMatIterator	begin ()
	行列の先頭を指す疎行列イテレータを返す
template<typename _Tp >
SparseMatIterator_< _Tp >	begin ()
	行列の先頭を指す疎行列イテレータを返す
SparseMatConstIterator	begin () const
	行列の先頭を指す読み取り専用の疎行列イテレータを返す
template<typename _Tp >
SparseMatConstIterator_< _Tp >	begin () const
	行列の先頭を指す読み取り専用の疎行列イテレータを返す

公開変数類
int	flags
Hdr *	hdr

詳細説明

SparseMat クラスは多次元のスパース数値配列を表す。

このようなスパース配列は、Mat が格納できる任意の型の要素を格納できる。スパース とは、非ゼロ要素のみが格納されることを意味する（ただし、スパース行列に対する演算の結果として、格納された要素の一部が実際には 0 になることがある。そのような要素を検出し、SparseMat::erase を使って削除するのは利用者の責任である）。非ゼロ要素は、満杯になると拡張されるハッシュテーブルに格納されるため、平均的な検索時間は O(1) である（要素が存在するかどうかにかかわらず）。要素には次のメソッドを使ってアクセスできる:

• クエリ操作（SparseMat::ptr と、より高レベルな SparseMat::ref、SparseMat::value、SparseMat::find）。例えば次のとおり:

  const int dims = 5;
  int size[5] = {10, 10, 10, 10, 10};
  SparseMat sparse_mat(dims, size, CV_32F);
  for(int i = 0; i < 1000; i++)
  {
   int idx[dims];
   for(int k = 0; k < dims; k++)
   idx[k] = rand() % size[k];
   sparse_mat.ref<float>(idx) += 1.f;
  }
  cout << "nnz = " << sparse_mat.nzcount() << endl;

• スパース行列のイテレータ。MatIterator に似ているが、NAryMatIterator とは異なる。つまり、反復ループは STL ユーザにとってなじみのある形である:

  // prints elements of a sparse floating-point matrix
  // and the sum of elements.
  SparseMatConstIterator_<float>
   it = sparse_mat.begin<float>(),
   it_end = sparse_mat.end<float>();
  double s = 0;
  int dims = sparse_mat.dims();
  for(; it != it_end; ++it)
  {
   // print element indices and the element value
   const SparseMat::Node* n = it.node();
   printf("(");
   for(int i = 0; i < dims; i++)
   printf("%d%s", n->idx[i], i < dims-1 ? ", " : ")");
   printf(": %g\n", it.value<float>());
   s += *it;
  }
  printf("Element sum is %g\n", s);

  このループを実行すると、要素が論理的な順序（辞書順など）で列挙されないことに気づくだろう。要素はハッシュテーブルに格納されている順序（ほぼランダム）で現れる。ノードへのポインタを集めてソートすれば、適切な順序を得られる。ただし、行列にさらに要素を追加すると、ノードへのポインタが無効になる場合があることに注意。これはバッファの再確保が起こり得るためである。
• 2 つ以上のスパース行列を同時に処理する必要がある場合の、上記 2 つのメソッドを組み合わせた手法。例えば、2 つの浮動小数点スパース行列の正規化していない相互相関を計算する方法は次のとおり:

  double cross_corr(const SparseMat& a, const SparseMat& b)
  {
   const SparseMat *_a = &a, *_b = &b;
   // if b contains less elements than a,
   // it is faster to iterate through b
   if(_a->nzcount() > _b->nzcount())
   std::swap(_a, _b);
   SparseMatConstIterator_<float> it = _a->begin<float>(),
   it_end = _a->end<float>();
   double ccorr = 0;
   for(; it != it_end; ++it)
   {
   // take the next element from the first matrix
   float avalue = *it;
   const Node* anode = it.node();
   // and try to find an element with the same index in the second matrix.
   // since the hash value depends only on the element index,
   // reuse the hash value stored in the node
   float bvalue = _b->value<float>(anode->idx,&anode->hashval);
   ccorr += avalue*bvalue;
   }
   return ccorr;
  }

型定義メンバ詳解

const_iterator

SparseMatConstIterator cv::SparseMat::const_iterator

iterator

SparseMatIterator cv::SparseMat::iterator

列挙型メンバ詳解

anonymous enum

anonymous enum

列挙値
MAGIC_VAL
MAX_DIM
HASH_SCALE
HASH_BIT

構築子と解体子の詳解

SparseMat() [1/4]

cv::SparseMat::SparseMat

(

)

各種の SparseMat コンストラクタ。

SparseMat() [2/4]

cv::SparseMat::SparseMat	(	int	dims,
		const int *	_sizes,
		int	_type )

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

dims	配列の次元数。
_sizes	全次元におけるスパース行列のサイズ。
_type	スパース行列のデータ型。

SparseMat() [3/4]

cv::SparseMat::SparseMat

(

const SparseMat &

m

)

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

m	コピーコンストラクタ用のソース行列。m が密行列 (ocvMat) の場合は、スパース表現に変換される。

SparseMat() [4/4]

cv::SparseMat::SparseMat ( const Mat & m )

explicit

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

m	コピーコンストラクタ用のソース行列。m が密行列 (ocvMat) の場合は、スパース表現に変換される。

~SparseMat()

cv::SparseMat::~SparseMat

(

)

デストラクタ

メンバ関数詳解

addref()

void cv::SparseMat::addref

(

)

ヘッダの参照カウンタを手動でインクリメントする。

assignTo()

void cv::SparseMat::assignTo	(	SparseMat &	m,
		int	type = -1 ) const

begin() [1/4]

SparseMatIterator cv::SparseMat::begin

(

)

行列の先頭を指すスパース行列イテレータを返す

最初のスパース行列要素を指すスパース行列イテレータを返す

begin() [2/4]

template<typename _Tp >

SparseMatIterator_< _Tp > cv::SparseMat::begin

(

)

行列の先頭を指すスパース行列イテレータを返す

begin() [3/4]

SparseMatConstIterator cv::SparseMat::begin

(

)

const

行列の先頭を指す読み取り専用スパース行列イテレータを返す

begin() [4/4]

template<typename _Tp >

SparseMatConstIterator_< _Tp > cv::SparseMat::begin

(

)

const

行列の先頭を指す読み取り専用スパース行列イテレータを返す

channels()

int cv::SparseMat::channels

(

)

const

チャンネル数を返す

clear()

void cv::SparseMat::clear

(

)

スパース行列の全要素を 0 に設定する。これはハッシュテーブルをクリアすることを意味する。

clone()

CV_NODISCARD_STD SparseMat cv::SparseMat::clone

(

)

const

行列の完全なコピーを作成する

convertTo() [1/2]

void cv::SparseMat::convertTo	(	Mat &	m,
		int	rtype,
		double	alpha = 1,
		double	beta = 0 ) const

スパース行列を密な n 次元行列に変換する。型変換とスケーリングは省略可能。

引数

[out]	m	- 出力行列。処理前に適切なサイズや型を持っていない場合は、再確保される
[in]	rtype	- 希望する出力行列の型、より正確にはビット深度（チャンネル数は入力と同じため）。rtype が負の場合、出力行列は入力と同じ型になる。
[in]	alpha	- 省略可能なスケール係数
[in]	beta	- スケーリング後の値に加算される省略可能なデルタ

convertTo() [2/2]

void cv::SparseMat::convertTo	(	SparseMat &	m,
		int	rtype,
		double	alpha = 1 ) const

行列の全要素を指定したスケール係数 alpha で乗算し、結果を指定したデータ型に変換する

copyTo() [1/2]

void cv::SparseMat::copyTo

(

Mat &

m

)

const

スパース行列を密行列に変換する。

copyTo() [2/2]

void cv::SparseMat::copyTo

(

SparseMat &

m

)

const

全データを変換先の行列にコピーする。m の以前の内容はすべて消去される

create()

void cv::SparseMat::create	(	int	dims,
		const int *	_sizes,
		int	_type )

スパース行列を再確保する。

行列がすでに適切なサイズと型を持っている場合は、単に clear() でクリアされる。そうでなければ、古い行列は（release() を使って）解放され、新しい行列が確保される。

depth()

int cv::SparseMat::depth

(

)

const

スパース行列要素のビット深度を返す

dims()

int cv::SparseMat::dims

(

)

const

行列の次元数を返す

elemSize()

size_t cv::SparseMat::elemSize

(

)

const

スパース行列を旧形式の表現に変換する。すべての要素がコピーされる。

各要素のバイト単位のサイズを返す（オーバーヘッド、すなわち SparseMat::Node 要素が占める領域は含まない）

elemSize1()

size_t cv::SparseMat::elemSize1

(

)

const

elemSize()/channels() を返す

end() [1/4]

SparseMatIterator cv::SparseMat::end

(

)

行列の末尾を指すスパース行列イテレータを返す

最後のスパース行列要素の次を指すスパース行列イテレータを返す

end() [2/4]

template<typename _Tp >

SparseMatIterator_< _Tp > cv::SparseMat::end

(

)

行列の末尾を指す型付きスパース行列イテレータを返す

end() [3/4]

SparseMatConstIterator cv::SparseMat::end

(

)

const

行列の末尾を指す読み取り専用スパース行列イテレータを返す

end() [4/4]

template<typename _Tp >

SparseMatConstIterator_< _Tp > cv::SparseMat::end

(

)

const

行列の末尾を指す型付きの読み取り専用スパース行列イテレータを返す

erase() [1/3]

void cv::SparseMat::erase	(	const int *	idx,
		size_t *	hashval = 0 )

指定した要素を消去する（nD の場合）

erase() [2/3]

void cv::SparseMat::erase	(	int	i0,
		int	i1,
		int	i2,
		size_t *	hashval = 0 )

指定した要素を消去する（3D の場合）

erase() [3/3]

void cv::SparseMat::erase	(	int	i0,
		int	i1,
		size_t *	hashval = 0 )

指定した要素を消去する（2D の場合）

find() [1/4]

template<typename _Tp >

const _Tp * cv::SparseMat::find	(	const int *	idx,
		size_t *	hashval = 0 ) const

指定した要素へのポインタを返す（nD の場合）

find() [2/4]

template<typename _Tp >

const _Tp * cv::SparseMat::find	(	int	i0,
		int	i1,
		int	i2,
		size_t *	hashval = 0 ) const

指定した要素へのポインタを返す（3D の場合）

find() [3/4]

template<typename _Tp >

const _Tp * cv::SparseMat::find	(	int	i0,
		int	i1,
		size_t *	hashval = 0 ) const

指定した要素へのポインタを返す（2D の場合）

find() [4/4]

template<typename _Tp >

const _Tp * cv::SparseMat::find	(	int	i0,
		size_t *	hashval = 0 ) const

指定した要素へのポインタを返す（1D の場合）

指定したスパース行列要素が存在する場合、その要素へのポインタを返す

find<_Tp>(i0,...[,hashval]) は (_const Tp*)ptr(i0,...false[,hashval]) と等価である。

指定した要素が存在しない場合、メソッドは NULL を返す。

hash() [1/4]

size_t cv::SparseMat::hash

(

const int *

idx

)

const

要素のハッシュ値を計算する（nD の場合）

hash() [2/4]

size_t cv::SparseMat::hash

(

int

i0

)

const

要素のハッシュ値を計算する（1D の場合）

hash() [3/4]

size_t cv::SparseMat::hash	(	int	i0,
		int	i1 ) const

要素のハッシュ値を計算する（2D の場合）

hash() [4/4]

size_t cv::SparseMat::hash	(	int	i0,
		int	i1,
		int	i2 ) const

要素のハッシュ値を計算する（3D の場合）

newNode()

uchar * cv::SparseMat::newNode	(	const int *	idx,
		size_t	hashval )

node() [1/2]

Node * cv::SparseMat::node

(

size_t

nidx

)

node() [2/2]

const Node * cv::SparseMat::node

(

size_t

nidx

)

const

nzcount()

size_t cv::SparseMat::nzcount

(

)

const

非ゼロ要素の数（= ハッシュテーブルのノード数）を返す

operator=() [1/2]

SparseMat & cv::SparseMat::operator=

(

const Mat &

m

)

対応するコンストラクタと等価

operator=() [2/2]

SparseMat & cv::SparseMat::operator=

(

const SparseMat &

m

)

代入演算子。これは O(1) の操作であり、データはコピーされない

ptr() [1/4]

uchar * cv::SparseMat::ptr	(	const int *	idx,
		bool	createMissing,
		size_t *	hashval = 0 )

指定した要素へのポインタを返す（nD の場合）

ptr() [2/4]

uchar * cv::SparseMat::ptr	(	int	i0,
		bool	createMissing,
		size_t *	hashval = 0 )

指定した要素へのポインタを返す（1D の場合）

1D、2D、3D の場合の特殊化版と、n 次元の場合の汎用型 (generic_type) の版。行列要素へのポインタを返す。

• 要素が存在する場合（非ゼロの場合）、その要素へのポインタが返される
• 要素が存在せず、かつ createMissing=false の場合、NULL ポインタが返される
• 要素が存在せず、かつ createMissing=true の場合、新しい要素が作成され 0 で初期化される。その要素へのポインタが返される
• 省略可能な hashval ポインタが NULL でない場合、要素のハッシュ値は計算されず、代わりに *hashval が使われる。

ptr() [3/4]

uchar * cv::SparseMat::ptr	(	int	i0,
		int	i1,
		bool	createMissing,
		size_t *	hashval = 0 )

指定した要素へのポインタを返す（2D の場合）

ptr() [4/4]

uchar * cv::SparseMat::ptr	(	int	i0,
		int	i1,
		int	i2,
		bool	createMissing,
		size_t *	hashval = 0 )

指定した要素へのポインタを返す（3D の場合）

ref() [1/4]

template<typename _Tp >

_Tp & cv::SparseMat::ref	(	const int *	idx,
		size_t *	hashval = 0 )

指定した要素への参照を返す（nD の場合）

ref() [2/4]

template<typename _Tp >

_Tp & cv::SparseMat::ref	(	int	i0,
		int	i1,
		int	i2,
		size_t *	hashval = 0 )

指定した要素への参照を返す（3D の場合）

ref() [3/4]

template<typename _Tp >

_Tp & cv::SparseMat::ref	(	int	i0,
		int	i1,
		size_t *	hashval = 0 )

指定した要素への参照を返す（2D の場合）

ref() [4/4]

template<typename _Tp >

_Tp & cv::SparseMat::ref	(	int	i0,
		size_t *	hashval = 0 )

指定した要素への参照を返す（1D の場合）

指定したスパース行列要素への読み書き可能な参照を返す。

ref<_Tp>(i0,...[,hashval]) は *(_Tp*)ptr(i0,...,true[,hashval]) と等価である。このメソッドは常に有効な参照を返す。要素が存在しなかった場合は、作成され 0 で初期化される。

release()

void cv::SparseMat::release

(

)

removeNode()

void cv::SparseMat::removeNode	(	size_t	hidx,
		size_t	nidx,
		size_t	previdx )

resizeHashTab()

void cv::SparseMat::resizeHashTab

(

size_t

newsize

)

size() [1/2]

const int * cv::SparseMat::size

(

)

const

サイズの配列を返す。行列が確保されていない場合は NULL を返す

size() [2/2]

int cv::SparseMat::size

(

int

i

)

const

i 番目の行列次元のサイズを返す（または 0）

type()

int cv::SparseMat::type

(

)

const

スパース行列要素の型を返す

value() [1/6]

template<typename _Tp >

_Tp cv::SparseMat::value	(	const int *	idx,
		size_t *	hashval = 0 ) const

指定した要素の値を返す（nD の場合）

value() [2/6]

template<typename _Tp >

const _Tp & cv::SparseMat::value

(

const Node *

n

)

const

スパース行列ノードに格納された値を返す

value() [3/6]

template<typename _Tp >

_Tp cv::SparseMat::value	(	int	i0,
		int	i1,
		int	i2,
		size_t *	hashval = 0 ) const

指定した要素の値を返す（3D の場合）

value() [4/6]

template<typename _Tp >

_Tp cv::SparseMat::value	(	int	i0,
		int	i1,
		size_t *	hashval = 0 ) const

指定した要素の値を返す（2D の場合）

value() [5/6]

template<typename _Tp >

_Tp cv::SparseMat::value	(	int	i0,
		size_t *	hashval = 0 ) const

指定した要素の値を返す（1D の場合）

指定したスパース行列要素の値を返す。

value<_Tp>(i0,...[,hashval]) は次と等価である:

{ const _Tp* p = find<_Tp>(i0,...[,hashval]); return p ? *p : _Tp(); }

つまり、要素が存在しなかった場合、メソッドは 0 を返す。

value() [6/6]

template<typename _Tp >

_Tp & cv::SparseMat::value

(

Node *

n

)

スパース行列ノードに格納された値を返す

メンバ変数詳解

flags

int cv::SparseMat::flags

hdr

Hdr* cv::SparseMat::hdr

---

このクラス詳解は次のファイルから抽出されました:

• opencv2/core/mat.hpp