Template class for small matrices whose type and size are known at compilation time. More...

#include <matx.hpp>

Public Types
enum	{ rows = m , cols = n , channels = rows*cols , shortdim = (m < n ? m : n) }

typedef _Tp	value_type

typedef Matx< _Tp, m, n >	mat_type

typedef Matx< _Tp, shortdim, 1 >	diag_type

Public Member Functions
	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...

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

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

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

template<int m1, int n1>
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...

diag_type	diag () const
	extract the matrix diagonal 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...

template<int l>
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)

	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)

template<typename _T2 >
	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)

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

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

Static Public Member Functions
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...

Public Attributes
_Tp	val [m *n]
	matrix elements More...

Detailed Description

template<typename _Tp, int m, int n>
class cv::Matx< _Tp, m, n >

Template class for small matrices whose type and size are known at compilation time.

If you need a more flexible type, use Mat . The elements of the matrix M are accessible using the M(i,j) notation. Most of the common matrix operations (see also MatrixExpressions ) are available. To do an operation on Matx that is not implemented, you can easily convert the matrix to Mat and backwards:

Matx33f m(1, 2, 3,
          4, 5, 6,
          7, 8, 9);
cout << sum(Mat(m*m.t())) << endl;

Except of the plain constructor which takes a list of elements, Matx can be initialized from a C-array:

float values[] = { 1, 2, 3};

Matx31f m(values);

cv::Matx31f

Matx< float, 3, 1 > Matx31f

Definition: matx.hpp:232

In case if C++11 features are available, std::initializer_list can be also used to initialize Matx:

Matx31f m = { 1, 2, 3};

Member Typedef Documentation

◆ diag_type

template<typename _Tp , int m, int n>

typedef Matx<_Tp, shortdim, 1> cv::Matx< _Tp, m, n >::diag_type

◆ mat_type

template<typename _Tp , int m, int n>

typedef Matx<_Tp, m, n> cv::Matx< _Tp, m, n >::mat_type

◆ value_type

template<typename _Tp , int m, int n>

typedef _Tp cv::Matx< _Tp, m, n >::value_type

Member Enumeration Documentation

◆ anonymous enum

template<typename _Tp , int m, int n>

anonymous enum

Enumerator
rows
cols
channels
shortdim

Constructor & Destructor Documentation

◆ Matx() [1/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx

inline

default constructor

◆ Matx() [2/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx ( _Tp v0 )

inlineexplicit

1x1 matrix

◆ Matx() [3/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1
	)

inline

1x2 or 2x1 matrix

◆ Matx() [4/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2
	)

inline

1x3 or 3x1 matrix

◆ Matx() [5/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3
	)

inline

1x4, 2x2 or 4x1 matrix

◆ Matx() [6/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4
	)

inline

1x5 or 5x1 matrix

◆ Matx() [7/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5
	)

inline

1x6, 2x3, 3x2 or 6x1 matrix

◆ Matx() [8/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6
	)

inline

1x7 or 7x1 matrix

◆ Matx() [9/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6,
		_Tp	v7
	)

inline

1x8, 2x4, 4x2 or 8x1 matrix

◆ Matx() [10/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6,
		_Tp	v7,
		_Tp	v8
	)

inline

1x9, 3x3 or 9x1 matrix

◆ Matx() [11/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx	(	_Tp	v0,
		_Tp	v1,
		_Tp	v2,
		_Tp	v3,
		_Tp	v4,
		_Tp	v5,
		_Tp	v6,
		_Tp	v7,
		_Tp	v8,
		_Tp	v9
	)

inline

1x10, 2x5 or 5x2 or 10x1 matrix

◆ Matx() [12/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::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
	)

inline

1x12, 2x6, 3x4, 4x3, 6x2 or 12x1 matrix

◆ Matx() [13/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::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
	)

inline

1x14, 2x7, 7x2 or 14x1 matrix

◆ Matx() [14/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::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
	)

inline

1x16, 4x4 or 16x1 matrix

◆ Matx() [15/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx ( const _Tp * vals )

inlineexplicit

initialize from a plain array

◆ Matx() [16/23]

template<typename _Tp , int m, int n>

cv::Matx< _Tp, m, n >::Matx ( std::initializer_list< _Tp > list )

inline

initialize from an initializer list

◆ Matx() [17/23]

template<typename _Tp , int m, int n>

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

inline

◆ Matx() [18/23]

template<typename _Tp , int m, int n>

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

inline

◆ Matx() [19/23]

template<typename _Tp , int m, int n>

template<typename _T2 >

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

inline

◆ Matx() [20/23]

template<typename _Tp , int m, int n>

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

inline

◆ Matx() [21/23]

template<typename _Tp , int m, int n>

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

inline

◆ Matx() [22/23]

template<typename _Tp , int m, int n>

template<int l>

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

inline

◆ Matx() [23/23]

template<typename _Tp , int m, int n>

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

inline

Member Function Documentation

◆ all()

template<typename _Tp , int m, int n>

Matx< _Tp, m, n > cv::Matx< _Tp, m, n >::all ( _Tp alpha )

inlinestatic

◆ col()

template<typename _Tp , int m, int n>

Matx< _Tp, m, 1 > cv::Matx< _Tp, m, n >::col ( int i ) const

inline

extract the matrix column

◆ ddot()

template<typename _Tp , int m, int n>

double cv::Matx< _Tp, m, n >::ddot ( const Matx< _Tp, m, n > & v ) const

inline

dot product computed in double-precision arithmetics

◆ diag() [1/2]

template<typename _Tp , int m, int n>

Matx< _Tp, m, n >::diag_type cv::Matx< _Tp, m, n >::diag

inline

extract the matrix diagonal

◆ diag() [2/2]

template<typename _Tp , int m, int n>

static CV_NODISCARD_STD Matx cv::Matx< _Tp, m, n >::diag ( const diag_type & d )

static

◆ div()

template<typename _Tp , int m, int n>

Matx< _Tp, m, n > cv::Matx< _Tp, m, n >::div ( const Matx< _Tp, m, n > & a ) const

inline

divide two matrices element-wise

◆ dot()

template<typename _Tp , int m, int n>

_Tp cv::Matx< _Tp, m, n >::dot ( const Matx< _Tp, m, n > & v ) const

inline

dot product computed with the default precision

◆ eye()

template<typename _Tp , int m, int n>

Matx< _Tp, m, n > cv::Matx< _Tp, m, n >::eye

inlinestatic

◆ get_minor()

template<typename _Tp , int m, int n>

template<int m1, int n1>

Matx< _Tp, m1, n1 > cv::Matx< _Tp, m, n >::get_minor	(	int	base_row,
		int	base_col
	)		const

inline

extract part of the matrix

◆ inv()

template<typename _Tp , int m, int n>

Matx<_Tp, n, m> cv::Matx< _Tp, m, n >::inv	(	int	method = `DECOMP_LU`,
		bool *	p_is_ok = `NULL`
	)		const

invert the matrix

◆ mul()

template<typename _Tp , int m, int n>

Matx< _Tp, m, n > cv::Matx< _Tp, m, n >::mul ( const Matx< _Tp, m, n > & a ) const

inline

multiply two matrices element-wise

◆ ones()

template<typename _Tp , int m, int n>

Matx< _Tp, m, n > cv::Matx< _Tp, m, n >::ones

inlinestatic

◆ operator Matx< T2, m, n >()

template<typename _Tp , int m, int n>

template<typename T2 >

cv::Matx< _Tp, m, n >::operator Matx< T2, m, n >

inline

conversion to another data type

◆ operator()() [1/4]

template<typename _Tp , int m, int n>

_Tp & cv::Matx< _Tp, m, n >::operator() ( int i )

inline

◆ operator()() [2/4]

template<typename _Tp , int m, int n>

const _Tp & cv::Matx< _Tp, m, n >::operator() ( int i ) const

inline

1D element access

◆ operator()() [3/4]

template<typename _Tp , int m, int n>

_Tp & cv::Matx< _Tp, m, n >::operator()	(	int	row,
		int	col
	)

inline

◆ operator()() [4/4]

template<typename _Tp , int m, int n>

const _Tp & cv::Matx< _Tp, m, n >::operator()	(	int	row,
		int	col
	)		const

inline

element access

◆ randn()

template<typename _Tp , int m, int n>

static CV_NODISCARD_STD Matx cv::Matx< _Tp, m, n >::randn	(	_Tp	a,
		_Tp	b
	)

static

Generates normally distributed random numbers.

Parameters

a	Mean value.
b	Standard deviation.

◆ randu()

template<typename _Tp , int m, int n>

static CV_NODISCARD_STD Matx cv::Matx< _Tp, m, n >::randu	(	_Tp	a,
		_Tp	b
	)

static

Generates uniformly distributed random numbers.

Parameters

a	Range boundary.
b	The other range boundary (boundaries don't have to be ordered, the lower boundary is inclusive, the upper one is exclusive).

◆ reshape()

template<typename _Tp , int m, int n>

template<int m1, int n1>

Matx< _Tp, m1, n1 > cv::Matx< _Tp, m, n >::reshape

inline

change the matrix shape

◆ row()

template<typename _Tp , int m, int n>

Matx< _Tp, 1, n > cv::Matx< _Tp, m, n >::row ( int i ) const

inline

extract the matrix row

◆ solve() [1/2]

template<typename _Tp , int m, int n>

template<int l>

Matx<_Tp, n, l> cv::Matx< _Tp, m, n >::solve	(	const Matx< _Tp, m, l > &	rhs,
		int	flags = `DECOMP_LU`
	)		const

solve linear system

◆ solve() [2/2]

template<typename _Tp , int m, int n>

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

inline

◆ t()

template<typename _Tp , int m, int n>

Matx< _Tp, n, m > cv::Matx< _Tp, m, n >::t

inline

transpose the matrix

◆ zeros()

template<typename _Tp , int m, int n>

Matx< _Tp, m, n > cv::Matx< _Tp, m, n >::zeros

inlinestatic

Member Data Documentation

◆ val

template<typename _Tp , int m, int n>

_Tp cv::Matx< _Tp, m, n >::val[m *n]

matrix elements

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

Public Attributes

Detailed Description

template<typename _Tp, int m, int n> class cv::Matx< _Tp, m, n >

Member Typedef Documentation

◆ diag_type

◆ mat_type

◆ value_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Matx() [1/23]

◆ Matx() [2/23]

◆ Matx() [3/23]

◆ Matx() [4/23]

◆ Matx() [5/23]

◆ Matx() [6/23]

◆ Matx() [7/23]

◆ Matx() [8/23]

◆ Matx() [9/23]

◆ Matx() [10/23]

◆ Matx() [11/23]

◆ Matx() [12/23]

◆ Matx() [13/23]

◆ Matx() [14/23]

◆ Matx() [15/23]

◆ Matx() [16/23]

◆ Matx() [17/23]

◆ Matx() [18/23]

◆ Matx() [19/23]

◆ Matx() [20/23]

◆ Matx() [21/23]

◆ Matx() [22/23]

◆ Matx() [23/23]

Member Function Documentation

◆ all()

◆ col()

◆ ddot()

◆ diag() [1/2]

◆ diag() [2/2]

◆ div()

◆ dot()

◆ eye()

◆ get_minor()

◆ inv()

◆ mul()

◆ ones()

◆ operator Matx< T2, m, n >()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ randn()

◆ randu()

◆ reshape()

◆ row()

◆ solve() [1/2]

◆ solve() [2/2]

◆ t()

◆ zeros()

Member Data Documentation

◆ val

template<typename _Tp, int m, int n>
class cv::Matx< _Tp, m, n >