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

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 conj () const
 conjugation (makes sense for complex numbers and quaternions)
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
_Tp & operator() (int i)
 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)
template<>
Vec< float, 2 > conj () const
template<>
Vec< double, 2 > conj () const
template<>
Vec< float, 4 > conj () const
template<>
Vec< double, 4 > conj () const
template<>
Vec< float, 3 > cross (const Vec< float, 3 > &v) const
template<>
Vec< double, 3 > cross (const Vec< double, 3 > &v) const

Static Public Member Functions

static Vec all (_Tp alpha)

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


Member Enumeration Documentation

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

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)
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 
)
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 
)
template<typename _Tp, int cn>
template<typename _T2 >
cv::Vec< _Tp, cn >::Vec ( const Matx< _Tp, cn, 1 > &  a,
_T2  alpha,
Matx_ScaleOp  op 
)

Member Function Documentation

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

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 cv::Vec< _Tp, cn >::conj ( ) const

conjugation (makes sense for complex numbers and quaternions)

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

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
template<typename _Tp , int cn>
_Tp & cv::Vec< _Tp, cn >::operator() ( int  i)
template<>
Vec< float, 2 > cv::Vec< float, 2 >::conj ( ) const
template<>
Vec< double, 2 > cv::Vec< double, 2 >::conj ( ) const
template<>
Vec< float, 4 > cv::Vec< float, 4 >::conj ( ) const
template<>
Vec< double, 4 > cv::Vec< double, 4 >::conj ( ) const
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

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