#include <visp3/core/vpSubColVector.h>

Inheritance diagram for vpSubColVector:

Public Member Functions
	vpSubColVector ()

	vpSubColVector (vpColVector &v, const unsigned int &offset, const unsigned int &nrows)

virtual	~vpSubColVector ()

void	checkParentStatus () const

void	init (vpColVector &v, const unsigned int &offset, const unsigned int &nrows)

vpSubColVector &	operator= (const vpSubColVector &B)

vpSubColVector &	operator= (const vpPoseVector &p)

vpSubColVector &	operator= (const vpRotationVector &rv)

vpSubColVector &	operator= (const vpTranslationVector &tv)

vpSubColVector &	operator= (const vpColVector &B)

vpSubColVector &	operator= (const vpMatrix &B)

vpSubColVector &	operator= (const double &x)

void	clear ()

std::ostream &	cppPrint (std::ostream &os, const std::string &matrixName="A", bool octet=false) const

std::ostream &	csvPrint (std::ostream &os) const

void	deg2rad ()

double	euclideanNorm () const

vpColVector	extract (unsigned int r, unsigned int colsize) const

vpColVector	hadamard (const vpColVector &v) const

double	infinityNorm () const

void	init (const vpColVector &v, unsigned int r, unsigned int nrows)

void	insert (unsigned int i, const vpColVector &v)

void	insert (const vpColVector &v, unsigned int i)

std::ostream &	maplePrint (std::ostream &os) const

std::ostream &	matlabPrint (std::ostream &os) const

vpColVector &	normalize ()

vpColVector &	normalize (vpColVector &x) const

double &	operator[] (unsigned int n)

const double &	operator[] (unsigned int n) const

double	operator* (const vpColVector &x) const

vpMatrix	operator* (const vpRowVector &v) const

vpColVector	operator* (const double x) const

vpColVector &	operator*= (double x)

vpColVector	operator/ (const double x) const

vpColVector &	operator/= (double x)

vpColVector	operator+ (const vpColVector &v) const

vpTranslationVector	operator+ (const vpTranslationVector &t) const

vpColVector &	operator+= (vpColVector v)

vpColVector	operator- (const vpColVector &v) const

vpColVector	operator- () const

vpColVector &	operator-= (vpColVector v)

vpColVector &	operator<< (const vpColVector &v)

vpColVector &	operator<< (double *)

int	print (std::ostream &s, unsigned int length, char const *intro=0) const

void	rad2deg ()

void	reshape (vpMatrix &M, const unsigned int &nrows, const unsigned int &ncols)

vpMatrix	reshape (const unsigned int &nrows, const unsigned int &ncols)

void	resize (const unsigned int i, const bool flagNullify=true)

void	resize (const unsigned int nrows, const unsigned int ncols, const bool flagNullify)

void	stack (const double &d)

void	stack (const vpColVector &v)

double	sum () const

double	sumSquare () const

vpRowVector	t () const

vpRowVector	transpose () const

void	transpose (vpRowVector &v) const

Inherited functionalities from vpArray2D
vpArray2D< double >	hadamard (const vpArray2D< double > &m) const

void	resize (const unsigned int nrows, const unsigned int ncols, const bool flagNullify=true, const bool recopy_=true)

unsigned int	getCols () const

double	getMaxValue () const

double	getMinValue () const

unsigned int	getRows () const

unsigned int	size () const

Static Public Member Functions
static vpColVector	stack (const vpColVector &A, const vpColVector &B)

static void	stack (const vpColVector &A, const vpColVector &B, vpColVector &C)

static vpColVector	cross (const vpColVector &a, const vpColVector &b)

static vpColVector	crossProd (const vpColVector &a, const vpColVector &b)

static double	dotProd (const vpColVector &a, const vpColVector &b)

static vpColVector	invSort (const vpColVector &v)

static double	median (const vpColVector &v)

static double	mean (const vpColVector &v)

static vpMatrix	skew (const vpColVector &v)

static vpColVector	sort (const vpColVector &v)

static double	stdev (const vpColVector &v, const bool useBesselCorrection=false)

Inherited I/O from vpArray2D with Static Public Member Functions
static bool	load (const std::string &filename, vpArray2D< double > &A, const bool binary=false, char *header=NULL)

static bool	loadYAML (const std::string &filename, vpArray2D< double > &A, char *header=NULL)

static bool	save (const std::string &filename, const vpArray2D< double > &A, const bool binary=false, const char *header="")

static bool	saveYAML (const std::string &filename, const vpArray2D< double > &A, const char *header="")

Public Attributes
double *	data

Protected Attributes
unsigned int	pRowNum

vpColVector *	parent

unsigned int	rowNum

unsigned int	colNum

double **	rowPtrs

unsigned int	dsize

Related Functions
(Note that these are not member functions.)
vpColVector	operator* (const double &x, const vpColVector &v)

enum	vpGEMMmethod

void	vpGEMM (const vpArray2D< double > &A, const vpArray2D< double > &B, const double &alpha, const vpArray2D< double > &C, const double &beta, vpArray2D< double > &D, const unsigned int &ops=0)

Deprecated functions
vp_deprecated void	init ()

vp_deprecated void	insert (const vpColVector &v, const unsigned int r, const unsigned int c=0)

vp_deprecated vpColVector	rows (unsigned int first_row, unsigned int last_row) const

vp_deprecated void	setIdentity (const double &val=1.0)

vp_deprecated void	stackMatrices (const vpColVector &r)

static vp_deprecated vpColVector	stackMatrices (const vpColVector &A, const vpColVector &B)

static vp_deprecated void	stackMatrices (const vpColVector &A, const vpColVector &B, vpColVector &C)

Detailed Description

This class provides a mask on a vpColVector. It has internally a pointer to the parent vpColVector. All properties of vpColVector are available with a vpSubColVector.

Author: Jean Laneurit (IRISA - INRIA Rennes)

See also: vpMatrix vpColvector vpRowVector

Definition at line 62 of file vpSubColVector.h.

Constructor & Destructor Documentation

◆ vpSubColVector() [1/2]

vpSubColVector::vpSubColVector ( )

Default constructor that creates an empty vector.

Definition at line 45 of file vpSubColVector.cpp.

◆ vpSubColVector() [2/2]

vpSubColVector::vpSubColVector	(	vpColVector &	v,
		const unsigned int &	offset,
		const unsigned int &	nrows
	)

Construct a sub-column vector from a parent column vector.

Parameters

v	: parent column vector.
offset	: offset where the sub-column vector starts in the parent column vector.
nrows	: size of the sub-column vector.

Definition at line 53 of file vpSubColVector.cpp.

References vpColVector::init().

◆ ~vpSubColVector()

vpSubColVector::~vpSubColVector ( )

virtual

Destructor that set the pointer to the parrent column vector to NULL.

Definition at line 98 of file vpSubColVector.cpp.

References vpArray2D< double >::data.

Member Function Documentation

◆ checkParentStatus()

void vpSubColVector::checkParentStatus ( ) const

This method can be used to detect if the parent column vector always exits or its size have not changed. If this not the case an exception is thrown.

Definition at line 105 of file vpSubColVector.cpp.

References vpArray2D< double >::data, vpException::dimensionError, vpException::fatalError, vpArray2D< Type >::getRows(), parent, and pRowNum.

◆ clear()

void vpColVector::clear ( )

inlineinherited

Removes all elements from the vector (which are destroyed), leaving the container with a size of 0.

Examples:: testColVector.cpp.

Definition at line 113 of file vpColVector.h.

References vpArray2D< double >::colNum, vpMatrix::cppPrint(), vpMatrix::csvPrint(), vpArray2D< double >::data, vpArray2D< double >::dsize, vpArray2D< double >::rowNum, and vpArray2D< double >::rowPtrs.

Referenced by vpMbTracker::createCylinderBBox().

◆ cppPrint()

std::ostream & vpColVector::cppPrint	(	std::ostream &	os,
		const std::string &	matrixName = `"A"`,
		bool	octet = `false`
	)		const

inherited

Print to be used as part of a C++ code later.

Parameters

os	: the stream to be printed in.
matrixName	: name of the column vector, "A" by default.
octet	: if false, print using double, if true, print byte per byte each bytes of the double array.

The following code shows how to use this function:

#include <visp3/core/vpColVector.h>
int main()
{
  vpColVector v(3);
  for (unsigned int i=0; i<v.size(); i++)
    v[i] = i;
  v.cppPrint(std::cout, "v");
}

It produces the following output that could be copy/paste in a C++ code:

vpColVector v (3);
v[0] = 0;
v[1] = 1;
v[2] = 2;

Definition at line 1503 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

◆ cross()

static vpColVector vpColVector::cross	(	const vpColVector &	a,
		const vpColVector &	b
	)

inlinestaticinherited

Compute and return the cross product of two 3-dimension vectors: $a \times b$ .

Parameters

a	: 3-dimension column vector.
b	: 3-dimension column vector.

Returns: The cross product $a \times b$ .

Exceptions

vpException::dimensionError If the vectors dimension is not equal to 3.

Definition at line 280 of file vpColVector.h.

References vpMatrix::stack().

Referenced by vpMbtDistanceLine::buildFrom(), vpPlane::init(), vpPose::poseDementhonNonPlan(), and vpMbtDistanceLine::~vpMbtDistanceLine().

◆ crossProd()

vpColVector vpColVector::crossProd	(	const vpColVector &	a,
		const vpColVector &	b
	)

staticinherited

Compute and return the cross product of two vectors $a \times b$ .

Parameters

a	: 3-dimension column vector.
b	: 3-dimension column vector.

Returns: The cross product $a \times b$ .

Exceptions

vpException::dimensionError If the vectors dimension is not equal to 3.

Definition at line 1071 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< Type >::getRows(), and vpColVector::skew().

Referenced by vpMbTracker::addPolygon(), vpPose::coplanar(), vpMbTracker::createCylinderBBox(), and vpImageSimulator::setCameraPosition().

◆ csvPrint()

std::ostream & vpColVector::csvPrint ( std::ostream & os ) const

inherited

Print/save a column vector in csv format.

The following code

#include <visp3/core/vpColVector.h>
int main()
{
  std::ofstream ofs("log.csv", std::ofstream::out);
  vpColVector v(3);
  for (unsigned int i=0; i<v.size(); i++)
    v[i] = i;
  v.csvPrint(ofs);
  ofs.close();
}

produces log.csv file that contains:

0
1
2

Definition at line 1548 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

◆ deg2rad()

void vpColVector::deg2rad ( )

inlineinherited

Convert a column vector containing angles in degrees into radians.

See also: rad2deg()

Definition at line 134 of file vpColVector.h.

References vpMatrix::euclideanNorm().

Referenced by vpRobotViper650::getPosition(), vpRobotViper850::getPosition(), vpRobotViper650::getVelocity(), vpRobotViper850::getVelocity(), vpRobotViper650::init(), vpRobotViper850::init(), vpSimulatorViper850::readPosFile(), vpRobotViper650::readPosFile(), vpRobotViper850::readPosFile(), vpRobotPtu46::readPositionFile(), vpRobotBiclops::readPositionFile(), vpRobotViper650::setPosition(), and vpRobotViper850::setPosition().

◆ dotProd()

double vpColVector::dotProd	(	const vpColVector &	a,
		const vpColVector &	b
	)

staticinherited

Compute end return the dot product of two column vectors:

$a \cdot b = \sum_{i=0}^n a_i * b_i$

where n is the dimension of both vectors.

Exceptions

vpException::dimensionError If the vector dimension differ.

Definition at line 703 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpException::dimensionError, vpException::fatalError, vpArray2D< Type >::getRows(), and vpArray2D< Type >::size().

Referenced by vpPose::calculArbreDementhon(), vpMbtFaceDepthNormal::computeNormalVisibility(), vpMbtPolygon::isVisible(), vpPose::poseDementhonPlan(), and vpImageSimulator::setCameraPosition().

◆ euclideanNorm()

double vpColVector::euclideanNorm ( ) const

inherited

Compute and return the Euclidean norm $||x|| = \sqrt{ \sum{v_{i}^2}}$ .

Returns: The Euclidean norm if the vector is initialized, 0 otherwise.

Definition at line 1406 of file vpColVector.cpp.

References vpColVector::sumSquare().

Referenced by vpServo::computeProjectionOperators(), vpMbTracker::createCylinderBBox(), vpImageSimulator::setCameraPosition(), and vpSimulatorAfma6::setPosition().

◆ extract()

vpColVector vpColVector::extract	(	unsigned int	r,
		unsigned int	colsize
	)		const

inlineinherited

Extract a sub-column vector from a column vector.

Parameters

r	: Index of the row corresponding to the first element of the vector to extract.
colsize	: Size of the vector to extract.

Exceptions

vpException::fatalError If the vector to extract is not contained in the original one.

vpColVector v1;
for (unsigned int i=0; i<4; i++)
  v1.stack(i);
// v1 is equal to [0 1 2 3]^T
vpColVector v2 = v1.extract(1, 3);
// v2 is equal to [1 2 3]^T

Examples:: testColVector.cpp, and testForceTorqueAti.cpp.

Definition at line 158 of file vpColVector.h.

References vpException::fatalError, vpArray2D< Type >::hadamard(), vpMatrix::infinityNorm(), vpMatrix::init(), vpMatrix::insert(), vpMatrix::maplePrint(), vpMatrix::matlabPrint(), and vpArray2D< double >::rowNum.

◆ getCols()

unsigned int vpArray2D< double >::getCols ( ) const

inlineinherited

Return the number of columns of the 2D array.

See also: getRows(), size()

Examples:: servoViper850Point2DArtVelocity-jointAvoidance-basic.cpp, testColVector.cpp, testDisplacement.cpp, testImageFilter.cpp, testMatrix.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseVector.cpp, testRowVector.cpp, testSvd.cpp, and testTranslationVector.cpp.

Definition at line 146 of file vpArray2D.h.

References vpArray2D< Type >::colNum, vpArray2D< Type >::getMaxValue(), and vpArray2D< Type >::getMinValue().

Referenced by vpRowVector::cppPrint(), vpMatrix::cppPrint(), vpRowVector::csvPrint(), vpMatrix::csvPrint(), vpMatrix::detByLU(), vpMatrix::extract(), vpRotationMatrix::getCol(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpMatrix::getRow(), vpMatrix::kernel(), vpRowVector::maplePrint(), vpMatrix::maplePrint(), vpRowVector::matlabPrint(), vpMatrix::matlabPrint(), vpRowVector::operator*(), vpRowVector::operator+(), vpRowVector::operator+=(), vpRowVector::operator-(), vpRowVector::operator-=(), vpForceTwistMatrix::print(), vpVelocityTwistMatrix::print(), vpRowVector::print(), vpMatrix::print(), vpMatrix::pseudoInverse(), and vpMatrix::row().

◆ getMaxValue()

double vpArray2D< double >::getMaxValue ( ) const

inherited

Return the array max value.

Examples:: servoMomentImage.cpp, testArray2D.cpp, and testMatrix.cpp.

Definition at line 671 of file vpArray2D.h.

References vpArray2D< Type >::data, and vpArray2D< Type >::dsize.

◆ getMinValue()

double vpArray2D< double >::getMinValue ( ) const

inherited

Return the array min value.

Examples:: servoMomentImage.cpp, testArray2D.cpp, and testMatrix.cpp.

Definition at line 655 of file vpArray2D.h.

References vpArray2D< Type >::data, and vpArray2D< Type >::dsize.

◆ getRows()

unsigned int vpArray2D< double >::getRows ( ) const

inlineinherited

Return the number of rows of the 2D array.

See also: getCols(), size()

Examples:: testColVector.cpp, testDisplacement.cpp, testImageFilter.cpp, testMatrix.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseVector.cpp, testRowVector.cpp, testSvd.cpp, and testTranslationVector.cpp.

Definition at line 156 of file vpArray2D.h.

References vpArray2D< Type >::rowNum.

Referenced by vpMatrix::column(), vpColVector::cppPrint(), vpMatrix::cppPrint(), vpColVector::csvPrint(), vpMatrix::csvPrint(), vpMatrix::detByLU(), vpMatrix::extract(), vpRotationMatrix::getCol(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpMatrix::getRow(), vpMatrix::inverseByCholesky(), vpMatrix::kernel(), vpColVector::maplePrint(), vpMatrix::maplePrint(), vpColVector::matlabPrint(), vpMatrix::matlabPrint(), vpColVector::operator+(), vpColVector::operator+=(), vpColVector::operator-(), vpColVector::operator-=(), vpForceTwistMatrix::print(), vpVelocityTwistMatrix::print(), vpPoseVector::print(), vpColVector::print(), vpMatrix::print(), and vpMatrix::pseudoInverse().

◆ hadamard() [1/2]

vpColVector vpColVector::hadamard ( const vpColVector & v ) const

inherited

Compute the Hadamard product (element wise vector multiplication).

Parameters

v	: Second vector;

Returns: v1.hadamard(v2) The kronecker product : $v1 \circ v2 = (v1 \circ v2)_{i} = (v1)_{i} (v2)_{i}$

Examples:: testArray2D.cpp.

Definition at line 1425 of file vpColVector.cpp.

References vpCPUFeatures::checkSSE2(), vpArray2D< double >::colNum, vpArray2D< Type >::data, vpArray2D< double >::data, vpException::dimensionError, vpArray2D< double >::dsize, vpArray2D< Type >::getCols(), vpArray2D< Type >::getRows(), vpColVector::resize(), and vpArray2D< double >::rowNum.

◆ hadamard() [2/2]

vpArray2D< double > vpArray2D< double >::hadamard ( const vpArray2D< double > & m ) const

inherited

Compute the Hadamard product (element wise matrix multiplication).

Parameters

m	: Second matrix;

Returns: m1.hadamard(m2) The Hadamard product : $m1 \circ m2 = (m1 \circ m2)_{i,j} = (m1)_{i,j} (m2)_{i,j}$

Examples:: testArray2D.cpp.

Definition at line 690 of file vpArray2D.h.

References vpArray2D< Type >::colNum, vpArray2D< Type >::data, vpException::dimensionError, vpArray2D< Type >::dsize, vpArray2D< Type >::getCols(), vpArray2D< Type >::getRows(), vpArray2D< Type >::resize(), and vpArray2D< Type >::rowNum.

◆ infinityNorm()

double vpColVector::infinityNorm ( ) const

inherited

Compute and return the infinity norm ${||x||}_{\infty} = max\left({\mid x_{i} \mid}\right)$ with $i \in \{0, ..., m-1\}$ where m is the vector size and $x_i$ an element of the vector.

Returns: The infinity norm if the matrix is initialized, 0 otherwise.

See also: euclideanNorm()

Definition at line 1463 of file vpColVector.cpp.

References vpArray2D< double >::rowNum.

Referenced by vpAdaptiveGain::operator()().

◆ init() [1/3]

void vpSubColVector::init	(	vpColVector &	v,
		const unsigned int &	offset,
		const unsigned int &	nrows
	)

Initialize a sub-column vector from a parent column vector.

Parameters

v	: parent column vector.
offset	: offset where the sub-column vector starts in the parent column vector.
nrows	: size of the sub-column vector.

Definition at line 65 of file vpSubColVector.cpp.

References vpArray2D< double >::colNum, vpArray2D< double >::data, vpArray2D< Type >::data, vpException::dimensionError, vpArray2D< double >::dsize, vpException::fatalError, vpArray2D< Type >::getRows(), parent, pRowNum, vpArray2D< double >::rowNum, and vpArray2D< double >::rowPtrs.

◆ init() [2/3]

void vpColVector::init	(	const vpColVector &	v,
		unsigned int	r,
		unsigned int	nrows
	)

inherited

Initialize the column vector from a part of an input column vector v.

Parameters

v	: Input column vector used for initialization.
r	: row index in v that corresponds to the first element of the column vector to contruct.
nrows	: Number of rows of the constructed column vector.

The sub-vector starting from v[r] element and ending on v[r+nrows-1] element is used to initialize the contructed column vector.

The following code shows how to use this function:

#include <visp3/core/vpColVector.h>
int main()
{
  vpColVector v(4);
  int val = 0;
  for(size_t i=0; i<v.getRows(); i++) {
    v[i] = val++;
  }
  std::cout << "v: " << v.t() << std::endl;
  vpColVector w;
  w.init(v, 0, 2);
  std::cout << "w: " << w.t() << std::endl;
}

It produces the following output:

v: 0 1 2 3

w: 1 2

Examples:: testColVector.cpp.

Definition at line 252 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< Type >::getRows(), vpColVector::resize(), and vpArray2D< double >::rowPtrs.

◆ init() [3/3]

vp_deprecated void vpColVector::init ( )

inlineinherited

Deprecated:: Provided only for compat with previous releases. This function does nothing.

Definition at line 306 of file vpColVector.h.

Referenced by vpColVector::vpColVector(), and vpSubColVector().

◆ insert() [1/3]

void vpColVector::insert	(	unsigned int	i,
		const vpColVector &	v
	)

inherited

Insert a column vector.

Parameters

i	: Index of the first element to introduce. This index starts from 0.
v	: Column vector to insert.

The following example shows how to use this function:

#include <visp3/core/vpColVector.h>
int main()
{
  vpColVector v(4);
  for (unsigned int i=0; i < v.size(); i++)
    v[i] = i;
  std::cout << "v: " << v.t() << std::endl;
  vpColVector w(2);
  for (unsigned int i=0; i < w.size(); i++)
    w[i] = i+10;
  std::cout << "w: " << w.t() << std::endl;
  v.insert(1, w);
  std::cout << "v: " << v.t() << std::endl;
}

It produces the following output:

v: 0 1 2 3
w: 10 11
v: 0 10 11 3

Examples:: testColVector.cpp, and testVirtuoseAfma6.cpp.

Definition at line 1199 of file vpColVector.cpp.

References vpArray2D< double >::data, vpArray2D< Type >::data, vpException::dimensionError, vpArray2D< Type >::rowNum, vpArray2D< double >::size(), and vpArray2D< Type >::size().

Referenced by vpMbEdgeKltTracker::computeVVS(), vpMbEdgeMultiTracker::computeVVS(), vpMbDepthDenseTracker::computeVVSInteractionMatrixAndResidu(), vpMbDepthNormalTracker::computeVVSInteractionMatrixAndResidu(), vpMbGenericTracker::computeVVSInteractionMatrixAndResidu(), vpMbKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbKltMultiTracker::computeVVSWeights(), vpMbGenericTracker::computeVVSWeights(), vpMbEdgeMultiTracker::computeVVSWeights(), vpMbEdgeKltMultiTracker::computeVVSWeights(), vpMbEdgeTracker::computeVVSWeights(), vpColVector::insert(), and vpMbGenericTracker::track().

◆ insert() [2/3]

void vpColVector::insert	(	const vpColVector &	v,
		unsigned int	i
	)

inherited

◆ insert() [3/3]

void vpColVector::insert	(	const vpColVector &	v,
		const unsigned int	r,
		const unsigned int	c = `0`
	)

inherited

Deprecated:: You should rather use insert(unsigned int, const vpColVector &).

Insert column vector v at the given position r in the current column vector.

Warning: Throw vpMatrixException::incorrectMatrixSizeError if the dimensions of the matrices do not allow the operation.

Parameters

v	: The column vector to insert.
r	: The index of the row to begin to insert data.
c	: Not used.

Definition at line 1660 of file vpColVector.cpp.

References vpColVector::insert().

◆ invSort()

vpColVector vpColVector::invSort ( const vpColVector & v )

staticinherited

Return a column vector with elements of v that are reverse sorted.

See also: sort()

Definition at line 767 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpException::fatalError, and vpArray2D< Type >::getRows().

◆ load()

static bool vpArray2D< double >::load	(	const std::string &	filename,
		vpArray2D< double > &	A,
		const bool	binary = `false`,
		char *	header = `NULL`
	)

inlinestaticinherited

Load a matrix from a file.

Parameters

filename	: Absolute file name.
A	: Array to be loaded
binary	: If true the matrix is loaded from a binary file, else from a text file.
header	: Header of the file is loaded in this parameter.

Returns: Returns true if success.

See also: save()

Definition at line 318 of file vpArray2D.h.

References vpException::badValue, and vpArray2D< Type >::resize().

◆ loadYAML()

static bool vpArray2D< double >::loadYAML	(	const std::string &	filename,
		vpArray2D< double > &	A,
		char *	header = `NULL`
	)

inlinestaticinherited

Load an array from a YAML-formatted file.

Parameters

filename	: absolute file name.
A	: array to be loaded from the file.
header	: header of the file is loaded in this parameter.

Returns: Returns true on success.

See also: saveYAML()

Definition at line 426 of file vpArray2D.h.

References vpArray2D< Type >::resize().

◆ maplePrint()

std::ostream & vpColVector::maplePrint ( std::ostream & os ) const

inherited

Print using Maple syntax, to copy/paste in Maple later.

The following code

#include <visp3/core/vpColVector.h>
int main()
{
  vpColVector v(3);
  for (unsigned int i=0; i<v.size(); i++)
    v[i] = i;
  std::cout << "v = "; v.maplePrint(std::cout);
}

produces this output:

v = ([
[0, ],
[1, ],
[2, ],
])

that could be copy/paste in Maple.

Definition at line 1583 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

◆ matlabPrint()

std::ostream & vpColVector::matlabPrint ( std::ostream & os ) const

inherited

Print using Matlab syntax, to copy/paste in Matlab later.

The following code

#include <visp3/core/vpColVector.h>
int main()
{
  vpColVector v(3);
  for (unsigned int i=0; i<v.size(); i++)
    v[i] = i;
  std::cout << "v = "; v.matlabPrint(std::cout);
}

produces this output:

v = [ 0, ;
1, ;
2, ]

that could be copy/paste in Matlab:

>> v = [ 0, ;
1, ;
2, ]
v =
    0
    1
    2
>>

Definition at line 1631 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

◆ mean()

double vpColVector::mean ( const vpColVector & v )

staticinherited

Compute the mean value of all the elements of the vector.

Examples:: testColVector.cpp.

Definition at line 940 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpException::dimensionError, vpArray2D< Type >::getRows(), vpArray2D< Type >::size(), and vpColVector::sum().

Referenced by vpColVector::stdev().

◆ median()

double vpColVector::median ( const vpColVector & v )

staticinherited

Compute the median value of all the elements of the vector.

Examples:: testColVector.cpp.

Definition at line 960 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpException::dimensionError, vpMath::getMedian(), vpArray2D< Type >::rowNum, and vpArray2D< Type >::size().

◆ normalize() [1/2]

vpColVector & vpColVector::normalize ( )

inherited

Normalise the vector:

${\bf x}_i = \frac{{\bf x}_i}{\sqrt{\sum_{i=1}^{n}x^2_i}}$

Examples:: testColVector.cpp, and testVirtuoseHapticBox.cpp.

Definition at line 750 of file vpColVector.cpp.

References vpColVector::sumSquare().

Referenced by vpCameraParameters::computeFov(), vpMbtFaceDepthNormal::computeNormalVisibility(), vpMbTracker::createCylinderBBox(), vpMbtDistanceKltPoints::init(), vpMbtPolygon::isVisible(), vpPose::poseDementhonNonPlan(), and vpMbKltTracker::setPose().

◆ normalize() [2/2]

vpColVector & vpColVector::normalize ( vpColVector & x ) const

inherited

Normalise the vector:

${\bf x}_i = \frac{{\bf x}_i}{\sqrt{\sum_{i=1}^{n}x^2_i}}$

Definition at line 736 of file vpColVector.cpp.

References vpColVector::sumSquare().

◆ operator*() [1/3]

double vpColVector::operator* ( const vpColVector & v ) const

inherited

Operator that performs the dot product between two column vectors.

Exceptions

vpException::dimensionError If the vector dimension differ.

See also: dotProd()

Definition at line 146 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< double >::rowNum, vpArray2D< double >::size(), and vpArray2D< Type >::size().

◆ operator*() [2/3]

vpMatrix vpColVector::operator* ( const vpRowVector & v ) const

inherited

Multiply a column vector by a row vector.

Parameters

v	: Row vector.

Returns: The resulting matrix.

Definition at line 170 of file vpColVector.cpp.

References vpArray2D< Type >::getCols(), and vpArray2D< double >::rowNum.

◆ operator*() [3/3]

vpColVector vpColVector::operator* ( const double x ) const

inherited

Operator that allows to multiply each element of a column vector by a scalar.

Parameters

x	: The scalar.

Returns: The column vector multiplied by the scalar. The current column vector (*this) is unchanged.

vpColVector v(3);
v[0] = 1;
v[1] = 2;
v[2] = 3;
vpColVector w = v * 3;
// v is unchanged
// w is now equal to : [3, 6, 9]

Definition at line 387 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpArray2D< double >::data, and vpArray2D< double >::rowNum.

◆ operator*=()

vpColVector & vpColVector::operator*= ( double x )

inherited

Operator that allows to multiply each element of a column vector by a scalar.

Parameters

x	: The scalar.

Returns: The column vector multiplied by the scalar.

vpColVector v(3);
v[0] = 1;
v[1] = 2;
v[2] = 3;
v *= 3;
// v is now equal to : [3, 6, 9]

Definition at line 417 of file vpColVector.cpp.

References vpArray2D< double >::rowNum.

◆ operator+() [1/2]

vpColVector vpColVector::operator+ ( const vpColVector & v ) const

inherited

Operator that allows to add two column vectors.

Definition at line 67 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< Type >::getRows(), vpArray2D< double >::getRows(), and vpArray2D< double >::rowNum.

◆ operator+() [2/2]

vpTranslationVector vpColVector::operator+ ( const vpTranslationVector & t ) const

inherited

Operator that allows to add a column vector to a translation vector.

Parameters

t	: 3-dimension translation vector to add.

Returns: The sum of the current columnn vector (*this) and the translation vector to add.
vpTranslationVector t1(1,2,3);
vpColVector v(3);
v[0] = 4;
v[1] = 5;
v[2] = 6;
vpTranslationVector t2;
t2 = v + t1;
// t1 and v leave unchanged
// t2 is now equal to : 5, 7, 9

Definition at line 100 of file vpColVector.cpp.

References vpException::dimensionError, and vpArray2D< double >::getRows().

◆ operator+=()

vpColVector & vpColVector::operator+= ( vpColVector v )

inherited

Operator that allows to add two column vectors.

Definition at line 115 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< Type >::getRows(), vpArray2D< double >::getRows(), and vpArray2D< double >::rowNum.

◆ operator-() [1/2]

vpColVector vpColVector::operator- ( const vpColVector & v ) const

inherited

operator substraction of two vectors V = A-v

Definition at line 182 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< Type >::getRows(), vpArray2D< double >::getRows(), and vpArray2D< double >::rowNum.

◆ operator-() [2/2]

vpColVector vpColVector::operator- ( void ) const

inherited

Operator that allows to negate all the column vector elements.

vpColVector r(3, 1);
// r contains [1 1 1]^T
vpColVector v = -r;
// v contains [-1 -1 -1]^T

Definition at line 353 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpArray2D< double >::data, vpColVector::resize(), and vpArray2D< double >::rowNum.

◆ operator-=()

vpColVector & vpColVector::operator-= ( vpColVector v )

inherited

Operator that allows to substract two column vectors.

Definition at line 127 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< Type >::getRows(), vpArray2D< double >::getRows(), and vpArray2D< double >::rowNum.

◆ operator/()

vpColVector vpColVector::operator/ ( const double x ) const

inherited

Operator that allows to divide each element of a column vector by a scalar.

Parameters

x	: The scalar.

Returns: The column vector divided by the scalar. The current column vector (*this) is unchanged.

vpColVector v(3);
v[0] = 8;
v[1] = 4;
v[2] = 2;
vpColVector w = v / 2;
// v is unchanged
// w is now equal to : [4, 2, 1]

Definition at line 467 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpArray2D< double >::data, and vpArray2D< double >::rowNum.

◆ operator/=()

vpColVector & vpColVector::operator/= ( double x )

inherited

Operator that allows to divide each element of a column vector by a scalar.

Parameters

x	: The scalar.

Returns: The column vector divided by the scalar.

vpColVector v(3);
v[0] = 8;
v[1] = 4;
v[2] = 2;
v /= 2;
// v is now equal to : [4, 2, 1]

Definition at line 441 of file vpColVector.cpp.

References vpArray2D< double >::rowNum.

◆ operator<<() [1/2]

vpColVector & vpColVector::operator<< ( const vpColVector & v )

inherited

Copy operator. Allows operation such as A << v

#include <visp3/core/vpColVector.h>
int main()
{
  vpColVector A, B(5);
  for (unsigned int i=0; i<B.size(); i++)
    B[i] = i;
  A << B;
  std::cout << "A: " << A.t() << std::endl;
}

In column vector A we get:

A: 0 1 2 3 4

Definition at line 589 of file vpColVector.cpp.

◆ operator<<() [2/2]

vpColVector & vpColVector::operator<< ( double * x )

inherited

Assigment operator. Allow operation such as A = *v

The following example shows how to use this operator.

#include <visp3/core/vpColVector.h>
int main()
{
  size_t n = 5;
  vpColVector A(n);
  double *B = new double [n];
  for (unsigned int i = 0; i < n; i++)
    B[i] = i;
  A << B;
  std::cout << "A: " << A.t() << std::endl;
  delete [] B;
}

It produces the following output:

A: 0 1 2 3 4

Definition at line 619 of file vpColVector.cpp.

References vpArray2D< double >::colNum, vpArray2D< double >::rowNum, and vpArray2D< double >::rowPtrs.

◆ operator=() [1/7]

vpSubColVector & vpSubColVector::operator= ( const vpSubColVector & B )

Allow to initialize a sub-column vector from an other one using operation A = B. Notice that the sub-column vector is not resized to the dimension of B.

Parameters

B	: a sub-column vector.

Definition at line 122 of file vpSubColVector.cpp.

References vpArray2D< double >::data, vpException::dimensionError, vpArray2D< Type >::getRows(), pRowNum, and vpArray2D< double >::rowNum.

◆ operator=() [2/7]

vpSubColVector & vpSubColVector::operator= ( const vpPoseVector & p )

Operator that allows to convert a pose vector into a column vector.

Definition at line 221 of file vpSubColVector.cpp.

References vpArray2D< double >::data, vpArray2D< Type >::data, vpArray2D< Type >::getRows(), vpColVector::resize(), and vpArray2D< double >::rowNum.

◆ operator=() [3/7]

vpSubColVector & vpSubColVector::operator= ( const vpRotationVector & rv )

Operator that allows to convert a rotation vector into a column vector.

Definition at line 204 of file vpSubColVector.cpp.

References vpArray2D< double >::data, vpArray2D< Type >::data, vpArray2D< Type >::getRows(), vpColVector::resize(), and vpArray2D< double >::rowNum.

◆ operator=() [4/7]

vpSubColVector & vpSubColVector::operator= ( const vpTranslationVector & tv )

Operator that allows to convert a translation vector into a column vector.

Definition at line 187 of file vpSubColVector.cpp.

References vpArray2D< double >::data, vpArray2D< Type >::data, vpArray2D< Type >::getRows(), vpColVector::resize(), and vpArray2D< double >::rowNum.

◆ operator=() [5/7]

vpSubColVector & vpSubColVector::operator= ( const vpColVector & B )

Allow to initialize a sub-column vector from a column vector using operation A = B. Notice that the sub-column vector is not resized to the dimension of B.

Parameters

B	: a column vector.

Definition at line 141 of file vpSubColVector.cpp.

References vpArray2D< double >::data, vpException::dimensionError, vpArray2D< Type >::getRows(), and vpArray2D< double >::rowNum.

◆ operator=() [6/7]

vpSubColVector & vpSubColVector::operator= ( const vpMatrix & B )

Allow to initialize a sub-column vector from a m-by-1 matrix using operation A = B. Notice that the sub-column vector is not resized to the dimension of B.

Parameters

B	: a matrix of size m-by-1.

Definition at line 161 of file vpSubColVector.cpp.

References vpArray2D< double >::data, vpException::dimensionError, vpArray2D< Type >::getCols(), vpArray2D< Type >::getRows(), and vpArray2D< double >::rowNum.

◆ operator=() [7/7]

vpSubColVector & vpSubColVector::operator= ( const double & x )

Set all the elements of the sub-column vector to x.

Parameters

x	: a scalar value.

Definition at line 177 of file vpSubColVector.cpp.

References vpArray2D< double >::data, and vpArray2D< double >::rowNum.

◆ operator[]() [1/2]

double& vpColVector::operator[] ( unsigned int n )

inlineinherited

Operator that allows to set a value of an element $v_i$ : v[i] = x.

Definition at line 184 of file vpColVector.h.

References vpArray2D< double >::data.

◆ operator[]() [2/2]

const double& vpColVector::operator[] ( unsigned int n ) const

inlineinherited

Operator that allows to get the value of an element $v_i$ : x = v[i].

Definition at line 186 of file vpColVector.h.

References vpArray2D< double >::data, vpMatrix::operator*(), vpMatrix::operator*=(), vpMatrix::operator+(), vpMatrix::operator+=(), vpMatrix::operator-(), vpMatrix::operator-=(), vpMatrix::operator/(), vpMatrix::operator/=(), vpArray2D< Type >::operator<<, vpArray2D< Type >::operator=(), and vpMatrix::print().

◆ print()

int vpColVector::print	(	std::ostream &	s,
		unsigned int	length,
		char const *	intro = `0`
	)		const

inherited

Pretty print a column vector. The data are tabulated. The common widths before and after the decimal point are set with respect to the parameter maxlen.

Parameters

s	Stream used for the printing.
length	The suggested width of each vector element. The actual width grows in order to accomodate the whole integral part, and shrinks if the whole extent is not needed for all the numbers.
intro	The introduction which is printed before the vector. Can be set to zero (or omitted), in which case the introduction is not printed.

Returns: Returns the common total width for all vector elements.

See also: std::ostream &operator<<(std::ostream &s, const vpArray2D<Type> &A)

Examples:: servoSimu3D_cdMc_CamVelocity.cpp, servoSimu3D_cMcd_CamVelocity.cpp, testColVector.cpp, and testTwistMatrix.cpp.

Definition at line 1228 of file vpColVector.cpp.

References vpArray2D< double >::getRows(), and vpMath::maximum().

◆ rad2deg()

void vpColVector::rad2deg ( )

inlineinherited

Convert a column vector containing angles in radians into degrees.

See also: deg2rad()

Definition at line 225 of file vpColVector.h.

Referenced by vpRobotViper650::setPosition(), vpRobotViper850::setPosition(), vpRobotViper650::setVelocity(), and vpRobotViper850::setVelocity().

◆ reshape() [1/2]

void vpColVector::reshape	(	vpMatrix &	M,
		const unsigned int &	nrows,
		const unsigned int &	ncols
	)

inherited

Reshape the column vector in a matrix.

Parameters

M	: the reshaped matrix.
nrows	: number of rows of the matrix.
ncols	: number of columns of the matrix.

Exceptions

vpException::dimensionError If the matrix and the column vector have not the same size.

The following example shows how to use this method.

#include <visp/vpColVector.h>
int main()
{
  int var=0;
  vpMatrix mat(3, 4);
  for (int i = 0; i < 3; i++)
      for (int j = 0; j < 4; j++)
          mat[i][j] = ++var;
  std::cout << "mat: \n" << mat << std::endl;
  vpColVector col = mat.stackColumns();
  std::cout << "column vector: \n" << col << std::endl;
  vpMatrix remat = col.reshape(3, 4);
  std::cout << "remat: \n" << remat << std::endl;
}

If you run the previous example, you get:

mat:
1  2  3  4
5  6  7  8
9  10  11  12
column vector:
1
5
9
2
6
10
3
7
11
4
8
12
remat:
1  2  3  4
5  6  7  8
9  10  11  12

Definition at line 1153 of file vpColVector.cpp.

References vpArray2D< double >::data, vpException::dimensionError, vpArray2D< double >::dsize, vpArray2D< Type >::getCols(), vpArray2D< Type >::getRows(), vpArray2D< Type >::resize(), and vpArray2D< double >::rowNum.

Referenced by vpColVector::reshape().

◆ reshape() [2/2]

vpMatrix vpColVector::reshape	(	const unsigned int &	nrows,
		const unsigned int &	ncols
	)

inherited

Reshape the column vector in a matrix.

Parameters

nrows	: number of rows of the matrix
ncols	: number of columns of the matrix

Returns: The reshaped matrix.

See also: reshape(vpMatrix &, const unsigned int &, const unsigned int &)

Definition at line 1091 of file vpColVector.cpp.

References vpColVector::reshape().

◆ resize() [1/3]

void vpArray2D< double >::resize	(	const unsigned int	nrows,
		const unsigned int	ncols,
		const bool	flagNullify = `true`,
		const bool	recopy_ = `true`
	)

inlineinherited

Set the size of the array and initialize all the values to zero.

Parameters

nrows	: number of rows.
ncols	: number of column.
flagNullify	: if true, then the array is re-initialized to 0 after resize. If false, the initial values from the common part of the array (common part between old and new version of the array) are kept. Default value is true.
recopy_	: if true, will perform an explicit recopy of the old data if needed and if flagNullify is set to false.

Examples:: testArray2D.cpp, testMatrix.cpp, testMatrixDeterminant.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, and testSvd.cpp.

Definition at line 171 of file vpArray2D.h.

References vpArray2D< Type >::colNum, vpArray2D< Type >::dsize, vpException::memoryAllocationError, vpArray2D< Type >::rowNum, and vpArray2D< Type >::rowPtrs.

Referenced by vpMatrix::diag(), vpMatrix::eye(), vpMatrix::init(), vpMatrix::operator=(), and vpMatrix::stack().

◆ resize() [2/3]

void vpColVector::resize	(	const unsigned int	i,
		const bool	flagNullify = `true`
	)

inlineinherited

Modify the size of the column vector.

Parameters

i	: Size of the vector. This value corresponds to the vector number of rows.
flagNullify	: If true, set the data to zero.

Exceptions

vpException::fatalError When ncols is not equal to 1.

Examples:: moveAfma4.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoViper850Point2DCamVelocityKalman.cpp, testColVector.cpp, testMatrix.cpp, and testThread2.cpp.

Definition at line 241 of file vpColVector.h.

References vpArray2D< Type >::resize().

Referenced by vpMatrix::add2Matrices(), vpPoint::changeFrame(), vpLine::changeFrame(), vpRobotAfma6::checkJointLimits(), vpMbtFaceDepthNormal::computeDesiredFeaturesPCL(), vpMbtFaceDepthNormal::computeDesiredFeaturesSVD(), vpHomography::computeDisplacement(), vpServo::computeError(), vpMbtFaceDepthNormal::computeInteractionMatrix(), vpMbtFaceDepthDense::computeInteractionMatrixAndResidu(), vpMbTracker::computeJTR(), vpMbtFaceDepthNormal::computeNormalVisibility(), vpPoseFeatures::computePose(), vpMbEdgeKltTracker::computeVVS(), vpMbDepthDenseTracker::computeVVSInit(), vpMbDepthNormalTracker::computeVVSInit(), vpMbGenericTracker::computeVVSInit(), vpMbKltMultiTracker::computeVVSInit(), vpMbEdgeMultiTracker::computeVVSInit(), vpMbEdgeKltMultiTracker::computeVVSInit(), vpMbKltTracker::computeVVSInit(), vpMbEdgeTracker::computeVVSInit(), vpFeatureMoment::duplicate(), vpFeatureLuminance::error(), vpMbtFaceDepthNormal::estimateFeatures(), vpMbtFaceDepthNormal::estimatePlaneEquationSVD(), vpThetaUVector::extract(), vpRobotPtu46::getDisplacement(), vpRobotBiclops::getDisplacement(), vpSimulatorAfma6::getDisplacement(), vpRobotAfma4::getDisplacement(), vpSimulatorViper850::getDisplacement(), vpRobotAfma6::getDisplacement(), vpRobotViper650::getDisplacement(), vpRobotViper850::getDisplacement(), vpRobotViper650::getForceTorque(), vpRobotViper850::getForceTorque(), vpAfma6::getInverseKinematics(), vpViper::getInverseKinematicsWrist(), vpPlane::getNormal(), vpRobotPtu46::getPosition(), vpSimulatorCamera::getPosition(), vpRobotCamera::getPosition(), vpSimulatorPioneer::getPosition(), vpSimulatorPioneerPan::getPosition(), vpRobotBiclops::getPosition(), vpSimulatorAfma6::getPosition(), vpRobotAfma4::getPosition(), vpSimulatorViper850::getPosition(), vpRobotAfma6::getPosition(), vpRobotViper650::getPosition(), vpRobotViper850::getPosition(), vpRobotPioneer::getVelocity(), vpRobotPtu46::getVelocity(), vpRobotBiclops::getVelocity(), vpSimulatorAfma6::getVelocity(), vpRobotAfma4::getVelocity(), vpSimulatorViper850::getVelocity(), vpRobotAfma6::getVelocity(), vpRobotViper650::getVelocity(), vpRobotViper850::getVelocity(), vpPoint::getWorldCoordinates(), vpColVector::hadamard(), vpCircle::init(), vpSphere::init(), vpMeTracker::init(), vpPoint::init(), vpFeatureVanishingPoint::init(), vpFeatureEllipse::init(), vpLine::init(), vpFeatureLuminance::init(), vpRobotBiclops::init(), vpKalmanFilter::init(), vpFeatureSegment::init(), vpTemplateTrackerTriangle::init(), vpColVector::init(), vpCylinder::init(), vpFeatureDepth::init(), vpFeaturePoint::init(), vpImageSimulator::init(), vpFeatureMoment::init(), vpFeatureLine::init(), vpRobotAfma4::init(), vpFeaturePoint3D::init(), vpSimulatorAfma6::init(), vpRobotAfma6::init(), vpFeatureThetaU::init(), vpFeaturePointPolar::init(), vpSimulatorViper850::init(), vpFeatureTranslation::init(), vpRobotViper650::init(), vpRobotViper850::init(), vpTemplateTrackerMIESM::initCompInverse(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpMbtDistanceCircle::initInteractionMatrixError(), vpMbtDistanceLine::initInteractionMatrixError(), vpMbtDistanceCylinder::initInteractionMatrixError(), vpMbEdgeKltMultiTracker::initMbtTracking(), vpRobust::MEstimator(), vpMatrix::multMatrixVector(), vpColVector::operator-(), operator=(), vpColVector::operator=(), vpPose::poseDementhonNonPlan(), vpPose::poseVirtualVSrobust(), vpPoint::projection(), vpLine::projection(), vpMatrix::pseudoInverse(), vpSimulatorAfma6::readPosFile(), vpRobotAfma4::readPosFile(), vpSimulatorViper850::readPosFile(), vpRobotAfma6::readPosFile(), vpRobotViper650::readPosFile(), vpRobotViper850::readPosFile(), vpRobotPtu46::readPositionFile(), vpRobotBiclops::readPositionFile(), vpRobust::resize(), vpColVector::stack(), vpMatrix::stackColumns(), vpMatrix::sub2Matrices(), vpMbGenericTracker::track(), vpMbEdgeKltTracker::trackFirstLoop(), vpFeatureMoment::update(), vpGenericFeature::vpGenericFeature(), vpImageSimulator::vpImageSimulator(), vpRobotWireFrameSimulator::vpRobotWireFrameSimulator(), vpRobust::vpRobust(), vpSickLDMRS::vpSickLDMRS(), vpTemplateTracker::vpTemplateTracker(), vpTemplateTrackerMI::vpTemplateTrackerMI(), vpTemplateTrackerSSD::vpTemplateTrackerSSD(), vpTemplateTrackerSSDESM::vpTemplateTrackerSSDESM(), vpTemplateTrackerZNCC::vpTemplateTrackerZNCC(), and vpViper::vpViper().

◆ resize() [3/3]

void vpColVector::resize	(	const unsigned int	nrows,
		const unsigned int	ncols,
		const bool	flagNullify
	)

inlineinherited

Resize the column vector to a nrows-dimension vector. This function can only be used with ncols = 1.

Parameters

nrows	: Vector number of rows. This value corresponds to the size of the vector.
ncols	: Vector number of columns. This value should be set to 1.
flagNullify	: If true, set the data to zero.

Exceptions

vpException::fatalError When ncols is not equal to 1.

Definition at line 252 of file vpColVector.h.

References vpException::fatalError, vpArray2D< Type >::resize(), vpMatrix::stack(), vpMatrix::sum(), vpMatrix::sumSquare(), vpMatrix::t(), and vpMatrix::transpose().

◆ rows()

vp_deprecated vpColVector vpColVector::rows	(	unsigned int	first_row,
		unsigned int	last_row
	)		const

inlineinherited

Deprecated:: You should rather use extract().

Definition at line 310 of file vpColVector.h.

References vpMatrix::setIdentity().

◆ save()

static bool vpArray2D< double >::save	(	const std::string &	filename,
		const vpArray2D< double > &	A,
		const bool	binary = `false`,
		const char *	header = `""`
	)

inlinestaticinherited

Save a matrix to a file.

Parameters

filename	: Absolute file name.
A	: Array to be saved.
binary	: If true the matrix is saved in a binary file, else a text file.
header	: Optional line that will be saved at the beginning of the file.

Returns: Returns true if success.

Warning : If you save the matrix as in a text file the precision is less than if you save it in a binary file.

See also: load()

Definition at line 508 of file vpArray2D.h.

References vpArray2D< Type >::getCols(), and vpArray2D< Type >::getRows().

◆ saveYAML()

static bool vpArray2D< double >::saveYAML	(	const std::string &	filename,
		const vpArray2D< double > &	A,
		const char *	header = `""`
	)

inlinestaticinherited

Save an array in a YAML-formatted file.

Parameters

filename	: absolute file name.
A	: array to be saved in the file.
header	: optional lines that will be saved at the beginning of the file. Should be YAML-formatted and will adapt to the indentation if any.

Returns: Returns true if success.

Here is an example of outputs.

vpArray2D<double> M(3,4);
vpArray2D::saveYAML("matrix.yml", M, "example: a YAML-formatted header");
vpArray2D::saveYAML("matrixIndent.yml", M, "example:\n    - a YAML-formatted
header\n    - with inner indentation"); 

Content of matrix.yml:

example: a YAML-formatted header
rows: 3
cols: 4
data:
  - [0, 0, 0, 0]
  - [0, 0, 0, 0]
  - [0, 0, 0, 0]

Content of matrixIndent.yml:

example:
    - a YAML-formatted header
    - with inner indentation
rows: 3
cols: 4
data:
    - [0, 0, 0, 0]
    - [0, 0, 0, 0]
    - [0, 0, 0, 0]

See also: loadYAML()

Definition at line 597 of file vpArray2D.h.

References vpArray2D< Type >::getCols(), and vpArray2D< Type >::getRows().

◆ setIdentity()

vp_deprecated void vpColVector::setIdentity ( const double & val = 1.0 )

inherited

Deprecated:: You should rather use eye()

◆ size()

unsigned int vpArray2D< double >::size ( ) const

inlineinherited

Return the number of elements of the 2D array.

Examples:: testColVector.cpp, testDisplacement.cpp, testMatrix.cpp, testPoseVector.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, testRowVector.cpp, testThread2.cpp, testTranslationVector.cpp, testTukeyEstimator.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, and tutorial-ibvs-4pts-wireframe-robot-viper.cpp.

Definition at line 158 of file vpArray2D.h.

References vpArray2D< Type >::rowNum.

Referenced by vpRowVector::insert(), vpColVector::insert(), vpColVector::operator*(), and vpMatrix::stack().

◆ skew()

vpMatrix vpColVector::skew ( const vpColVector & v )

staticinherited

Compute the skew symmetric matrix $[{\bf v}]_\times$ of vector v.

$\mbox{if} \quad {\bf V} = \left( \begin{array}{c} x \\ y \\ z \end{array}\right), \quad \mbox{then} \qquad [{\bf v}]_\times = \left( \begin{array}{ccc} 0 & -z & y \\ z & 0 & -x \\ -y & x & 0 \end{array}\right)$

Parameters

v	: Input vector used to compute the skew symmetric matrix.

Examples:: servoSimu3D_cMcd_CamVelocityWithoutVpServo.cpp, and testVirtuoseHapticBox.cpp.

Definition at line 1039 of file vpColVector.cpp.

References vpException::dimensionError, vpArray2D< Type >::getRows(), and vpArray2D< Type >::resize().

Referenced by vpCalibration::calibrationTsai(), vpMatrix::computeCovarianceMatrixVVS(), vpColVector::crossProd(), and vpFeatureThetaU::interaction().

◆ sort()

vpColVector vpColVector::sort ( const vpColVector & v )

staticinherited

Return a column vector with elements of v that are sorted.

See also: invSort()

Definition at line 796 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpException::fatalError, and vpArray2D< Type >::getRows().

◆ stack() [1/4]

void vpColVector::stack ( const double & d )

inherited

Stack column vector with a new element at the end of the vector.

Parameters

d	: Element to stack to the existing vector.

vpColVector v(3, 1);
// v is equal to [1 1 1]^T
v.stack(-2);
// v is equal to [1 1 1 -2]^T

See also: stack(const vpColVector &, const vpColVector &); stack(const vpColVector &, const vpColVector &, vpColVector &)

Examples:: servoPioneerPoint2DDepthWithoutVpServo.cpp, and testColVector.cpp.

Definition at line 837 of file vpColVector.cpp.

References vpColVector::resize(), and vpArray2D< double >::rowNum.

◆ stack() [2/4]

void vpColVector::stack ( const vpColVector & v )

inherited

Stack column vectors.

Parameters

v	: Vector to stack to the existing one.

vpColVector v1(3, 1);
// v1 is equal to [1 1 1]^T
vpColVector v2(2, 3);
// v2 is equal to [3 3]^T
v1.stack(v2);
// v1 is equal to [1 1 1 3 3]^T

See also: stack(const vpColVector &, const double &); stack(const vpColVector &, const vpColVector &); stack(const vpColVector &, const vpColVector &, vpColVector &)

Definition at line 862 of file vpColVector.cpp.

References vpColVector::stack().

◆ stack() [3/4]

vpColVector vpColVector::stack	(	const vpColVector &	A,
		const vpColVector &	B
	)

staticinherited

Stack column vectors.

Parameters

A	: Initial vector.
B	: Vector to stack at the end of A.

Returns: Stacked vector .

vpColVector A(3);
vpColVector B(5);
vpColVector C;
C = vpColVector::stack(A, B); // C = [A B]T
// C is now an 8 dimension column vector

See also: stack(const vpColVector &); stack(const vpColVector &, const vpColVector &, vpColVector &)

Definition at line 882 of file vpColVector.cpp.

References vpColVector::stack().

◆ stack() [4/4]

void vpColVector::stack	(	const vpColVector &	A,
		const vpColVector &	B,
		vpColVector &	C
	)

staticinherited

Stack column vectors.

Parameters

A	: Initial vector.
B	: Vector to stack at the end of A.
C	: Resulting stacked vector .

vpColVector A(3);
vpColVector B(5);
vpColVector C;
vpColVector::stack(A, B, C); // C = [A B]T
// C is now an 8 dimension column vector

See also: stack(const vpColVector &); stack(const vpColVector &, const vpColVector &)

Definition at line 907 of file vpColVector.cpp.

References vpArray2D< Type >::getRows(), and vpColVector::resize().

◆ stackMatrices() [1/3]

vp_deprecated void vpColVector::stackMatrices ( const vpColVector & r )

inlineinherited

Deprecated:: You should rather use stack(const vpColVector &)

Definition at line 321 of file vpColVector.h.

References vpMatrix::stack().

◆ stackMatrices() [2/3]

static vp_deprecated vpColVector vpColVector::stackMatrices	(	const vpColVector &	A,
		const vpColVector &	B
	)

inlinestaticinherited

Deprecated:: You should rather use stack(const vpColVector &A, const vpColVector &B)

Definition at line 326 of file vpColVector.h.

References vpMatrix::stack().

◆ stackMatrices() [3/3]

static vp_deprecated void vpColVector::stackMatrices	(	const vpColVector &	A,
		const vpColVector &	B,
		vpColVector &	C
	)

inlinestaticinherited

Deprecated:: You should rather use stack(const vpColVector &A, const vpColVector &B, vpColVector &C)

Definition at line 331 of file vpColVector.h.

References vpMatrix::insert(), vpMatrix::operator*(), and vpMatrix::stack().

◆ stdev()

double vpColVector::stdev	(	const vpColVector &	v,
		const bool	useBesselCorrection = `false`
	)

staticinherited

Compute the standard deviation value of all the elements of the vector.

Examples:: testColVector.cpp.

Definition at line 974 of file vpColVector.cpp.

References vpCPUFeatures::checkSSE2(), vpArray2D< Type >::data, vpException::dimensionError, vpArray2D< Type >::getRows(), vpColVector::mean(), and vpArray2D< Type >::size().

◆ sum()

double vpColVector::sum ( ) const

inherited

Return the sum of all the elements $v_{i}$ of the column vector v(m).

Returns: The value
$\sum{i=0}^{m} v_i$
.

Examples:: testColVector.cpp, and testThread2.cpp.

Definition at line 1317 of file vpColVector.cpp.

References vpCPUFeatures::checkSSE2(), vpArray2D< double >::data, and vpArray2D< double >::rowNum.

Referenced by vpColVector::mean().

◆ sumSquare()

double vpColVector::sumSquare ( ) const

inherited

Return the sum square of all the elements $v_{i}$ of the column vector v(m).

Returns: The value
$\sum{i=0}^{m} v_i^{2}$
.

Examples:: photometricVisualServoing.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoMomentImage.cpp, testColVector.cpp, testImageResize.cpp, tutorial-simu-pioneer-continuous-gain-adaptive.cpp, tutorial-simu-pioneer-continuous-gain-constant.cpp, tutorial-simu-pioneer-pan.cpp, and tutorial-simu-pioneer.cpp.

Definition at line 1360 of file vpColVector.cpp.

References vpCPUFeatures::checkSSE2(), vpArray2D< double >::data, and vpArray2D< double >::rowNum.

Referenced by vpPose::calculArbreDementhon(), vpCalibration::calibrationTsai(), vpMatrix::computeCovarianceMatrixVVS(), vpPoseFeatures::computePose(), vpMbTracker::computeVVSCheckLevenbergMarquardt(), vpPose::coplanar(), vpFeatureDepth::error(), vpFeatureThetaU::error(), vpFeatureTranslation::error(), vpColVector::euclideanNorm(), vpMbTracker::extractCylinders(), vpFeatureThetaU::interaction(), vpMatrix::kernel(), vpColVector::normalize(), vpPose::poseDementhonNonPlan(), vpPose::poseDementhonPlan(), vpPose::poseFromRectangle(), vpPose::poseLagrangeNonPlan(), vpPose::poseLagrangePlan(), vpPose::poseVirtualVS(), vpPose::poseVirtualVSrobust(), vpServoData::save(), vpSimulatorAfma6::setPosition(), and vpSimulatorViper850::setPosition().

◆ t()

vpRowVector vpColVector::t ( ) const

inherited

Transpose the column vector. The resulting vector becomes a row vector.

Examples:: moveAfma4.cpp, movePtu46.cpp, servoAfma6Ellipse2DCamVelocity.cpp, servoBiclopsPoint2DArtVelocity.cpp, servoPtu46Point2DArtVelocity.cpp, servoSimu3D_cdMc_CamVelocity.cpp, servoSimu3D_cMcd_CamVelocity.cpp, servoSimu3D_cMcd_CamVelocityWithoutVpServo.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuSphere2DCamVelocitySecondaryTask.cpp, testColVector.cpp, testComedi.cpp, testDisplacement.cpp, testForceTorqueAti.cpp, testKalmanAcceleration.cpp, testKalmanVelocity.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, testRobotViper850.cpp, testVirtuose.cpp, testVirtuoseAfma6.cpp, testVirtuosePeriodicFunction.cpp, tutorial-homography-from-points.cpp, and tutorial-pioneer-robot.cpp.

Definition at line 666 of file vpColVector.cpp.

References vpArray2D< Type >::data, vpArray2D< double >::data, and vpArray2D< double >::rowNum.

Referenced by vpPose::calculArbreDementhon(), vpHomography::computeDisplacement(), vpMbtFaceDepthDense::computeInteractionMatrixAndResidu(), vpServo::computeProjectionOperators(), vpRobotBiclops::getPosition(), vpRobotBiclops::getVelocity(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpSimulatorAfma6::initialiseCameraRelativeToObject(), vpSimulatorViper850::initialiseCameraRelativeToObject(), vpHomography::load(), vpPose::poseDementhonPlan(), vpForwardProjection::print(), vpServo::print(), vpPose::printPoint(), vpServoData::save(), vpRobotBiclops::setVelocity(), vpRobotViper650::setVelocity(), vpRobotViper850::setVelocity(), vpTemplateTrackerSSDForwardAdditional::trackNoPyr(), vpTemplateTrackerMIForwardAdditional::trackNoPyr(), vpTemplateTrackerMIInverseCompositional::trackNoPyr(), and vpColVector::transpose().

◆ transpose() [1/2]

vpRowVector vpColVector::transpose ( ) const

inherited

Transpose the column vector. The resulting vector becomes a row vector.

See also: t()

Definition at line 677 of file vpColVector.cpp.

References vpColVector::t().

◆ transpose() [2/2]

void vpColVector::transpose ( vpRowVector & v ) const

inherited

Transpose the column vector. The resulting vector v becomes a row vector.

See also: t()

Definition at line 683 of file vpColVector.cpp.

References vpColVector::t().

Friends And Related Function Documentation

◆ operator*()

vpColVector operator*	(	const double &	x,
		const vpColVector &	v
	)

Definition at line 689 of file vpColVector.cpp.

◆ vpGEMM()

void vpGEMM	(	const vpArray2D< double > &	A,
		const vpArray2D< double > &	B,
		const double &	alpha,
		const vpArray2D< double > &	C,
		const double &	beta,
		vpArray2D< double > &	D,
		const unsigned int &	ops = `0`
	)

For example, to compute D = alpha*A^T*B^T+beta*C we need to call :

vpGEMM(A, B, alpha, C, beta, D, VP_GEMM_A_T + VP_GEMM_B_T);

If C is not used, vpGEMM must be called using an empty array null. Thus to compute D = alpha*A^T*B, we have to call:

vpGEMM(A, B, alpha, null, 0, D, VP_GEMM_B_T);

Exceptions

vpException::incorrectMatrixSizeError if the sizes of the matrices do not allow the operations.

Parameters

A	: An array that could be a vpMatrix.
B	: An array that could be a vpMatrix.
alpha	: A scalar.
C	: An array that could be a vpMatrix.
beta	: A scalar.
D	: The resulting array that could be a vpMatrix.
ops	: A scalar describing operation applied on the matrices. Possible values are the one defined in vpGEMMmethod(): VP_GEMM_A_T, VP_GEMM_B_T, VP_GEMM_C_T.

Definition at line 393 of file vpGEMM.h.

References vpException::functionNotImplementedError.

◆ vpGEMMmethod

enum vpGEMMmethod

Operations are :

VP_GEMM_A_T to use the transpose matrix of A instead of the matrix A
VP_GEMM_B_T to use the transpose matrix of B instead of the matrix B
VP_GEMM_C_T to use the transpose matrix of C instead of the matrix C

Definition at line 57 of file vpGEMM.h.

Member Data Documentation

◆ colNum

unsigned int vpArray2D< double >::colNum

protectedinherited

Number of columns in the array.

Definition at line 76 of file vpArray2D.h.

◆ data

double * vpArray2D< double >::data

inherited

Address of the first element of the data array.

Examples:: testArray2D.cpp, testDisplacement.cpp, testMatrix.cpp, testPoseVector.cpp, and testTranslationVector.cpp.

Definition at line 84 of file vpArray2D.h.

Referenced by vpMatrix::AtA(), vpHomogeneousMatrix::buildFrom(), vpThetaUVector::buildFrom(), vpRzyzVector::buildFrom(), vpRxyzVector::buildFrom(), vpRzyxVector::buildFrom(), checkParentStatus(), vpSubRowVector::checkParentStatus(), vpSubMatrix::checkParentStatus(), vpColVector::clear(), vpHomogeneousMatrix::convert(), vpMatrix::detByLU(), vpTranslationVector::euclideanNorm(), vpRowVector::euclideanNorm(), vpMatrix::euclideanNorm(), vpMatrix::expm(), vpThetaUVector::extract(), vpMatrix::getRow(), vpThetaUVector::getTheta(), vpThetaUVector::getU(), vpColVector::hadamard(), vpMatrix::hadamard(), init(), vpSubRowVector::init(), vpSubMatrix::init(), vpColVector::insert(), vpMatrix::insert(), vpMatrix::inverseByCholesky(), vpTranslationVector::operator*(), vpRowVector::operator*(), vpColVector::operator*(), vpHomography::operator*(), vpMatrix::operator*(), vpTranslationVector::operator-(), vpRowVector::operator-(), vpColVector::operator-(), vpTranslationVector::operator/(), vpRowVector::operator/(), vpColVector::operator/(), vpHomography::operator/(), vpHomography::operator/=(), operator=(), vpSubRowVector::operator=(), vpQuaternionVector::operator=(), vpTranslationVector::operator=(), vpRowVector::operator=(), vpRzyzVector::operator=(), vpRxyzVector::operator=(), vpRzyxVector::operator=(), vpColVector::operator=(), vpThetaUVector::operator=(), vpMatrix::operator=(), vpColVector::operator[](), vpRowVector::reshape(), vpColVector::reshape(), vpQuaternionVector::set(), vpMatrix::stack(), vpMatrix::stackRows(), vpColVector::sum(), vpColVector::sumSquare(), vpRotationVector::t(), vpTranslationVector::t(), vpPoseVector::t(), vpRowVector::t(), vpColVector::t(), vpColVector::vpColVector(), vpMatrix::vpMatrix(), vpQuaternionVector::vpQuaternionVector(), vpRxyzVector::vpRxyzVector(), vpRzyxVector::vpRzyxVector(), vpRzyzVector::vpRzyzVector(), vpThetaUVector::vpThetaUVector(), vpQuaternionVector::w(), vpQuaternionVector::x(), vpQuaternionVector::y(), vpQuaternionVector::z(), ~vpSubColVector(), vpSubMatrix::~vpSubMatrix(), and vpSubRowVector::~vpSubRowVector().

◆ dsize

unsigned int vpArray2D< double >::dsize

protectedinherited

◆ parent

vpColVector* vpSubColVector::parent

protected

Parent vpColvector.

Definition at line 73 of file vpSubColVector.h.

Referenced by checkParentStatus(), and init().

◆ pRowNum

unsigned int vpSubColVector::pRowNum

protected

Number of row of parent vpColvector at initialization.

Definition at line 71 of file vpSubColVector.h.

Referenced by checkParentStatus(), init(), and operator=().

◆ rowNum

unsigned int vpArray2D< double >::rowNum

protectedinherited

Number of rows in the array.

Definition at line 74 of file vpArray2D.h.

◆ rowPtrs

double ** vpArray2D< double >::rowPtrs

protectedinherited

Address of the first element of each rows.

Definition at line 78 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpColVector::clear(), vpMatrix::infinityNorm(), init(), vpSubRowVector::init(), vpSubMatrix::init(), vpRowVector::init(), vpColVector::init(), vpMatrix::init(), vpRotationMatrix::operator*(), vpForceTwistMatrix::operator*(), vpVelocityTwistMatrix::operator*(), vpHomogeneousMatrix::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*=(), vpMatrix::operator*=(), vpMatrix::operator+=(), vpMatrix::operator-=(), vpMatrix::operator/(), vpMatrix::operator/=(), vpMatrix::operator<<(), vpColVector::operator<<(), vpSubMatrix::operator=(), vpRotationMatrix::operator=(), vpHomogeneousMatrix::operator=(), vpForceTwistMatrix::operator=(), vpVelocityTwistMatrix::operator=(), vpRowVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpMatrix::stackColumns(), vpRowVector::sum(), vpMatrix::sum(), vpRotationVector::sumSquare(), vpTranslationVector::sumSquare(), vpRowVector::sumSquare(), vpMatrix::sumSquare(), vpMatrix::transpose(), vpColVector::vpColVector(), and vpMatrix::vpMatrix().

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Related Functions

Deprecated functions

Detailed Description

Constructor & Destructor Documentation

◆ vpSubColVector() [1/2]

◆ vpSubColVector() [2/2]

◆ ~vpSubColVector()

Member Function Documentation

◆ checkParentStatus()

◆ clear()

◆ cppPrint()

◆ cross()

◆ crossProd()

◆ csvPrint()

◆ deg2rad()

◆ dotProd()

◆ euclideanNorm()

◆ extract()

◆ getCols()

◆ getMaxValue()

◆ getMinValue()

◆ getRows()

◆ hadamard() [1/2]

◆ hadamard() [2/2]

◆ infinityNorm()

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ invSort()

◆ load()

◆ loadYAML()

◆ maplePrint()

◆ matlabPrint()

◆ mean()

◆ median()

◆ normalize() [1/2]

◆ normalize() [2/2]

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator=() [1/7]

◆ operator=() [2/7]

◆ operator=() [3/7]

◆ operator=() [4/7]

◆ operator=() [5/7]

◆ operator=() [6/7]

◆ operator=() [7/7]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ rad2deg()

◆ reshape() [1/2]

◆ reshape() [2/2]

◆ resize() [1/3]

◆ resize() [2/3]

◆ resize() [3/3]

◆ rows()

◆ save()

◆ saveYAML()

◆ setIdentity()

◆ size()

◆ skew()