cv::Vec< _Tp, cn > Class Template Reference

Template class for short numerical vectors, a partial case of Matx. More...

#include <opencv2/core/matx.hpp>

Public Types
enum	{   channels = cn ,   _dummy_enum_finalizer = 0 }
typedef _Tp	value_type
Public Types inherited from cv::Matx< _Tp, cn, 1 >
enum
typedef Matx< _Tp, shortdim, 1 >	diag_type
typedef Matx< _Tp, m, n >	mat_type
typedef _Tp	value_type

Public Member Functions
	Vec ()
	default constructor
	Vec (_Tp v0)
	1-element vector constructor
	Vec (_Tp v0, _Tp v1)
	2-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2)
	3-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3)
	4-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4)
	5-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5)
	6-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6)
	7-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7)
	8-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8)
	9-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9)
	10-element vector constructor
	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9, _Tp v10, _Tp v11, _Tp v12, _Tp v13)
	14-element vector constructor
	Vec (const _Tp *values)
template<typename _T2>
	Vec (const Matx< _Tp, cn, 1 > &a, _T2 alpha, Matx_ScaleOp)
	Vec (const Matx< _Tp, cn, 1 > &a, const Matx< _Tp, cn, 1 > &b, Matx_AddOp)
	Vec (const Matx< _Tp, cn, 1 > &a, const Matx< _Tp, cn, 1 > &b, Matx_SubOp)
	Vec (const Vec< _Tp, cn > &v)
	Vec (std::initializer_list< _Tp >)
Vec	conj () const
	conjugation (makes sense for complex numbers and quaternions)
Vec	cross (const Vec &v) const
Vec	mul (const Vec< _Tp, cn > &v) const
	per-element multiplication
template<typename T2>
	operator Vec< T2, cn > () const
	conversion to another data type
_Tp &	operator() (int i)
const _Tp &	operator() (int i) const
Vec< _Tp, cn > &	operator= (const Vec< _Tp, cn > &rhs)=default
_Tp &	operator[] (int i)
const _Tp &	operator[] (int i) const
Public Member Functions inherited from cv::Matx< _Tp, cn, 1 >
	Matx ()
	default constructor
Matx< _Tp, m, 1 >	col (int i) const
	extract the matrix column
double	ddot (const Matx< _Tp, m, n > &v) const
	dot product computed in double-precision arithmetics
Matx< _Tp, m, n >	div (const Matx< _Tp, m, n > &a) const
	divide two matrices element-wise
_Tp	dot (const Matx< _Tp, m, n > &v) const
	dot product computed with the default precision
Matx< _Tp, m1, n1 >	get_minor (int base_row, int base_col) const
	extract part of the matrix
Matx< _Tp, n, m >	inv (int method=DECOMP_LU, bool *p_is_ok=NULL) const
	invert the matrix
Matx< _Tp, m, n >	mul (const Matx< _Tp, m, n > &a) const
	multiply two matrices element-wise
	operator Matx< T2, m, n > () const
	conversion to another data type
const _Tp &	operator() (int row, int col) const
	element access
Matx< _Tp, m1, n1 >	reshape () const
	change the matrix shape
Matx< _Tp, 1, n >	row (int i) const
	extract the matrix row
Matx< _Tp, n, l >	solve (const Matx< _Tp, m, l > &rhs, int flags=DECOMP_LU) const
	solve linear system
Matx< _Tp, n, m >	t () const
	transpose the matrix

Static Public Member Functions
static Vec	all (_Tp alpha)
static Vec	diag (_Tp alpha)=delete
static Vec	eye ()=delete
static Vec	ones ()
static Vec	randn (_Tp a, _Tp b)
static Vec	randu (_Tp a, _Tp b)
static Vec	zeros ()
Static Public Member Functions inherited from cv::Matx< _Tp, cn, 1 >
static CV_NODISCARD_STD Matx	all (_Tp alpha)
static CV_NODISCARD_STD Matx	diag (const diag_type &d)
static CV_NODISCARD_STD Matx	eye ()
static CV_NODISCARD_STD Matx	ones ()
static CV_NODISCARD_STD Matx	randn (_Tp a, _Tp b)
	Generates normally distributed random numbers.
static CV_NODISCARD_STD Matx	randu (_Tp a, _Tp b)
	Generates uniformly distributed random numbers.
static CV_NODISCARD_STD Matx	zeros ()

Additional Inherited Members
Public Attributes inherited from cv::Matx< _Tp, cn, 1 >
_Tp	val [m *n]
	matrix elements

Detailed Description

template<typename _Tp, int cn>
class cv::Vec< _Tp, cn >

Template class for short numerical vectors, a partial case of Matx.

This template class represents short numerical vectors (of 1, 2, 3, 4 ... elements) on which you can perform basic arithmetical operations, access individual elements using [] operator etc. The vectors are allocated on stack, as opposite to std::valarray, std::vector, cv::Mat etc., which elements are dynamically allocated in the heap.

The template takes 2 parameters:

Template Parameters

_Tp	element type
cn	the number of elements

In addition to the universal notation like Vec<float, 3>, you can use shorter aliases for the most popular specialized variants of Vec, e.g. Vec3f ~ Vec<float, 3>.

It is possible to convert Vec<T,2> to/from Point_, Vec<T,3> to/from Point3_ , and Vec<T,4> to CvScalar or Scalar_. Use operator[] to access the elements of Vec.

All the expected vector operations are also implemented:

• v1 = v2 + v3
• v1 = v2 - v3
• v1 = v2 * scale
• v1 = scale * v2
• v1 = -v2
• v1 += v2 and other augmenting operations
• v1 == v2, v1 != v2
• norm(v1) (euclidean norm) The Vec class is commonly used to describe pixel types of multi-channel arrays. See Mat for details.

Member Typedef Documentation

value_type

template<typename _Tp, int cn>

typedef _Tp cv::Vec< _Tp, cn >::value_type

Member Enumeration Documentation

anonymous enum

template<typename _Tp, int cn>

anonymous enum

Enumerator
channels
_dummy_enum_finalizer

Constructor & Destructor Documentation

Vec() [1/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec

(

)

default constructor

Vec() [2/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec

(

_Tp

v0

)

1-element vector constructor

Vec() [3/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1 )

2-element vector constructor

Vec() [4/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2 )

3-element vector constructor

Vec() [5/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3 )

4-element vector constructor

Vec() [6/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4 )

5-element vector constructor

Vec() [7/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5 )

6-element vector constructor

Vec() [8/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6 )

7-element vector constructor

Vec() [9/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6,
		_Tp	v7 )

8-element vector constructor

Vec() [10/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6,
		_Tp	v7,
		_Tp	v8 )

9-element vector constructor

Vec() [11/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6,
		_Tp	v7,
		_Tp	v8,
		_Tp	v9 )

10-element vector constructor

Vec() [12/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6,
		_Tp	v7,
		_Tp	v8,
		_Tp	v9,
		_Tp	v10,
		_Tp	v11,
		_Tp	v12,
		_Tp	v13 )

14-element vector constructor

Vec() [13/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec ( const _Tp * values )

explicit

Vec() [14/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec

(

std::initializer_list< _Tp >

)

Vec() [15/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec

(

const Vec< _Tp, cn > &

v

)

Vec() [16/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	const Matx< _Tp, cn, 1 > &	a,
		const Matx< _Tp, cn, 1 > &	b,
		Matx_AddOp	)

Vec() [17/18]

template<typename _Tp, int cn>

cv::Vec< _Tp, cn >::Vec	(	const Matx< _Tp, cn, 1 > &	a,
		const Matx< _Tp, cn, 1 > &	b,
		Matx_SubOp	)

Vec() [18/18]

template<typename _Tp, int cn>

template<typename _T2>

cv::Vec< _Tp, cn >::Vec	(	const Matx< _Tp, cn, 1 > &	a,
		_T2	alpha,
		Matx_ScaleOp	)

Member Function Documentation

all()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::all ( _Tp alpha )

static

conj()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::conj

(

)

const

conjugation (makes sense for complex numbers and quaternions)

cross()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::cross

(

const Vec< _Tp, cn > &

v

)

const

cross product of the two 3D vectors.

For other dimensionalities the exception is raised

diag()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::diag ( _Tp alpha )

staticdelete

eye()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::eye ( )

staticdelete

mul()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::mul

(

const Vec< _Tp, cn > &

v

)

const

per-element multiplication

ones()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::ones ( )

static

operator Vec< T2, cn >()

template<typename _Tp, int cn>

template<typename T2>

cv::Vec< _Tp, cn >::operator Vec< T2, cn >

(

)

const

conversion to another data type

operator()() [1/2]

template<typename _Tp, int cn>

_Tp & cv::Vec< _Tp, cn >::operator()

(

int

i

)

operator()() [2/2]

template<typename _Tp, int cn>

const _Tp & cv::Vec< _Tp, cn >::operator()

(

int

i

)

const

operator=()

template<typename _Tp, int cn>

Vec< _Tp, cn > & cv::Vec< _Tp, cn >::operator= ( const Vec< _Tp, cn > & rhs )

default

operator[]() [1/2]

template<typename _Tp, int cn>

_Tp & cv::Vec< _Tp, cn >::operator[]

(

int

i

)

operator[]() [2/2]

template<typename _Tp, int cn>

const _Tp & cv::Vec< _Tp, cn >::operator[]

(

int

i

)

const

element access

randn()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::randn ( _Tp a, _Tp b )

static

randu()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::randu ( _Tp a, _Tp b )

static

zeros()

template<typename _Tp, int cn>

Vec cv::Vec< _Tp, cn >::zeros ( )

static

---

The documentation for this class was generated from the following file:

• opencv2/core/matx.hpp