Visual Servoing Platform  version 3.2.0 under development (2018-10-16)
vpSubColVector Class Reference

#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)
 
vpSubColVectoroperator= (const vpSubColVector &B)
 
vpSubColVectoroperator= (const vpPoseVector &p)
 
vpSubColVectoroperator= (const vpRotationVector &rv)
 
vpSubColVectoroperator= (const vpTranslationVector &tv)
 
vpSubColVectoroperator= (const vpColVector &B)
 
vpSubColVectoroperator= (const vpMatrix &B)
 
vpSubColVectoroperator= (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
 
vpColVectornormalize ()
 
vpColVectornormalize (vpColVector &x) const
 
double & operator[] (unsigned int n)
 
const double & operator[] (unsigned int n) const
 
bool operator== (const vpColVector &v) const
 
bool operator!= (const vpColVector &v) const
 
double operator* (const vpColVector &x) const
 
vpMatrix operator* (const vpRowVector &v) const
 
vpColVector operator* (const double x) const
 
vpColVectoroperator*= (double x)
 
vpColVector operator/ (const double x) const
 
vpColVectoroperator/= (double x)
 
vpColVector operator+ (const vpColVector &v) const
 
vpTranslationVector operator+ (const vpTranslationVector &t) const
 
vpColVectoroperator+= (vpColVector v)
 
vpColVector operator- (const vpColVector &v) const
 
vpColVector operator- () const
 
vpColVectoroperator-= (vpColVector v)
 
vpColVectoroperator<< (const vpColVector &v)
 
vpColVectoroperator<< (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 (double d)
 
void stack (const vpColVector &v)
 
double sum () const
 
double sumSquare () const
 
vpRowVector t () const
 
std::vector< double > toStdVector ()
 
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
 
vpColVectorparent
 
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
 

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

Default constructor that creates an empty vector.

Definition at line 45 of file vpSubColVector.cpp.

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

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.

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(), and vpQuadProg::solveQPi().

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

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

Definition at line 1580 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

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::dimensionErrorIf the vectors dimension is not equal to 3.

Definition at line 284 of file vpColVector.h.

References vpMatrix::stack().

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

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::dimensionErrorIf the vectors dimension is not equal to 3.

Definition at line 1148 of file vpColVector.cpp.

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

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

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);
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 1625 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

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::dimensionErrorIf the vector dimension differ.

Definition at line 733 of file vpColVector.cpp.

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

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

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 1483 of file vpColVector.cpp.

References vpColVector::sumSquare().

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

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::fatalErrorIf the vector to extract is not contained in the original one.
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.

Referenced by vpLinProg::colReduction(), vpQuadProg::fromCanonicalCost(), vpLinProg::simplex(), vpLinProg::solveLP(), and vpQuadProg::solveQPi().

double vpArray2D< double >::getMaxValue ( ) const
inherited

Return the array max value.

Examples:
servoMomentImage.cpp, testArray2D.cpp, and testMatrix.cpp.
double vpArray2D< double >::getMinValue ( ) const
inherited

Return the array min value.

Examples:
servoMomentImage.cpp, testArray2D.cpp, and testMatrix.cpp.
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 1502 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.

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.
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 1540 of file vpColVector.cpp.

References vpArray2D< double >::rowNum.

Referenced by vpAdaptiveGain::operator()().

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.

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()
{
int val = 0;
for(size_t i=0; i<v.getRows(); i++) {
v[i] = val++;
}
std::cout << "v: " << v.t() << std::endl;
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.

vp_deprecated void vpColVector::init ( )
inlineinherited
Deprecated:
Provided only for compat with previous releases. This function does nothing.

Definition at line 310 of file vpColVector.h.

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

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()
{
for (unsigned int i=0; i < v.size(); i++)
v[i] = i;
std::cout << "v: " << v.t() << std::endl;
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 1276 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(), vpMbKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbGenericTracker::computeVVSInteractionMatrixAndResidu(), vpMbKltMultiTracker::computeVVSWeights(), vpMbEdgeMultiTracker::computeVVSWeights(), vpMbEdgeKltMultiTracker::computeVVSWeights(), vpMbGenericTracker::computeVVSWeights(), vpMbEdgeTracker::computeVVSWeights(), vpColVector::insert(), and vpMbGenericTracker::track().

void vpColVector::insert ( const vpColVector v,
unsigned int  i 
)
inherited
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 1737 of file vpColVector.cpp.

References vpColVector::insert().

vpColVector vpColVector::invSort ( const vpColVector v)
staticinherited

Return a column vector with elements of v that are reverse sorted with values going from greatest to lowest.

Example:

#include <visp/vpColVector.h>
int main()
{
vpColVector v(10);
v[0] = 5; v[1] = 7; v[2] = 4; v[3] = 2; v[4] = 8;
v[5] = 6; v[6] = 1; v[7] = 9; v[8] = 0; v[9] = 3;
std::cout << "v: " << v.t() << std::endl;
std::cout << "s: " << s.t() << std::endl;
}

Output:

v: 5 7 4 2 8 6 1 9 0 3
s: 9 8 7 6 5 4 3 2 1 0
See also
sort()

Definition at line 821 of file vpColVector.cpp.

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

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 316 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:
servoFrankaPBVS.cpp.

Definition at line 424 of file vpArray2D.h.

References vpArray2D< Type >::resize().

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()
{
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 1660 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

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()
{
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 1708 of file vpColVector.cpp.

References vpArray2D< double >::getRows().

double vpColVector::mean ( const vpColVector v)
staticinherited

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

Examples:
testColVector.cpp.

Definition at line 1017 of file vpColVector.cpp.

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

Referenced by vpColVector::stdev().

double vpColVector::median ( const vpColVector v)
staticinherited

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

Examples:
testColVector.cpp.

Definition at line 1037 of file vpColVector.cpp.

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

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 766 of file vpColVector.cpp.

References vpColVector::sumSquare().

bool vpColVector::operator!= ( const vpColVector v) const
inherited

Definition at line 689 of file vpColVector.cpp.

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

Operator that performs the dot product between two column vectors.

Exceptions
vpException::dimensionErrorIf 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().

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.

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

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

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.

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.
v[0] = 4;
v[1] = 5;
v[2] = 6;
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().

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.

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.

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.

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.

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

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

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.

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

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.

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.

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.

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.

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.

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.

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.

bool vpColVector::operator== ( const vpColVector v) const
inherited
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.

const double& vpColVector::operator[] ( unsigned int  n) const
inlineinherited
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
sStream used for the printing.
lengthThe 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.
introThe 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 1305 of file vpColVector.cpp.

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

void vpColVector::rad2deg ( )
inlineinherited

Convert a column vector containing angles in radians into degrees.

See also
deg2rad()

Definition at line 228 of file vpColVector.h.

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

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::dimensionErrorIf 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 1230 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().

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 1168 of file vpColVector.cpp.

References vpColVector::reshape().

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

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::fatalErrorWhen ncols is not equal to 1.
Examples:
moveAfma4.cpp, servoAfma4Point2DCamVelocityKalman.cpp, servoViper850Point2DCamVelocityKalman.cpp, testColVector.cpp, testMatrix.cpp, and testThread2.cpp.

Definition at line 244 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(), vpMbKltMultiTracker::computeVVSInit(), vpMbEdgeMultiTracker::computeVVSInit(), vpMbEdgeKltMultiTracker::computeVVSInit(), vpMbGenericTracker::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(), vpRobotFranka::getForceTorque(), 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(), vpRobotFranka::getPosition(), vpRobotViper650::getPosition(), vpRobotViper850::getPosition(), vpRobotPioneer::getVelocity(), vpRobotPtu46::getVelocity(), vpRobotBiclops::getVelocity(), vpSimulatorAfma6::getVelocity(), vpRobotAfma4::getVelocity(), vpSimulatorViper850::getVelocity(), vpRobotAfma6::getVelocity(), vpRobotFranka::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(), vpFeatureThetaU::init(), vpRobotAfma6::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::poseVirtualVSrobust(), vpPoint::projection(), vpLine::projection(), vpMatrix::pseudoInverse(), vpSimulatorAfma6::readPosFile(), vpRobotAfma4::readPosFile(), vpSimulatorViper850::readPosFile(), vpRobotAfma6::readPosFile(), vpRobotFranka::readPosFile(), vpRobotViper650::readPosFile(), vpRobotViper850::readPosFile(), vpRobotPtu46::readPositionFile(), vpRobotBiclops::readPositionFile(), vpRobust::resize(), vpLinProg::simplex(), vpLinProg::solveLP(), vpQuadProg::solveQPi(), 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().

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::fatalErrorWhen ncols is not equal to 1.

Definition at line 255 of file vpColVector.h.

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

vp_deprecated vpColVector vpColVector::rows ( unsigned int  first_row,
unsigned int  last_row 
) const
inlineinherited
Deprecated:
You should rather use extract().

Definition at line 314 of file vpColVector.h.

References vpMatrix::setIdentity().

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 506 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::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
- [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
- [0, 0, 0, 0]
- [0, 0, 0, 0]
- [0, 0, 0, 0]
See also
loadYAML()
Examples:
tutorial-chessboard-pose.cpp, and tutorial-franka-acquire-calib-data.cpp.

Definition at line 595 of file vpArray2D.h.

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

vp_deprecated void vpColVector::setIdentity ( const double &  val = 1.0)
inherited
Deprecated:
You should rather use eye()
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 1116 of file vpColVector.cpp.

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

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

vpColVector vpColVector::sort ( const vpColVector v)
staticinherited

Return a column vector with elements of v that are sorted with values going from lowest to geatest.

Example:

#include <visp/vpColVector.h>
int main()
{
vpColVector v(10);
v[0] = 5; v[1] = 7; v[2] = 4; v[3] = 2; v[4] = 8;
v[5] = 6; v[6] = 1; v[7] = 9; v[8] = 0; v[9] = 3;
std::cout << "v: " << v.t() << std::endl;
std::cout << "s: " << s.t() << std::endl;
}

Output:

v: 5 7 4 2 8 6 1 9 0 3
s: 0 1 2 3 4 5 6 7 8 9
See also
invSort()

Definition at line 873 of file vpColVector.cpp.

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

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 939 of file vpColVector.cpp.

References vpColVector::stack().

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 $[A B]^T$.
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 959 of file vpColVector.cpp.

References vpColVector::stack().

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 $C = [A B]^T$.
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 984 of file vpColVector.cpp.

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

vp_deprecated void vpColVector::stackMatrices ( const vpColVector r)
inlineinherited
Deprecated:
You should rather use stack(const vpColVector &)

Definition at line 325 of file vpColVector.h.

References vpMatrix::stack().

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 330 of file vpColVector.h.

References vpMatrix::stack().

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 335 of file vpColVector.h.

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

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 1051 of file vpColVector.cpp.

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

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 1394 of file vpColVector.cpp.

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

Referenced by vpColVector::mean().

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, servoSimuSphere2DCamVelocityDisplaySecondaryTask.cpp, testColVector.cpp, testComedi.cpp, testDisplacement.cpp, testForceTorqueAti.cpp, testFrankaCartVelocity-2.cpp, testFrankaCartVelocity-3.cpp, testFrankaCartVelocity.cpp, testFrankaGetPose.cpp, testFrankaJointPosition.cpp, testFrankaJointVelocity-2.cpp, testFrankaJointVelocity-3.cpp, testFrankaJointVelocity.cpp, testFrankaJointVelocityLimits.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 696 of file vpColVector.cpp.

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

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

std::vector< double > vpColVector::toStdVector ( )
inherited

Converts the vpColVector to a std::vector.

Returns
The corresponding std::vector<double>.
Examples:
testColVector.cpp.

Definition at line 643 of file vpColVector.cpp.

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

vpRowVector vpColVector::transpose ( ) const
inherited

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

See also
t()

Definition at line 707 of file vpColVector.cpp.

References vpColVector::t().

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 713 of file vpColVector.cpp.

References vpColVector::t().

Friends And Related Function Documentation

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

Allows to multiply a scalar by a column vector.

Definition at line 719 of file vpColVector.cpp.

enum vpGEMMmethod
related

Enumeration of the operations applied on matrices in vpGEMM() function.

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

unsigned int vpArray2D< double >::colNum
protectedinherited

Number of columns in the array.

Definition at line 76 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpMatrix::AtA(), vpColVector::clear(), vpMatrix::detByLU(), vpMatrix::diag(), vpMatrix::eigenValues(), vpMatrix::expm(), vpMatrix::eye(), vpMatrix::getRow(), vpColVector::hadamard(), vpMatrix::hadamard(), vpMatrix::infinityNorm(), init(), vpSubRowVector::init(), vpSubMatrix::init(), vpRowVector::insert(), vpMatrix::insert(), vpMatrix::inverseByCholesky(), vpMatrix::inverseTriangular(), vpRotationMatrix::operator*(), vpRowVector::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*=(), vpRowVector::operator*=(), vpMatrix::operator*=(), vpRowVector::operator+(), vpRowVector::operator+=(), vpMatrix::operator+=(), vpRowVector::operator-(), vpRowVector::operator-=(), vpMatrix::operator-=(), vpRowVector::operator/(), vpMatrix::operator/(), vpRowVector::operator/=(), vpMatrix::operator/=(), vpMatrix::operator<<(), vpColVector::operator<<(), vpSubRowVector::operator=(), vpSubMatrix::operator=(), vpRowVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpColVector::operator==(), vpMatrix::qr(), vpMatrix::qrPivot(), vpRowVector::reshape(), vpMatrix::setIdentity(), vpMatrix::solveByQR(), vpMatrix::solveBySVD(), vpMatrix::stack(), vpRowVector::stack(), vpMatrix::stackColumns(), vpMatrix::stackRows(), vpRowVector::sum(), vpMatrix::sum(), vpRowVector::sumSquare(), vpMatrix::sumSquare(), vpRowVector::t(), vpMatrix::t(), vpMatrix::transpose(), vpColVector::vpColVector(), and vpMatrix::vpMatrix().

double * vpArray2D< double >::data
inherited

Address of the first element of the data array.

Examples:
testArray2D.cpp, testDisplacement.cpp, testImageFilter.cpp, testMatrix.cpp, testPoseVector.cpp, testTranslationVector.cpp, and tutorial-matlab.cpp.

Definition at line 84 of file vpArray2D.h.

Referenced by vpMatrix::AtA(), vpQuaternionVector::buildFrom(), vpHomogeneousMatrix::buildFrom(), vpRzyzVector::buildFrom(), vpThetaUVector::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=(), vpMatrix::operator=(), vpThetaUVector::operator=(), vpColVector::operator==(), vpColVector::operator[](), vpMatrix::qr(), vpMatrix::qrPivot(), vpRowVector::reshape(), vpColVector::reshape(), vpQuaternionVector::set(), vpMatrix::stack(), vpMatrix::stackRows(), vpColVector::sum(), vpColVector::sumSquare(), vpRotationVector::t(), vpTranslationVector::t(), vpPoseVector::t(), vpRowVector::t(), vpColVector::t(), vpRotationVector::toStdVector(), vpRowVector::toStdVector(), vpColVector::toStdVector(), vpColVector::vpColVector(), vpMatrix::vpMatrix(), vpQuaternionVector::w(), vpQuaternionVector::x(), vpQuaternionVector::y(), vpQuaternionVector::z(), ~vpSubColVector(), vpSubMatrix::~vpSubMatrix(), and vpSubRowVector::~vpSubRowVector().

vpColVector* vpSubColVector::parent
protected

Parent vpColvector.

Definition at line 73 of file vpSubColVector.h.

Referenced by checkParentStatus(), and init().

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

unsigned int vpArray2D< double >::rowNum
protectedinherited

Number of rows in the array.

Definition at line 74 of file vpArray2D.h.

Referenced by vpMatrix::AAt(), vpMatrix::AtA(), vpColVector::clear(), vpMatrix::detByLU(), vpMatrix::diag(), vpMatrix::eigenValues(), vpMatrix::expm(), vpColVector::extract(), vpMatrix::eye(), vpColVector::hadamard(), vpMatrix::hadamard(), vpColVector::infinityNorm(), vpMatrix::infinityNorm(), init(), vpSubRowVector::init(), vpSubMatrix::init(), vpMatrix::insert(), vpMatrix::inverseByCholesky(), vpMatrix::inverseTriangular(), vpRotationMatrix::operator*(), vpTranslationVector::operator*(), vpHomogeneousMatrix::operator*(), vpColVector::operator*(), vpMatrix::operator*(), vpRotationMatrix::operator*=(), vpTranslationVector::operator*=(), vpColVector::operator*=(), vpMatrix::operator*=(), vpColVector::operator+(), vpColVector::operator+=(), vpMatrix::operator+=(), vpColVector::operator-(), vpColVector::operator-=(), vpMatrix::operator-=(), vpColVector::operator/(), vpMatrix::operator/(), vpTranslationVector::operator/=(), vpColVector::operator/=(), vpMatrix::operator/=(), vpMatrix::operator<<(), vpColVector::operator<<(), operator=(), vpSubRowVector::operator=(), vpSubMatrix::operator=(), vpTranslationVector::operator=(), vpRowVector::operator=(), vpColVector::operator=(), vpMatrix::operator=(), vpColVector::operator==(), vpMatrix::qr(), vpMatrix::qrPivot(), vpColVector::reshape(), vpMatrix::setIdentity(), vpMatrix::stack(), vpColVector::stack(), vpMatrix::stackColumns(), vpMatrix::stackRows(), vpColVector::sum(), vpMatrix::sum(), vpRotationVector::sumSquare(), vpTranslationVector::sumSquare(), vpColVector::sumSquare(), vpMatrix::sumSquare(), vpTranslationVector::t(), vpPoseVector::t(), vpColVector::t(), vpMatrix::t(), vpMatrix::transpose(), vpColVector::vpColVector(), and vpMatrix::vpMatrix().