Public Types | Public Member Functions | Static Public Member Functions | Public Attributes
cv::Vec< _Tp, cn > Class Template Reference

A short numerical vector. More...

#include <core.hpp>

Inherits cv::Matx< _Tp, cn, 1 >.

List of all members.

Public Types

enum  { depth = DataDepth<_Tp>::value, channels = cn, type = CV_MAKETYPE(depth, channels) }
typedef _Tp value_type
enum  
typedef Matx< _Tp, MIN(m, n), 1 > diag_type
typedef Matx< _Tp, m, nmat_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 (const _Tp *values)
 Vec (const Vec< _Tp, cn > &v)
Vec mul (const Vec< _Tp, cn > &v) const
 per-element multiplication
Vec cross (const Vec &v) const
 cross product of the two 3D vectors.
template<typename T2 >
 operator Vec< T2, cn > () const
 convertion to another data type
 operator CvScalar () const
 conversion to 4-element CvScalar.
const _Tp & operator[] (int i) const
 element access
_Tp & operator[] (int i)
const _Tp & operator() (int i) const
 1D element access
_Tp & operator() (int i)
template<>
Vec< float, 3 > cross (const Vec< float, 3 > &v) const
template<>
Vec< double, 3 > cross (const Vec< double, 3 > &v) const
Matx< _Tp, MIN(m, n), 1 > diag () const
 extract the matrix diagonal
_Tp dot (const Matx< _Tp, m, n > &v) const
 dot product computed with the default precision
double ddot (const Matx< _Tp, m, n > &v) const
 dot product computed in double-precision arithmetics
 operator Matx< T2, m, n > () const
 convertion to another data type
Matx< _Tp, m1, n1 > reshape () const
 change the matrix shape
Matx< _Tp, m1, n1 > get_minor (int i, int j) const
 extract part of the matrix
Matx< _Tp, 1, nrow (int i) const
 extract the matrix row
Matx< _Tp, m, 1 > col (int i) const
 extract the matrix column
Matx< _Tp, n, m > t () const
 transpose the matrix
Matx< _Tp, n, m > inv (int method=DECOMP_LU) const
 invert matrix the matrix
Matx< _Tp, n, l > solve (const Matx< _Tp, m, l > &rhs, int flags=DECOMP_LU) const
 solve linear system
Matx< _Tp, n, 1 > solve (const Matx< _Tp, m, 1 > &rhs, int method) const
Matx< _Tp, m, nmul (const Matx< _Tp, m, n > &a) const
 multiply two matrices element-wise
const _Tp & operator() (int i, int j) const
 element access
_Tp & operator() (int i, int j)

Static Public Member Functions

static Vec all (_Tp alpha)
static Matx zeros ()
static Matx ones ()
static Matx eye ()
static Matx diag (const diag_type &d)
static Matx randu (_Tp a, _Tp b)
static Matx randn (_Tp a, _Tp b)

Public Attributes

_Tp val [m *n]

Detailed Description

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

A short numerical vector.

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:

  1. _Tp element type
  2. 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>.


Member Typedef Documentation

template<typename _Tp, int cn>
typedef _Tp cv::Vec< _Tp, cn >::value_type

Reimplemented from cv::Matx< _Tp, cn, 1 >.

typedef Matx<_Tp, MIN(m, n), 1> cv::Matx< _Tp, m, n >::diag_type [inherited]
typedef Matx<_Tp, m, n> cv::Matx< _Tp, m, n >::mat_type [inherited]

Member Enumeration Documentation

template<typename _Tp, int cn>
anonymous enum
Enumerator:
depth 
channels 
type 
anonymous enum [inherited]

Constructor & Destructor Documentation

template<typename _Tp , int cn>
cv::Vec< _Tp, cn >::Vec ( )

default constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0)

1-element vector constructor

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

2-element vector constructor

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

3-element vector constructor

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

4-element vector constructor

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

5-element vector constructor

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

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

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

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

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

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( const _Tp *  values) [explicit]
template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( const Vec< _Tp, cn > &  v)

Member Function Documentation

template<typename _Tp, int cn>
Vec< _Tp, cn > cv::Vec< _Tp, cn >::all ( _Tp  alpha) [static]

Reimplemented from cv::Matx< _Tp, cn, 1 >.

Reimplemented in cv::Scalar_< _Tp >, and cv::Scalar_< double >.

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

per-element multiplication

template<typename _Tp , int cn>
Vec< _Tp, cn > 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

template<typename _Tp , int cn>
template<typename T2 >
cv::Vec< _Tp, cn >::operator Vec< T2, cn > ( ) const

convertion to another data type

template<typename _Tp , int cn>
cv::Vec< _Tp, cn >::operator CvScalar ( ) const

conversion to 4-element CvScalar.

Reimplemented in cv::Scalar_< _Tp >, and cv::Scalar_< double >.

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

element access

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

1D element access

Reimplemented from cv::Matx< _Tp, cn, 1 >.

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

Reimplemented from cv::Matx< _Tp, cn, 1 >.

template<>
Vec< float, 3 > cv::Vec< float, 3 >::cross ( const Vec< float, 3 > &  v) const
template<>
Vec< double, 3 > cv::Vec< double, 3 >::cross ( const Vec< double, 3 > &  v) const
static Matx cv::Matx< _Tp, m, n >::zeros ( ) [static, inherited]
static Matx cv::Matx< _Tp, m, n >::ones ( ) [static, inherited]
static Matx cv::Matx< _Tp, m, n >::eye ( ) [static, inherited]
static Matx cv::Matx< _Tp, m, n >::diag ( const diag_type d) [static, inherited]
Matx<_Tp, MIN(m,n), 1> cv::Matx< _Tp, m, n >::diag ( ) const [inherited]

extract the matrix diagonal

static Matx cv::Matx< _Tp, m, n >::randu ( _Tp  a,
_Tp  b 
) [static, inherited]
static Matx cv::Matx< _Tp, m, n >::randn ( _Tp  a,
_Tp  b 
) [static, inherited]
_Tp cv::Matx< _Tp, m, n >::dot ( const Matx< _Tp, m, n > &  v) const [inherited]

dot product computed with the default precision

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

dot product computed in double-precision arithmetics

cv::Matx< _Tp, m, n >::operator Matx< T2, m, n > ( ) const [inherited]

convertion to another data type

Matx<_Tp, m1, n1> cv::Matx< _Tp, m, n >::reshape ( ) const [inherited]

change the matrix shape

Matx<_Tp, m1, n1> cv::Matx< _Tp, m, n >::get_minor ( int  i,
int  j 
) const [inherited]

extract part of the matrix

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

extract the matrix row

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

extract the matrix column

Matx<_Tp, n, m> cv::Matx< _Tp, m, n >::t ( ) const [inherited]

transpose the matrix

Matx<_Tp, n, m> cv::Matx< _Tp, m, n >::inv ( int  method = DECOMP_LU) const [inherited]

invert matrix the matrix

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

solve linear system

Matx<_Tp, n, 1> cv::Matx< _Tp, m, n >::solve ( const Matx< _Tp, m, 1 > &  rhs,
int  method 
) const [inherited]
Matx<_Tp, m, n> cv::Matx< _Tp, m, n >::mul ( const Matx< _Tp, m, n > &  a) const [inherited]

multiply two matrices element-wise

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

element access

_Tp& cv::Matx< _Tp, m, n >::operator() ( int  i,
int  j 
) [inherited]

Member Data Documentation

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

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