![]() |
Visual Servoing Platform
version 3.2.0
|
#include <vpSubRowVector.h>
Public Member Functions | |
vpSubRowVector () | |
vpSubRowVector (vpRowVector &v, const unsigned int &offset, const unsigned int &ncols) | |
virtual | ~vpSubRowVector () |
void | checkParentStatus () const |
void | init (vpRowVector &v, const unsigned int &offset, const unsigned int &ncols) |
vpSubRowVector & | operator= (const vpSubRowVector &B) |
vpSubRowVector & | operator= (const vpRowVector &B) |
vpSubRowVector & | operator= (const vpMatrix &B) |
vpSubRowVector & | operator= (const double &x) |
void | clear () |
std::ostream & | cppPrint (std::ostream &os, const std::string &matrixName="A", bool octet=false) const |
std::ostream & | csvPrint (std::ostream &os) const |
void | deg2rad () |
double | euclideanNorm () const |
vpRowVector | extract (unsigned int c, unsigned int rowsize) 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 |
double | operator* (const vpColVector &x) const |
vpRowVector | operator* (const vpMatrix &M) const |
vpRowVector | operator* (const double x) const |
vpRowVector & | operator*= (double x) |
vpRowVector | operator/ (const 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- () const |
vpRowVector & | operator-= (vpRowVector v) |
vpRowVector & | operator<< (const vpRowVector &v) |
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 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 | |
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 |
vpArray2D< double > | hadamard (const vpArray2D< double > &m) const |
Static Public Member Functions | |
static vpRowVector | stack (const vpRowVector &A, const vpRowVector &B) |
static void | stack (const vpRowVector &A, const vpRowVector &B, vpRowVector &C) |
static double | mean (const vpRowVector &v) |
static double | median (const vpRowVector &v) |
static double | stdev (const vpRowVector &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 | pColNum |
vpRowVector * | parent |
unsigned int | rowNum |
unsigned int | colNum |
double ** | rowPtrs |
unsigned int | dsize |
Related Functions | |
(Note that these are not member functions.) | |
enum | vpGEMMmethod |
void | vpGEMM (const vpArray2D< double > &A, const vpArray2D< double > &B, const double &alpha, const vpArray2D< double > &C, const double &beta, vpArray2D< double > &D, const unsigned int &ops=0) |
Deprecated functions | |
vp_deprecated void | init () |
vp_deprecated void | 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) |
This class provides a mask on a vpRowVector. It has internally a pointer to the parent vpRowVector. All properties of vpRowVector are available with a vpSubRowVector.
Definition at line 62 of file vpSubRowVector.h.
vpSubRowVector::vpSubRowVector | ( | ) |
Default constructor that creates an empty vector.
Definition at line 44 of file vpSubRowVector.cpp.
vpSubRowVector::vpSubRowVector | ( | vpRowVector & | v, |
const unsigned int & | offset, | ||
const unsigned int & | ncols | ||
) |
Construct a sub-row vector from a parent row vector.
v | : parent row vector. |
offset | : offset where the sub-row vector starts in the parent row vector. |
ncols | : size of the sub-row vector. |
Definition at line 52 of file vpSubRowVector.cpp.
|
virtual |
Destructor that set the pointer to the parrent row vector to NULL.
Definition at line 96 of file vpSubRowVector.cpp.
void vpSubRowVector::checkParentStatus | ( | ) | const |
This method can be used to detect if the parent row vector always exits or its size have not changed. If this not the case an exception is thrown.
Definition at line 103 of file vpSubRowVector.cpp.
|
inlineinherited |
Removes all elements from the vector (which are destroyed), leaving the container with a size of 0.
Definition at line 98 of file vpRowVector.h.
|
inherited |
Print to be used as part of a C++ code later.
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:
It produces the following output that could be copy/paste in a C++ code:
Definition at line 1087 of file vpRowVector.cpp.
|
inherited |
Print/save a row vector in csv format.
The following code
produces log.csv file that contains:
Definition at line 1129 of file vpRowVector.cpp.
|
inlineinherited |
Convert a column vector containing angles in degrees into radians.
Definition at line 119 of file vpRowVector.h.
|
inherited |
Compute and return the Euclidean norm .
Definition at line 997 of file vpRowVector.cpp.
|
inlineinherited |
Extract a sub-row vector from a row vector.
c | : Index of the column corresponding to the first element of the vector to extract. |
rowsize | : Size of the vector to extract. |
vpException::fatalError | If the vector to extract is not contained in the original one. |
Definition at line 143 of file vpRowVector.h.
|
inlineinherited |
Return the number of columns of the 2D array.
Definition at line 145 of file vpArray2D.h.
|
inherited |
Return the array max value.
Definition at line 693 of file vpArray2D.h.
|
inherited |
Return the array min value.
Definition at line 676 of file vpArray2D.h.
|
inlineinherited |
Return the number of rows of the 2D array.
Definition at line 155 of file vpArray2D.h.
Compute the Hadamard product (element wise matrix multiplication).
m | : Second matrix; |
Definition at line 713 of file vpArray2D.h.
|
inlineinherited |
Definition at line 262 of file vpRowVector.h.
|
inherited |
Initialize the row vector from a part of an input row vector v.
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:
It produces the following output:
Definition at line 1043 of file vpRowVector.cpp.
void vpSubRowVector::init | ( | vpRowVector & | v, |
const unsigned int & | offset, | ||
const unsigned int & | ncols | ||
) |
Initialize a sub-row vector from a parent row vector.
v | : parent row vector. |
offset | : offset where the sub-row vector starts in the parent row vector. |
ncols | : size of the sub-row vector. |
Definition at line 64 of file vpSubRowVector.cpp.
|
inherited |
Insert a row vector.
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:
It produces the following output:
Definition at line 648 of file vpRowVector.cpp.
|
inlinestaticinherited |
Load a matrix from a file.
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. |
Definition at line 321 of file vpArray2D.h.
|
inlinestaticinherited |
Load an array from a YAML-formatted file.
filename | : absolute file name. |
A | : array to be loaded from the file. |
header | : header of the file is loaded in this parameter. |
Definition at line 433 of file vpArray2D.h.
|
inherited |
Print using Maple syntax, to copy/paste in Maple later.
The following code
produces this output:
that could be copy/paste in Maple.
Definition at line 1163 of file vpRowVector.cpp.
|
inherited |
Print using Matlab syntax, to copy/paste in Matlab later.
The following code
produces this output:
that could be copy/paste in Matlab:
Definition at line 1205 of file vpRowVector.cpp.
|
staticinherited |
Compute the mean value of all the elements of the vector.
Definition at line 795 of file vpRowVector.cpp.
|
staticinherited |
Compute the median value of all the elements of the vector.
Definition at line 812 of file vpRowVector.cpp.
|
inherited |
Normalise the vector modifying the vector as:
where is an element of the row vector
.
Definition at line 528 of file vpRowVector.cpp.
|
inherited |
Normalise the vector given as input parameter and return the normalized vector:
where is an element of the row vector
.
Definition at line 513 of file vpRowVector.cpp.
|
inherited |
Operator that allows to multiply each element of a row vector by a scalar.
x | : The scalar. |
Definition at line 210 of file vpRowVector.cpp.
|
inherited |
Multiply a row vector by a column vector.
x | : Column vector. |
vpException::dimensionError | : If the number of elements of the two vectors is not the same. |
Definition at line 140 of file vpRowVector.cpp.
|
inherited |
Multiply a row vector by a matrix.
M | : Matrix. |
vpException::dimensionError | If the number of elements of the row vector is not equal to the number of rows of the matrix. |
Definition at line 170 of file vpRowVector.cpp.
|
inherited |
Operator that allows to multiply each element of a row vector by a scalar.
x | : The scalar. |
Definition at line 239 of file vpRowVector.cpp.
|
inherited |
Operator that allows to add to row vectors that have the same size.
vpException::dimensionError | If the vectors size differ. |
Definition at line 347 of file vpRowVector.cpp.
|
inherited |
Operator that allows to add two row vectors that have the same size.
vpException::dimensionError | If the size of the two vectors differ. |
Definition at line 366 of file vpRowVector.cpp.
|
inherited |
Operator that allows to negate all the row vector elements.
Definition at line 312 of file vpRowVector.cpp.
|
inherited |
Operator that allows to substract to row vectors that have the same size.
vpException::dimensionError | If the vectors size differ. |
Definition at line 329 of file vpRowVector.cpp.
|
inherited |
Operator that allows to substract two row vectors that have the same size.
vpException::dimensionError | If the size of the two vectors differ. |
Definition at line 383 of file vpRowVector.cpp.
|
inherited |
Operator that allows to divide each element of a row vector by a scalar.
x | : The scalar. |
Definition at line 265 of file vpRowVector.cpp.
|
inherited |
Operator that allows to divide each element of a row vector by a scalar.
x | : The scalar. |
Definition at line 295 of file vpRowVector.cpp.
|
inherited |
Copy operator. Allows operation such as A << v
In row vector A we get:
Definition at line 416 of file vpRowVector.cpp.
vpSubRowVector & vpSubRowVector::operator= | ( | const double & | x | ) |
Set all the elements of the sub-row vector to x.
x | : a scalar value. |
Definition at line 173 of file vpSubRowVector.cpp.
vpSubRowVector & vpSubRowVector::operator= | ( | const vpMatrix & | B | ) |
Allow to initialize a sub-row vector from a matrix using operation A = B. Notice that the sub-row vector is not resized to the dimension of B.
B | : a matrix of size 1-by-n. |
Definition at line 158 of file vpSubRowVector.cpp.
vpSubRowVector & vpSubRowVector::operator= | ( | const vpRowVector & | B | ) |
Allow to initialize a sub-row vector from a row vector using operation A = B. Notice that the sub-row vector is not resized to the dimension of B.
B | : a row vector. |
Definition at line 139 of file vpSubRowVector.cpp.
vpSubRowVector & vpSubRowVector::operator= | ( | const vpSubRowVector & | B | ) |
Allow to initialize a sub-row vector from an other one using operation A = B. Notice that the sub-row vector is not resized to the dimension of B.
B | : a sub-row vector. |
Definition at line 119 of file vpSubRowVector.cpp.
|
inlineinherited |
Operator that allows to set a value of an element : v[i] = x.
Definition at line 165 of file vpRowVector.h.
|
inlineinherited |
Operator that allows to get the value of an element : x = v[i].
Definition at line 167 of file vpRowVector.h.
|
inherited |
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.
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. |
Definition at line 865 of file vpRowVector.cpp.
|
inlineinherited |
Convert a column vector containing angles in radians into degrees.
Definition at line 198 of file vpRowVector.h.
|
inherited |
Reshape the row vector in a matrix.
nrows | : number of rows of the matrix. |
ncols | : number of columns of the matrix. |
vpException::dimensionError | If the matrix and the row vector have not the same size. |
Definition at line 550 of file vpRowVector.cpp.
|
inherited |
Reshape the row vector in a matrix.
M | : the reshaped matrix. |
nrows | : number of rows of the matrix. |
ncols | : number of columns of the matrix. |
vpException::dimensionError | If the matrix and the row vector have not the same size. |
The following example shows how to use this method.
If you run the previous example, you get:
Definition at line 600 of file vpRowVector.cpp.
|
inlineinherited |
Modify the size of the row vector.
i | : Size of the vector. This value corresponds to the vector number of columns. |
flagNullify | : If true, set the data to zero. |
Definition at line 212 of file vpRowVector.h.
Referenced by vpTemplateTrackerSSD::vpTemplateTrackerSSD(), and vpTemplateTrackerZNCC::vpTemplateTrackerZNCC().
|
inlineinherited |
Resize the row vector to a ncols-dimension vector. This function can only be used with nrows = 1.
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. |
vpException::fatalError | When nrows is not equal to 1. |
Definition at line 227 of file vpRowVector.h.
|
inlineinherited |
Set the size of the array and initialize all the values to zero.
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. |
Definition at line 170 of file vpArray2D.h.
|
inlinestaticinherited |
Save a matrix to a file.
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. |
Warning : If you save the matrix as in a text file the precision is less than if you save it in a binary file.
Definition at line 518 of file vpArray2D.h.
|
inlinestaticinherited |
Save an array in a YAML-formatted file.
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. |
Here is an example of outputs.
Content of matrix.yml:
Content of matrixIndent.yml:
Definition at line 611 of file vpArray2D.h.
|
inherited |
|
inlineinherited |
Return the number of elements of the 2D array.
Definition at line 157 of file vpArray2D.h.
|
staticinherited |
Stack row vectors.
A | : Initial vector. |
B | : Vector to stack at the end of A. |
Definition at line 735 of file vpRowVector.cpp.
|
staticinherited |
Stack row vectors.
A | : Initial vector. |
B | : Vector to stack at the end of A. |
C | : Resulting stacked vector ![]() |
Definition at line 762 of file vpRowVector.cpp.
|
inherited |
Stack row vectors.
v | : Vector to stack to the existing one. |
Definition at line 713 of file vpRowVector.cpp.
|
inherited |
Stack row vector with a new element at the end of the vector.
d | : Element to stack to the existing one. |
Definition at line 688 of file vpRowVector.cpp.
|
inlinestaticinherited |
Definition at line 271 of file vpRowVector.h.
|
inlinestaticinherited |
Definition at line 276 of file vpRowVector.h.
|
inlineinherited |
Definition at line 266 of file vpRowVector.h.
|
staticinherited |
Compute the standard deviation value of all the elements of the vector.
Definition at line 826 of file vpRowVector.cpp.
|
inherited |
Return the sum of all the elements of the row vector v(n).
Definition at line 963 of file vpRowVector.cpp.
|
inherited |
Return the sum square of all the elements of the row vector v(n).
Definition at line 980 of file vpRowVector.cpp.
|
inherited |
Transpose the row vector. The resulting vector becomes a column vector.
Definition at line 425 of file vpRowVector.cpp.
|
inherited |
Converts the vpRowVector to a std::vector.
Definition at line 663 of file vpRowVector.cpp.
|
inherited |
Transpose the row vector. The resulting vector becomes a column vector.
Definition at line 436 of file vpRowVector.cpp.
|
inherited |
Transpose the row vector. The resulting vector v becomes a column vector.
Definition at line 441 of file vpRowVector.cpp.
|
related |
This function performs generalized matrix multiplication: D = alpha*op(A)*op(B) + beta*op(C), where op(X) is X or X^T. Operation on A, B and C matrices is described by enumeration vpGEMMmethod().
For example, to compute D = alpha*A^T*B^T+beta*C we need to call :
If C is not used, vpGEMM must be called using an empty array null. Thus to compute D = alpha*A^T*B, we have to call:
vpException::incorrectMatrixSizeError | if the sizes of the matrices do not allow the operations. |
A | : An array that could be a vpMatrix. |
B | : An array that could be a vpMatrix. |
alpha | : A scalar. |
C | : An array that could be a vpMatrix. |
beta | : A scalar. |
D | : The resulting array that could be a vpMatrix. |
ops | : A scalar describing operation applied on the matrices. Possible values are the one defined in vpGEMMmethod(): VP_GEMM_A_T, VP_GEMM_B_T, VP_GEMM_C_T. |
|
related |
Enumeration of the operations applied on matrices in vpGEMM() function.
Operations are :
|
protectedinherited |
Number of columns in the array.
Definition at line 75 of file vpArray2D.h.
|
inherited |
Address of the first element of the data array.
Definition at line 83 of file vpArray2D.h.
|
protectedinherited |
Current array size (rowNum * colNum)
Definition at line 79 of file vpArray2D.h.
|
protected |
Parent vpColvector.
Definition at line 73 of file vpSubRowVector.h.
|
protected |
Number of row of parent vpColvector at initialization.
Definition at line 71 of file vpSubRowVector.h.
|
protectedinherited |
Number of rows in the array.
Definition at line 73 of file vpArray2D.h.
|
protectedinherited |
Address of the first element of each rows.
Definition at line 77 of file vpArray2D.h.