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

#include <matx.hpp>

Inheritance diagram for cv::Vec< _Tp, cn >:

Public Types
enum	{ channels = cn , _dummy_enum_finalizer = 0 }

typedef _Tp	value_type

Public Types inherited from cv::Matx< _Tp, cn, 1 >
enum

typedef _Tp	value_type

typedef Matx< _Tp, m, n >	mat_type

typedef Matx< _Tp, shortdim, 1 >	diag_type

Public Member Functions
	Vec ()
	default constructor More...

	Vec (_Tp v0)
	1-element vector constructor More...

	Vec (_Tp v0, _Tp v1)
	2-element vector constructor More...

	Vec (_Tp v0, _Tp v1, _Tp v2)
	3-element vector constructor More...

	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3)
	4-element vector constructor More...

	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4)
	5-element vector constructor More...

	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5)
	6-element vector constructor More...

	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6)
	7-element vector constructor More...

	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7)
	8-element vector constructor More...

	Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8)
	9-element vector constructor More...

	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 More...

	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 More...

	Vec (const _Tp *values)

	Vec (std::initializer_list< _Tp >)

	Vec (const Vec< _Tp, cn > &v)

Vec	mul (const Vec< _Tp, cn > &v) const
	per-element multiplication More...

Vec	conj () const
	conjugation (makes sense for complex numbers and quaternions) More...

Vec	cross (const Vec &v) const

template<typename T2 >
	operator Vec< T2, cn > () const
	conversion to another data type More...

const _Tp &	operator[] (int i) const

_Tp &	operator[] (int i)

const _Tp &	operator() (int i) const

_Tp &	operator() (int i)

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

	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)

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

Vec< float, 2 >	conj () const

Vec< double, 2 >	conj () const

Vec< float, 4 >	conj () const

Vec< double, 4 >	conj () const

Vec< float, 3 >	cross (const Vec< float, 3 > &v) const

Vec< double, 3 >	cross (const Vec< double, 3 > &v) const

Public Member Functions inherited from cv::Matx< _Tp, cn, 1 >
	Matx ()
	default constructor More...

	Matx (_Tp v0)
	1x1 matrix More...

	Matx (_Tp v0, _Tp v1)
	1x2 or 2x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2)
	1x3 or 3x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3)
	1x4, 2x2 or 4x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4)
	1x5 or 5x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5)
	1x6, 2x3, 3x2 or 6x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6)
	1x7 or 7x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7)
	1x8, 2x4, 4x2 or 8x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8)
	1x9, 3x3 or 9x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9)
	1x10, 2x5 or 5x2 or 10x1 matrix More...

	Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9, _Tp v10, _Tp v11)
	1x12, 2x6, 3x4, 4x3, 6x2 or 12x1 matrix More...

	Matx (_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)
	1x14, 2x7, 7x2 or 14x1 matrix More...

	Matx (_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, _Tp v14, _Tp v15)
	1x16, 4x4 or 16x1 matrix More...

	Matx (const _Tp *vals)
	initialize from a plain array More...

	Matx (std::initializer_list< _Tp >)
	initialize from an initializer list More...

	Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_AddOp)

	Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_SubOp)

	Matx (const Matx< _Tp, m, n > &a, _T2 alpha, Matx_ScaleOp)

	Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_MulOp)

	Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_DivOp)

	Matx (const Matx< _Tp, m, l > &a, const Matx< _Tp, l, n > &b, Matx_MatMulOp)

	Matx (const Matx< _Tp, n, m > &a, Matx_TOp)

diag_type	diag () const
	extract the matrix diagonal More...

_Tp	dot (const Matx< _Tp, m, n > &v) const
	dot product computed with the default precision More...

double	ddot (const Matx< _Tp, m, n > &v) const
	dot product computed in double-precision arithmetics More...

	operator Matx< T2, m, n > () const
	conversion to another data type More...

Matx< _Tp, m1, n1 >	reshape () const
	change the matrix shape More...

Matx< _Tp, m1, n1 >	get_minor (int base_row, int base_col) const
	extract part of the matrix More...

Matx< _Tp, 1, n >	row (int i) const
	extract the matrix row More...

Matx< _Tp, m, 1 >	col (int i) const
	extract the matrix column More...

Matx< _Tp, n, m >	t () const
	transpose the matrix More...

Matx< _Tp, n, m >	inv (int method=DECOMP_LU, bool *p_is_ok=NULL) const
	invert the matrix More...

Matx< _Tp, n, l >	solve (const Matx< _Tp, m, l > &rhs, int flags=DECOMP_LU) const
	solve linear system More...

Vec< _Tp, n >	solve (const Vec< _Tp, m > &rhs, int method) const

Matx< _Tp, m, n >	mul (const Matx< _Tp, m, n > &a) const
	multiply two matrices element-wise More...

Matx< _Tp, m, n >	div (const Matx< _Tp, m, n > &a) const
	divide two matrices element-wise More...

const _Tp &	operator() (int row, int col) const
	element access More...

_Tp &	operator() (int row, int col)

const _Tp &	operator() (int i) const
	1D element access More...

_Tp &	operator() (int i)

Static Public Member Functions
static Vec	all (_Tp alpha)

static Vec	ones ()

static Vec	randn (_Tp a, _Tp b)

static Vec	randu (_Tp a, _Tp b)

static Vec	zeros ()

static Vec	diag (_Tp alpha)=delete

static Vec	eye ()=delete

Static Public Member Functions inherited from cv::Matx< _Tp, cn, 1 >
static CV_NODISCARD_STD Matx	all (_Tp alpha)

static CV_NODISCARD_STD Matx	zeros ()

static CV_NODISCARD_STD Matx	ones ()

static CV_NODISCARD_STD Matx	eye ()

static CV_NODISCARD_STD Matx	diag (const diag_type &d)

static CV_NODISCARD_STD Matx	randu (_Tp a, _Tp b)
	Generates uniformly distributed random numbers. More...

static CV_NODISCARD_STD Matx	randn (_Tp a, _Tp b)
	Generates normally distributed random numbers. More...

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

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

inline

default constructor

◆ Vec() [2/18]

template<typename _Tp , int cn>

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

inline

1-element vector constructor

◆ Vec() [3/18]

template<typename _Tp , int cn>

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

inline

2-element vector constructor

◆ Vec() [4/18]

template<typename _Tp , int cn>

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

inline

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
	)

inline

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
	)

inline

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
	)

inline

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
	)

inline

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
	)

inline

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
	)

inline

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
	)

inline

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
	)

inline

14-element vector constructor

◆ Vec() [13/18]

template<typename _Tp , int cn>

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

inlineexplicit

◆ Vec() [14/18]

template<typename _Tp , int cn>

cv::Vec< _Tp, cn >::Vec ( std::initializer_list< _Tp > list )

inline

◆ Vec() [15/18]

template<typename _Tp , int cn>

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

inline

◆ 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	op
	)

inline

◆ 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	op
	)

inline

◆ 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	op
	)

inline

Member Function Documentation

◆ all()

template<typename _Tp , int cn>

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

inlinestatic

◆ conj() [1/5]

template<typename _Tp , int cn>

Vec cv::Vec< _Tp, cn >::conj ( ) const

conjugation (makes sense for complex numbers and quaternions)

◆ conj() [2/5]

Vec< float, 2 > cv::Vec< float, 2 >::conj ( ) const

inline

◆ conj() [3/5]

Vec< double, 2 > cv::Vec< double, 2 >::conj ( ) const

inline

◆ conj() [4/5]

Vec< float, 4 > cv::Vec< float, 4 >::conj ( ) const

inline

◆ conj() [5/5]

Vec< double, 4 > cv::Vec< double, 4 >::conj ( ) const

inline

◆ cross() [1/3]

template<typename _Tp , int cn>

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

inline

cross product of the two 3D vectors.

For other dimensionalities the exception is raised

◆ cross() [2/3]

Vec< double, 3 > cv::Vec< double, 3 >::cross ( const Vec< double, 3 > & v ) const

inline

◆ cross() [3/3]

Vec< float, 3 > cv::Vec< float, 3 >::cross ( const Vec< float, 3 > & v ) const

inline

◆ diag()

template<typename _Tp , int cn>

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

staticdelete

◆ eye()

template<typename _Tp , int cn>

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

staticdelete

◆ mul()

template<typename _Tp , int cn>

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

inline

per-element multiplication

◆ ones()

template<typename _Tp , int cn>

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

inlinestatic

◆ operator Vec< T2, cn >()

template<typename _Tp , int cn>

template<typename T2 >

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

inline

conversion to another data type

◆ operator()() [1/2]

template<typename _Tp , int cn>

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

inline

◆ operator()() [2/2]

template<typename _Tp , int cn>

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

inline

◆ 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 )

inline

◆ operator[]() [2/2]

template<typename _Tp , int cn>

const _Tp & cv::Vec< _Tp, cn >::operator[] ( int i ) const

inline

element access

◆ randn()

template<typename _Tp , int cn>

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

static

◆ randu()

template<typename _Tp , int cn>

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

static

◆ zeros()

template<typename _Tp , int cn>

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

inlinestatic

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

build/release/_deps/opencv-src/include/opencv4/opencv2/core/matx.hpp
build/release/_deps/opencv-src/include/opencv4/opencv2/core/matx.inl.hpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ value_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Vec() [1/18]

◆ Vec() [2/18]

◆ Vec() [3/18]

◆ Vec() [4/18]

◆ Vec() [5/18]

◆ Vec() [6/18]

◆ Vec() [7/18]

◆ Vec() [8/18]

◆ Vec() [9/18]

◆ Vec() [10/18]

◆ Vec() [11/18]

◆ Vec() [12/18]

◆ Vec() [13/18]

◆ Vec() [14/18]

◆ Vec() [15/18]

◆ Vec() [16/18]

◆ Vec() [17/18]

◆ Vec() [18/18]

Member Function Documentation

◆ all()

◆ conj() [1/5]

◆ conj() [2/5]

◆ conj() [3/5]

◆ conj() [4/5]

◆ conj() [5/5]

◆ cross() [1/3]

◆ cross() [2/3]

◆ cross() [3/3]

◆ diag()

◆ eye()

◆ mul()

◆ ones()

◆ operator Vec< T2, cn >()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ randn()

◆ randu()

◆ zeros()

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