#include <vpRowVector.h>

Inheritance diagram for vpRowVector:

Public Member Functions
	vpRowVector ()

	vpRowVector (unsigned int n)

	vpRowVector (unsigned int n, double val)

	vpRowVector (const vpRowVector &v)

	vpRowVector (const vpRowVector &v, unsigned int c, unsigned int ncols)

	vpRowVector (const vpMatrix &M)

	vpRowVector (const vpMatrix &M, unsigned int i)

	vpRowVector (const std::vector< double > &v)

	vpRowVector (const std::vector< float > &v)

	vpRowVector (vpRowVector &&v)

	vpRowVector (const std::initializer_list< double > &list)

virtual	~vpRowVector ()

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

vp_deprecated double	euclideanNorm () const

vpRowVector	extract (unsigned int c, unsigned int rowsize) const

double	frobeniusNorm () const

void	init (const vpRowVector &v, unsigned int c, unsigned int ncols)

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

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

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

vpRowVector &	normalize ()

vpRowVector &	normalize (vpRowVector &x) const

double &	operator[] (unsigned int n)

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

vpRowVector &	operator= (const vpRowVector &v)

vpRowVector &	operator= (const vpMatrix &M)

vpRowVector &	operator= (const std::vector< double > &v)

vpRowVector &	operator= (const std::vector< float > &v)

vpRowVector &	operator= (double x)

vpRowVector &	operator= (vpRowVector &&v)

vpRowVector &	operator= (const std::initializer_list< double > &list)

bool	operator== (const vpRowVector &v) const

bool	operator!= (const vpRowVector &v) const

double	operator* (const vpColVector &x) const

vpRowVector	operator* (const vpMatrix &M) const

vpRowVector	operator* (double x) const

vpRowVector &	operator*= (double x)

vpRowVector	operator/ (double x) const

vpRowVector &	operator/= (double x)

vpRowVector	operator+ (const vpRowVector &v) const

vpRowVector &	operator+= (vpRowVector v)

vpRowVector	operator- (const vpRowVector &v) const

vpRowVector &	operator-= (vpRowVector v)

vpRowVector	operator- () const

vpRowVector &	operator<< (const vpRowVector &v)

vpRowVector &	operator<< (double val)

vpRowVector &	operator, (double val)

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 (unsigned int nrows, unsigned int ncols)

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

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

void	stack (double d)

void	stack (const vpRowVector &v)

double	sum () const

double	sumSquare () const

vpColVector	t () const

std::vector< double >	toStdVector ()

vpColVector	transpose () const

void	transpose (vpColVector &v) const

Inherited functionalities from vpArray2D
unsigned int	getCols () const

double	getMaxValue () const

double	getMinValue () const

unsigned int	getRows () const

unsigned int	size () const

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

bool	operator== (const vpArray2D< double > &A) const

bool	operator!= (const vpArray2D< double > &A) const

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

Static Public Member Functions
static double	mean (const vpRowVector &v)

static double	median (const vpRowVector &v)

static vpRowVector	stack (const vpRowVector &A, const vpRowVector &B)

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

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

Inherited I/O from vpArray2D with Static Public Member Functions
static bool	load (const std::string &filename, vpArray2D< double > &A, 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, 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	rowNum

unsigned int	colNum

double **	rowPtrs

unsigned int	dsize

Related Functions
(Note that these are not member functions.)
enum	vpGEMMmethod

Deprecated functions
vp_deprecated void	init ()

vp_deprecated void	stackMatrices (const vpRowVector &r)

vp_deprecated void	setIdentity (const double &val=1.0)

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

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

Detailed Description

Implementation of row vector and the associated operations.

This class provides a data structure for a row vector that contains values of double. It contains also some functions to achieve a set of operations on these vectors.

The vpRowVector class is derived from vpArray2D<double>.

The code below shows how to create a 3-element row vector of doubles, set the element values and access them:

#include <visp3/code/vpRowVector.h
int main()
{
  vpRowVector v(3);
  v[0] = -1; v[1] = -2.1; v[2] = -3;
  std::cout << "v:" << std::endl;
  for (unsigned int i = 0; i < v.size(); i++) {
    std::cout << v[i] << " ";
  }
  std::cout << std::endl;
}

Once build, this previous code produces the following output:

v:

-1 -2.1 -3

If ViSP is build with c++11 enabled, you can do the same using:

#include <visp3/code/vpRowVector.h
int main()
{
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  vpRowVector v{-1, -2.1, -3};
  std::cout << "v:\n" << v << std::endl;
#endif
}

The vector could also be initialized using operator=(const std::initializer_list< double > &)

int main()
{
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  vpRowVector v;
  v = {-1, -2.1, -3};
#endif
}

Examples:: testArray2D.cpp, testEigenConversion.cpp, testMatrix.cpp, testMatrixInitialization.cpp, and testRowVector.cpp.

Definition at line 115 of file vpRowVector.h.

Constructor & Destructor Documentation

vpRowVector::vpRowVector ( )

inline

Basic constructor that creates an empty 0-size row vector.

Definition at line 119 of file vpRowVector.h.

vpRowVector::vpRowVector ( unsigned int n )

inlineexplicit

Construct a row vector of size n. All the elements are initialized to zero.

Definition at line 122 of file vpRowVector.h.

vpRowVector::vpRowVector	(	unsigned int	n,
		double	val
	)

inline

Construct a row vector of size n. Each element is set to val.

Definition at line 124 of file vpRowVector.h.

vpRowVector::vpRowVector ( const vpRowVector & v )

inline

Copy constructor that allows to construct a row vector from an other one.

Definition at line 127 of file vpRowVector.h.

vpRowVector::vpRowVector	(	const vpRowVector &	v,
		unsigned int	c,
		unsigned int	ncols
	)

Construct a row vector from a part of an input row vector v.

Parameters

v	: Input row vector used for initialization.
c	: column index in v that corresponds to the first element of the row vector to contruct.
ncols	: Number of columns of the constructed row vector.

The sub-vector starting from v[c] element and ending on v[c+ncols-1] element is used to initialize the contructed row vector.

See also: init()

Definition at line 581 of file vpRowVector.cpp.

References init().

vpRowVector::vpRowVector ( const vpMatrix & M )

Constructor that creates a row vector from a 1-by-n matrix M.

Exceptions

vpException::dimensionError If the matrix is not a 1-by-n matrix.

Definition at line 540 of file vpRowVector.cpp.

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

vpRowVector::vpRowVector	(	const vpMatrix &	M,
		unsigned int	i
	)

Constructor that creates a row vector corresponding to row i of matrix M.

Definition at line 529 of file vpRowVector.cpp.

References vpArray2D< Type >::getCols().

vpRowVector::vpRowVector ( const std::vector< double > & v )

Constructor that creates a row vector from a std vector of double.

Definition at line 554 of file vpRowVector.cpp.

vpRowVector::vpRowVector ( const std::vector< float > & v )

Constructor that creates a row vector from a std vector of float.

Definition at line 562 of file vpRowVector.cpp.

vpRowVector::vpRowVector ( vpRowVector && v )

Definition at line 587 of file vpRowVector.cpp.

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

vpRowVector::vpRowVector ( const std::initializer_list< double > & list )

inline

Definition at line 135 of file vpRowVector.h.

virtual vpRowVector::~vpRowVector ( )

inlinevirtual

Destructor.

Definition at line 140 of file vpRowVector.h.

Member Function Documentation

void vpRowVector::clear ( )

inline

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

Examples:: testRowVector.cpp.

Definition at line 146 of file vpRowVector.h.

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

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

Parameters

os	: the stream to be printed in.
matrixName	: name of the row 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/vpRowVector.h>
int main()
{
  vpRowVector r(3);
  for (unsigned int i=0; i<r.size(); i++)
    r[i] = i;
  r.cppPrint(std::cout, "r");
}

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

vpRowVector r (3);
r[0] = 0;
r[1] = 1;
r[2] = 2;

Definition at line 1196 of file vpRowVector.cpp.

References vpArray2D< double >::getCols().

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

Print/save a row vector in csv format.

The following code

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

produces log.csv file that contains:

0, 1, 2

Definition at line 1238 of file vpRowVector.cpp.

References vpArray2D< double >::getCols().

void vpRowVector::deg2rad ( )

inline

Convert a column vector containing angles in degrees into radians.

See also: rad2deg()

Definition at line 167 of file vpRowVector.h.

double vpRowVector::euclideanNorm ( ) const

Deprecated:: This function is deprecated. You should rather use frobeniusNorm().

Compute and return the Euclidean norm also called Fronebius norm $||v|| = \sqrt{ \sum{v_{i}^2}}$ .

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

See also: frobeniusNorm()

Definition at line 1100 of file vpRowVector.cpp.

References frobeniusNorm().

vpRowVector vpRowVector::extract	(	unsigned int	c,
		unsigned int	rowsize
	)		const

inline

Extract a sub-row vector from a row vector.

Parameters

c	: Index of the column corresponding to the first element of the vector to extract.
rowsize	: Size of the vector to extract.

Exceptions

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

vpRowVector r1;
for (unsigned int i=0; i<4; i++)
  r1.stack(i);
// r1 is equal to [0 1 2 3]
vpRowVector r2 = r1.extract(1, 3);
// r2 is equal to [1 2 3]

Examples:: testRowVector.cpp.

Definition at line 191 of file vpRowVector.h.

References vpException::fatalError.

double vpRowVector::frobeniusNorm ( ) const

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

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

Definition at line 1110 of file vpRowVector.cpp.

References sumSquare().

Referenced by euclideanNorm().

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, testAprilTag.cpp, testColVector.cpp, testDisplacement.cpp, testImageFilter.cpp, testMatrix.cpp, testMatrixConditionNumber.cpp, testMatrixConvolution.cpp, testMatrixDeterminant.cpp, testMatrixInitialization.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseVector.cpp, testRowVector.cpp, testSvd.cpp, testTranslationVector.cpp, and tutorial-matlab.cpp.

Definition at line 279 of file vpArray2D.h.

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

Referenced by vpMatrix::cond(), cppPrint(), vpMatrix::cppPrint(), csvPrint(), vpMatrix::csvPrint(), vpMatrix::detByLUEigen3(), vpMatrix::extract(), vpRotationMatrix::getCol(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpMatrix::inducedL2Norm(), vpMatrix::inverseByLUEigen3(), vpMatrix::inverseByQRLapack(), vpRotationMatrix::isARotationMatrix(), vpMatrix::kernel(), maplePrint(), vpMatrix::maplePrint(), matlabPrint(), vpMatrix::matlabPrint(), vpMatrix::nullSpace(), operator*(), operator+(), operator+=(), operator-(), operator-=(), vpForceTwistMatrix::print(), vpVelocityTwistMatrix::print(), print(), vpMatrix::print(), vpMatrix::pseudoInverse(), vpMatrix::row(), vpMatrix::svdEigen3(), vpMatrix::svdLapack(), and vpMatrix::svdOpenCV().

double vpArray2D< double >::getMaxValue ( ) const

inherited

Return the array max value.

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

double vpArray2D< double >::getMinValue ( ) const

inherited

Return the array min value.

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

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

inlineinherited

Return the number of rows of the 2D array.

See also: getCols(), size()

Examples:: mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, testAprilTag.cpp, testColVector.cpp, testDisplacement.cpp, testGenericTracker.cpp, testGenericTrackerDepth.cpp, testImageFilter.cpp, testMatrix.cpp, testMatrixConditionNumber.cpp, testMatrixConvolution.cpp, testMatrixDeterminant.cpp, testMatrixInitialization.cpp, testMatrixInverse.cpp, testMatrixPseudoInverse.cpp, testPoseVector.cpp, testRowVector.cpp, testSvd.cpp, testTranslationVector.cpp, and tutorial-matlab.cpp.

Definition at line 289 of file vpArray2D.h.

References vpArray2D< Type >::rowNum.

Referenced by vpMatrix::column(), vpMatrix::cond(), vpColVector::cppPrint(), vpMatrix::cppPrint(), vpColVector::csvPrint(), vpMatrix::csvPrint(), vpMatrix::detByLUEigen3(), vpMatrix::extract(), vpRotationMatrix::getCol(), vpHomogeneousMatrix::getCol(), vpMatrix::getCol(), vpMatrix::inducedL2Norm(), vpMatrix::inverseByCholeskyLapack(), vpMatrix::inverseByLUEigen3(), vpMatrix::inverseByQRLapack(), vpRotationMatrix::isARotationMatrix(), vpMatrix::kernel(), vpColVector::maplePrint(), vpMatrix::maplePrint(), vpColVector::matlabPrint(), vpMatrix::matlabPrint(), vpMatrix::nullSpace(), vpColVector::operator+(), vpColVector::operator+=(), vpColVector::operator-(), vpColVector::operator-=(), vpForceTwistMatrix::print(), vpVelocityTwistMatrix::print(), vpPoseVector::print(), vpColVector::print(), vpMatrix::print(), vpMatrix::pseudoInverse(), vpMatrix::svdEigen3(), vpMatrix::svdLapack(), and vpMatrix::svdOpenCV().

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.

void vpRowVector::init	(	const vpRowVector &	v,
		unsigned int	c,
		unsigned int	ncols
	)

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

Parameters

v	: Input row vector used for initialization.
c	: column index in v that corresponds to the first element of the row vector to contruct.
ncols	: Number of columns of the constructed row vector.

The sub-vector starting from v[c] element and ending on v[c+ncols-1] element is used to initialize the contructed row vector.

The following code shows how to use this function:

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

It produces the following output:

v: 0 1 2 3

w: 1 2

Examples:: testRowVector.cpp.

Definition at line 1152 of file vpRowVector.cpp.

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

vp_deprecated void vpRowVector::init ( )

inline

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

Definition at line 321 of file vpRowVector.h.

Referenced by vpRowVector(), and vpSubRowVector::vpSubRowVector().

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

Insert a row vector.

Parameters

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

The following example shows how to use this function:

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

It produces the following output:

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

Definition at line 747 of file vpRowVector.cpp.

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

static bool vpArray2D< double >::load	(	const std::string &	filename,
		vpArray2D< double > &	A,
		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 540 of file vpArray2D.h.

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

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

Examples:: servoFlirPtuIBVS.cpp, servoFrankaIBVS.cpp, servoFrankaPBVS.cpp, tutorial-flir-ptu-ibvs.cpp, and tutorial-hand-eye-calibration.cpp.

Definition at line 652 of file vpArray2D.h.

References vpArray2D< Type >::resize().

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

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

The following code

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

produces this output:

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

that could be copy/paste in Maple.

Definition at line 1272 of file vpRowVector.cpp.

References vpArray2D< double >::getCols().

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

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

The following code

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

produces this output:

r = [ 0, 1, 2, ]

that could be copy/paste in Matlab:

>> r = [ 0, 1, 2, ]
r =
    0   1   2
>>

Definition at line 1314 of file vpRowVector.cpp.

References vpArray2D< double >::getCols().

double vpRowVector::mean ( const vpRowVector & v )

static

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

Examples:: testRowVector.cpp.

Definition at line 894 of file vpRowVector.cpp.

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

Referenced by stdev().

double vpRowVector::median ( const vpRowVector & v )

static

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

Examples:: testRowVector.cpp.

Definition at line 911 of file vpRowVector.cpp.

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

vpRowVector & vpRowVector::normalize ( )

Normalise the vector modifying the vector as:

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

where $x_i$ is an element of the row vector $\bf x$ .

Examples:: testRowVector.cpp.

Definition at line 627 of file vpRowVector.cpp.

References sumSquare().

Referenced by vpPolygon3D::computePolygonClipped().

vpRowVector & vpRowVector::normalize ( vpRowVector & x ) const

Normalise the vector given as input parameter and return the normalized vector:

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

where $x_i$ is an element of the row vector $\bf x$ .

Definition at line 612 of file vpRowVector.cpp.

References sumSquare().

bool vpRowVector::operator!= ( const vpRowVector & v ) const

Definition at line 190 of file vpRowVector.cpp.

bool vpArray2D< double >::operator!= ( const vpArray2D< double > & A ) const

inherited

Not equal to comparison operator of a 2D array.

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

Multiply a row vector by a column vector.

Parameters

x	: Column vector.

Warning: The number of elements of the two vectors must be equal.

Exceptions

vpException::dimensionError : If the number of elements of the two vectors is not the same.

Returns: A scalar.

Definition at line 208 of file vpRowVector.cpp.

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

Referenced by print().

vpRowVector vpRowVector::operator* ( const vpMatrix & M ) const

Multiply a row vector by a matrix.

Parameters

M : Matrix.

Warning: The number of elements of the row vector must be equal to the number of rows of the matrix.

Exceptions

vpException::dimensionError If the number of elements of the row vector is not equal to the number of rows of the matrix.

Returns: The resulting row vector.

Definition at line 238 of file vpRowVector.cpp.

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

vpRowVector vpRowVector::operator* ( double x ) const

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

Parameters

x	: The scalar.

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

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

Definition at line 278 of file vpRowVector.cpp.

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

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

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

Parameters

x	: The scalar.

Returns: The row vector multiplied by the scalar.

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

Definition at line 307 of file vpRowVector.cpp.

References vpArray2D< double >::colNum.

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

Operator that allows to add to row vectors that have the same size.

Exceptions

vpException::dimensionError If the vectors size differ.

Definition at line 415 of file vpRowVector.cpp.

References vpArray2D< double >::colNum, vpException::dimensionError, vpArray2D< double >::getCols(), and vpArray2D< Type >::getCols().

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

Operator that allows to add two row vectors that have the same size.

Exceptions

vpException::dimensionError If the size of the two vectors differ.

Definition at line 434 of file vpRowVector.cpp.

References vpArray2D< double >::colNum, vpException::dimensionError, vpArray2D< double >::getCols(), and vpArray2D< Type >::getCols().

vpRowVector & vpRowVector::operator, ( double val )

Definition at line 497 of file vpRowVector.cpp.

References vpArray2D< double >::colNum, vpArray2D< double >::data, and resize().

vpRowVector vpRowVector::operator- ( const vpRowVector & m ) const

Operator that allows to substract to row vectors that have the same size.

Exceptions

vpException::dimensionError If the vectors size differ.

Definition at line 397 of file vpRowVector.cpp.

References vpArray2D< double >::colNum, vpException::dimensionError, vpArray2D< double >::getCols(), and vpArray2D< Type >::getCols().

vpRowVector vpRowVector::operator- ( void ) const

Operator that allows to negate all the row vector elements.

vpRowVector r(3, 1);
// r contains [1 1 1]
vpRowVector v = -r;
// v contains [-1 -1 -1]

Definition at line 380 of file vpRowVector.cpp.

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

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

Operator that allows to substract two row vectors that have the same size.

Exceptions

vpException::dimensionError If the size of the two vectors differ.

Definition at line 451 of file vpRowVector.cpp.

References vpArray2D< double >::colNum, vpException::dimensionError, vpArray2D< double >::getCols(), and vpArray2D< Type >::getCols().

vpRowVector vpRowVector::operator/ ( double x ) const

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

Parameters

x	: The scalar.

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

vpRowVector v(3);
v[0] = 8;
v[1] = 4;
v[2] = 2;
vpRowVector w = v / 2;
// v is equal to : [8 4 2]
// w is equal to : [4 2 1]

Definition at line 333 of file vpRowVector.cpp.

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

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

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

Parameters

x	: The scalar.

Returns: The row vector divided by the scalar.

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

Definition at line 363 of file vpRowVector.cpp.

References vpArray2D< double >::colNum.

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

Copy operator. Allows operation such as A << v

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

In row vector A we get:

A: 0 1 2 3 4

Definition at line 484 of file vpRowVector.cpp.

vpRowVector & vpRowVector::operator<< ( double val )

Definition at line 490 of file vpRowVector.cpp.

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

vpRowVector & vpRowVector::operator= ( const vpRowVector & v )

Copy operator. Allow operation such as A = v.

Definition at line 58 of file vpRowVector.cpp.

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

vpRowVector & vpRowVector::operator= ( const vpMatrix & M )

Initialize a row vector from a 1-by-n size matrix.

Warning: Handled with care m should be a 1 column matrix.

Exceptions

vpException::dimensionError If the matrix is not a 1-by-n dimension matrix.

Definition at line 81 of file vpRowVector.cpp.

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

vpRowVector & vpRowVector::operator= ( const std::vector< double > & v )

Initialize a row vector from a standard vector of double.

Definition at line 98 of file vpRowVector.cpp.

References resize().

vpRowVector & vpRowVector::operator= ( const std::vector< float > & v )

Initialize a row vector from a standard vector of double.

Definition at line 108 of file vpRowVector.cpp.

References resize().

vpRowVector & vpRowVector::operator= ( double x )

Initialize each element of the vector with x.

Definition at line 117 of file vpRowVector.cpp.

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

vpRowVector & vpRowVector::operator= ( vpRowVector && v )

Definition at line 128 of file vpRowVector.cpp.

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

vpRowVector & vpRowVector::operator= ( const std::initializer_list< double > & list )

Set vector elements from a list of double.

#include <visp3/core/vpRowVector.cpp>
int main()
{
  vpRowVector r;
  r = {1, 2, 3};
  std::cout << "r: " << r << std::endl;
}

It produces the following printings:

r: 1 2 3

See also: operator<<()

Definition at line 169 of file vpRowVector.cpp.

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

bool vpRowVector::operator== ( const vpRowVector & v ) const

Comparison operator.

Definition at line 177 of file vpRowVector.cpp.

References vpArray2D< double >::colNum, vpArray2D< Type >::colNum, vpArray2D< Type >::data, vpArray2D< double >::data, vpMath::equal(), vpArray2D< double >::rowNum, and vpArray2D< Type >::rowNum.

bool vpArray2D< double >::operator== ( const vpArray2D< double > & A ) const

inherited

Equal to comparison operator of a 2D array.

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

inline

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

Definition at line 214 of file vpRowVector.h.

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

inline

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

Definition at line 216 of file vpRowVector.h.

References vpArray2D< Type >::operator!=(), operator*(), vpArray2D< Type >::operator<<, vpArray2D< Type >::operator=(), and vpArray2D< Type >::operator==().

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

Pretty print a row 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 row 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, testMatrix.cpp, and testRowVector.cpp.

Definition at line 964 of file vpRowVector.cpp.

References vpArray2D< double >::getCols(), vpMath::maximum(), and operator*().

void vpRowVector::rad2deg ( )

inline

Convert a column vector containing angles in radians into degrees.

See also: deg2rad()

Definition at line 256 of file vpRowVector.h.

References vpArray2D< Type >::reshape().

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

Reshape the row 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 row vector have not the same size.

The following example shows how to use this method.

#include <visp3/core/vpRowVector.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;
  vpRowVector row = mat.stackRows();
  std::cout << "row vector: " << row << std::endl;
  vpMatrix remat = row.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
row vector: 1  2  3  4  5  6  7  8  9  10  11  12
remat:
1  2  3  4
5  6  7  8
9  10  11  12

Examples:: testMatrixInitialization.cpp.

Definition at line 699 of file vpRowVector.cpp.

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

Referenced by reshape().

vpMatrix vpRowVector::reshape	(	unsigned int	nrows,
		unsigned int	ncols
	)

Reshape the row vector in a matrix.

Parameters

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

Returns: The resulting matrix.

Exceptions

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

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

Definition at line 649 of file vpRowVector.cpp.

References reshape().

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

inline

Modify the size of the row vector.

Parameters

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

Examples:: testMatrix.cpp, testMatrixInitialization.cpp, and testRowVector.cpp.

Definition at line 271 of file vpRowVector.h.

References vpArray2D< Type >::resize().

Referenced by vpImageTools::columnMean(), vp::eigen2visp(), init(), operator,(), operator<<(), operator=(), stack(), vpMatrix::stackRows(), vpTemplateTrackerSSD::vpTemplateTrackerSSD(), and vpTemplateTrackerZNCC::vpTemplateTrackerZNCC().

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

inline

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

Parameters

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

Exceptions

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

Definition at line 286 of file vpRowVector.h.

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

void vpArray2D< double >::resize	(	unsigned int	nrows,
		unsigned int	ncols,
		bool	flagNullify = `true`,
		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.

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

Definition at line 304 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,(), vpMatrix::operator<<(), vpMatrix::operator=(), vpMatrix::stack(), and vpMatrix::svdOpenCV().

static bool vpArray2D< double >::save	(	const std::string &	filename,
		const vpArray2D< double > &	A,
		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 737 of file vpArray2D.h.

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

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

Examples:: tutorial-chessboard-pose.cpp, tutorial-franka-acquire-calib-data.cpp, and tutorial-hand-eye-calibration.cpp.

Definition at line 830 of file vpArray2D.h.

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

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

Deprecated:: You should rather use eye()

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

inlineinherited

Return the number of elements of the 2D array.

Examples:: testColVector.cpp, testDisplacement.cpp, testEigenConversion.cpp, testMatrix.cpp, testMatrixInitialization.cpp, testPoseVector.cpp, testRobotViper650-frames.cpp, testRobotViper850-frames.cpp, testRowVector.cpp, testThread2.cpp, testTranslationVector.cpp, testTukeyEstimator.cpp, tutorial-ibvs-4pts-wireframe-robot-afma6.cpp, tutorial-ibvs-4pts-wireframe-robot-viper.cpp, tutorial-mb-generic-tracker-rgbd-blender.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, and tutorial-mb-generic-tracker-rgbd.cpp.

Definition at line 291 of file vpArray2D.h.

References vpArray2D< Type >::rowNum.

Referenced by insert(), vpColVector::insert(), vpColVector::operator*(), vpRotationVector::operator,(), vpTranslationVector::operator,(), vpRotationMatrix::operator,(), vpHomogeneousMatrix::operator,(), vpQuaternionVector::operator=(), vpTranslationVector::operator=(), vpRzyzVector::operator=(), vpRxyzVector::operator=(), vpRzyxVector::operator=(), vpThetaUVector::operator=(), vpMatrix::stack(), vpRotationVector::toStdVector(), toStdVector(), and vpColVector::toStdVector().

void vpRowVector::stack ( double d )

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

Parameters

d	: Element to stack to the existing one.

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

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

Examples:: testRowVector.cpp.

Definition at line 787 of file vpRowVector.cpp.

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

Referenced by stack().

void vpRowVector::stack ( const vpRowVector & v )

Stack row vectors.

Parameters

v	: Vector to stack to the existing one.

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

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

Definition at line 812 of file vpRowVector.cpp.

References stack().

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

static

Stack row vectors.

Parameters

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

Returns: Stacked vector .

vpRowVector r1(3, 1);
// r1 is equal to [1 1 1]
vpRowVector r2(2, 3);
// r2 is equal to [3 3]
vpRowVector v;
v = vpRowVector::stack(r1, r2);
// v is equal to [1 1 1 3 3]

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

Definition at line 834 of file vpRowVector.cpp.

References stack().

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

static

Stack row vectors.

Parameters

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

vpRowVector r1(3, 1);
// r1 is equal to [1 1 1]
vpRowVector r2(2, 3);
// r2 is equal to [3 3]
vpRowVector v;
vpRowVector::stack(r1, r2, v);
// v is equal to [1 1 1 3 3]