Class : RealVector
RealVector :
prototype: RealVector ()
description:default constructor
RealVector :
prototype: RealVector (int , bool zeroFlag = false )
description:constructor for an empty real vector
input parameters:
size = Vector Dimension
zeroFlag = true if all coordinates have to be set to zero
RealVector :
prototype: RealVector (double* , int size )
description:constructor from an array of doubles
input parameters:
array = array of doubles with real in even position and imaginary part in odd position
size = Vector Dimension
RealVector :
prototype: RealVector (const RealVector& , bool duplicateFlag = false )
description:copy constructor
input parameters:
vector = vector to copy
duplicateFlag = true if datas have to be duplicated
RealVector :
prototype: RealVector (const ComplexVector& vector )
description:copy constructor from a complex vector (keep only real part and datas are duplicated)
input parameters:
vector = vector to copy
RealVector :
prototype: RealVector (const Vector& vector )
description:copy constructor from a vector (duplicate datas if necessary)
input parameters:
vector = vector to copy
~RealVector :
prototype: ~RealVector ()
description:destructor
operator = :
prototype: RealVector& operator = (const RealVector& vector )
description:assignement
input parameters:
vector = vector to assign
return value: reference on current vector
operator = :
prototype: RealVector& operator = (const ComplexVector& vector )
description:assignement from a complex vector (keep only real part and datas are duplicated)
input parameters:
vector = vector to assign
return value: reference on current vector
operator = :
prototype: RealVector& operator = (const Vector& vector )
description:assignement from a vector (duplicate datas if necessary)
input parameters:
vector = vector to assign
return value: reference on current vector
Resize :
prototype: void Resize (int dimension )
description:Resize vector
input parameters:
dimension = new dimension
ResizeAndClean :
prototype: void ResizeAndClean (int dimension )
description:Resize vector and set to zero all components that have been added
input parameters:
dimension = new dimension
Copy :
prototype: RealVector& Copy (RealVector& , double coefficient = 1.0 )
description:copy a vector into another
input parameters:
vector = vector to copy
coefficient = optional coefficient which multiply source to copy
return value: reference on current vector
EmptyClone :
prototype: Vector* EmptyClone (bool zeroFlag = false )
description:create a new vector with same size and same type but without duplicating datas
input parameters:
zeroFlag = true if all coordinates have to be set to zero
return value: pointer to new vector
ClearVector :
prototype: Vector& ClearVector ()
description:put all vector components to zero
input parameters:
return value: reference on current vector
operator - :
prototype: RealVector& operator - ()
description:change sign of a vector
input parameters:
return value: reference on current vector
operator - :
prototype: friend RealVector operator - (const RealVector& V1 )
description:return a new vector with opposite sign form a given source vector
input parameters:
V1 = source vector
return value: new vector
operator * :
prototype: friend double operator * (const RealVector& , const RealVector& V2 )
description:scalar product between two vectors
input parameters:
V1 = first vector
V2 = second vector
return value: result of scalar product
operator += :
prototype: RealVector& operator += (const RealVector& V1 )
description:sum two vectors
input parameters:
V1 = vector to add
return value: reference on current vector
operator += :
prototype: Vector& operator += (const Vector& vector )
description:sum two vectors
input parameters:
vector = vector to add
return value: reference on current vector
operator -= :
prototype: RealVector& operator -= (const RealVector& V1 )
description:substract two vectors
input parameters:
V1 = first vector
return value: reference on current vector
operator + :
prototype: friend RealVector operator + (const RealVector& , const RealVector& V2 )
description:sum two vectors
input parameters:
V1 = first vector
V2 = second vector
return value: resulting vector
operator - :
prototype: friend RealVector operator - (const RealVector& , const RealVector& V2 )
description:substract two vectors
input parameters:
V1 = first vector
V2 = second vector
return value: resulting vector
AddLinearCombination :
prototype: RealVector& AddLinearCombination (const double& , const RealVector& V )
description:add a linear combination to a given vector
input parameters:
x = multiplicative coefficient
V = vector to add
return value: reference on current vector
AddLinearCombination :
prototype: RealVector& AddLinearCombination (double , const RealVector& , int , int nbrComponent )
description:add a linear combination to a given vector, for a given range of indices
input parameters:
x = multiplicative coefficient
V = vector to add
return value: reference on current vector
AddLinearCombination :
prototype: RealVector& AddLinearCombination (double , const RealVector& , double , const RealVector& v2 )
description:add a linear combination of two vectors to a given vector
input parameters:
x1 = multiplicative coefficient of first vector
v1 = first vector to add
x2 = multiplicative coefficient of first vector
v2 = first vector to add
return value: reference on current vector
AddLinearCombination :
prototype: RealVector& AddLinearCombination (double , const RealVector& , double ,
const RealVector& , int , int nbrComponent )
description:add a linear combination of two vectors to a given vector, for a given range of indices
input parameters:
x1 = multiplicative coefficient of first vector
v1 = first vector to add
x2 = multiplicative coefficient of first vector
v2 = first vector to add
firstComponent = index of the first component to evaluate
nbrComponent = number of components to evaluate
return value: reference on current vector
operator * :
prototype: friend RealVector operator * (const RealVector& , double d )
description:multiply a vector with a real number on the right hand side
input parameters:
V1 = vector to multiply
d = real to use
return value: resulting vector
operator * :
prototype: friend RealVector operator * (double , const RealVector& V1 )
description:multiply a vector with a real number on the left hand side
input parameters:
V1 = vector to multiply
d = real to use
return value: resulting vector
operator *= :
prototype: RealVector& operator *= (double d )
description:multiply a vector with a real number on the right hand side
input parameters:
d = real to use
return value: reference on current vector
operator /= :
prototype: RealVector& operator /= (double d )
description:divide a vector by a real number on the right hand side
input parameters:
d = real to use
return value: reference on current vector
operator *= :
prototype: RealVector& operator *= (const RealSymmetricMatrix& M )
description:left multiply a vector with a real symmetric matrix (without using temporary vector)
input parameters:
M = matrix to use
return value: reference on current vector
operator *= :
prototype: RealVector& operator *= (const RealTriDiagonalSymmetricMatrix& M )
description:left multiply a vector with a real tridiagonal symmetric matrix (without using temporary vector)
input parameters:
M = matrix to use
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealSymmetricMatrix& , RealVector& V )
description:left multiply a vector with a symmetric matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealSymmetricMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real symmetric matrix and store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealSymmetricMatrix& , RealVector& , int , int , int , int destStep )
description:left multiply a vector with a symmetric matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealSymmetricMatrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with a symmetric matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealSymmetricMatrix& , RealVector& V )
description:left multiply a vector with a real matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealSymmetricMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real symmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealSymmetricMatrix& , RealVector& , int ,
int , int , int destStep )
description:left multiply a vector with a antisymmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealSymmetricMatrix& , RealVector& , int ,
int , int , int , int destStep )
description:left multiply a vector with a antisymmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealAntisymmetricMatrix& , RealVector& V )
description:left multiply a vector with an antisymmetric matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealAntisymmetricMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real antisymmetric matrix and store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealAntisymmetricMatrix& , RealVector& , int , int ,
int , int destStep )
description:left multiply a vector with an antisymmetric matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealAntisymmetricMatrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with an antisymmetric matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealAntisymmetricMatrix& , RealVector& V )
description:left multiply a vector with an antisymmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealAntisymmetricMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real antisymmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealAntisymmetricMatrix& , RealVector& , int , int , int , int destStep )
description:left multiply a vector with an antisymmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealAntisymmetricMatrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with an antisymmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealDiagonalMatrix& , RealVector& V )
description:left multiply a vector with a real diagonal matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealDiagonalMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real matrix and store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealDiagonalMatrix& , RealVector& , int , int ,
int , int destStep )
description:left multiply a vector with a real diagonal matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealDiagonalMatrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with a real diagonal matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealDiagonalMatrix& , RealVector& V )
description:left multiply a vector with a real diagonal matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealDiagonalMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealDiagonalMatrix& , RealVector& , int , int , int , int destStep )
description:left multiply a vector with a real diagonal matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealDiagonalMatrix& , RealVector& , int ,
int , int , int , int destStep )
description:left multiply a vector with a real diagonal matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealMatrix& , RealVector& V )
description:left multiply a vector with a real matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real matrix and store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealMatrix& , RealVector& , int , int , int , int destStep )
description:left multiply a vector with a real matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const RealMatrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with a real matrix and use to store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealMatrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceNbrComponent = number of component to take into account in the source vector
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealMatrix& , RealVector& , int , int , int , int destStep )
description:left multiply a vector with a real matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const RealMatrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with a real matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const BlockDiagonalMatrix& , RealVector& V )
description:left multiply a vector with a block-diagonal matrix and use to store result
in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const BlockDiagonalMatrix& , RealVector& V )
description:left multiply a vector with a block-diagonal matrix and add result to the current vector
in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const BlockDiagonalMatrix& , RealVector& , int ,
int , int , int destStep )
description:left multiply a vector with a block-diagonal matrix and use to store result
in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const BlockDiagonalMatrix& , RealVector& , int ,
int , int , int , int destStep )
description:left multiply a vector with a block-diagonal matrix and use to store result
in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const BlockDiagonalMatrix& , RealVector& , int ,
int , int , int destStep )
description:left multiply a vector with a block-diagonal matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const BlockDiagonalMatrix& , RealVector& , int ,
int , int , int , int destStep )
description:left multiply a vector with a block-diagonal matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const Matrix& , RealVector& V )
description:left multiply a vector with a matrix and use to store result in current
vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const Matrix& , RealVector& V )
description:left multiply a vector with a matrix and add result to current
vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const Matrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real matrix and store result in current vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const Matrix& , RealVector& , int , int sourceNbrComponent )
description:do a partial left multication of a vector with a real matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const Matrix& , RealVector& , int , int ,
int , int destStep )
description:left multiply a vector with a matrix and use to store result in current
vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const Matrix& , RealVector& , int , int ,
int , int destStep )
description:left multiply a vector with a matrix and add current
vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
Multiply :
prototype: RealVector& Multiply (const Matrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with a matrix and use to store result in current
vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
AddMultiply :
prototype: RealVector& AddMultiply (const Matrix& , RealVector& , int , int ,
int , int , int destStep )
description:left multiply a vector with a matrix and add current
vector (without creating temporary vector)
input parameters:
M = matrix to use
V = vector to multiply
sourceStart = source vector first coordinate to modify
sourceStep = step to add to go to the following source vector coordinate
sourceNbrComponent = number of component to take into account in the source vector
destStart = destination vector first coordinate to modify
destStep = step to add to go to the following destination vector coordinate
return value: reference on current vector
operator [] :
prototype: double& operator [] (int i )
description:return vector i-th coordinate (without testing if position is valid)
input parameters:
i = coordinate position
Norm :
prototype: double Norm ()
description:get vector norm
input parameters:
return value: vector norm
SqrNorm :
prototype: double SqrNorm ()
description:get square of vector norm
input parameters:
return value: square of vector norm
Normalize :
prototype: RealVector& Normalize ()
description:normalize vector
input parameters:
return value: reference on current vector
Orthonormalized :
prototype: double Orthonormalized (RealVector* , int nbrVectors )
description:orthonormalized a vector with respect to a set of orthonormalized vectors
input parameters:
vectors = vector array corresponding to the set
nbrVectors = number of vectors in the set
return value: resulting vector norm (can be used to see if vector is can be decomposed on vector set)
Extract :
prototype: RealVector Extract (int , int , int step = 1 )
description:Extract a subvector from a given vector
input parameters:
firstCoordinate = Coordinate where extraction has to begin
lastCoordinate = Coordinate where extraction has to stop (extract also include this last coordinate)
step = distance to the next coordinate (1 means to take the folowing)
return value: return corresponding subvector
Merge :
prototype: RealVector& Merge (const RealVector& , int , int step = 1 )
description:Merge a subvector into a given vector
input parameters:
V = vector to merge
firstCoordinate = Coordinate where merge has to begin
step = distance to the next coordinate in the destination vector (1 means to take the following)
return value: reference to the current Vector
WriteVector :
prototype: bool WriteVector (char* fileName )
description:write vector in a file
input parameters:
fileName = name of the file where the vector has to be stored
return value: true if no error occurs
WriteAsciiVector :
prototype: bool WriteAsciiVector (char* fileName )
description:write vector in a file in ascii mode
input parameters:
fileName = name of the file where the vector has to be stored
return value: true if no error occurs
ReadVector :
prototype: bool ReadVector (char* fileName )
description:read vector from a file
input parameters:
fileName = name of the file where the vector has to be read
return value: true if no error occurs
operator << :
prototype: friend ostream& operator << (ostream& , const RealVector& v )
description:Output Stream overload
input parameters:
str = reference on output stream
v = vector to print
return value: reference on output stream
operator >> :
prototype: friend ifstream& operator >> (ifstream& , RealVector& vector )
description:output file stream overload
input parameters:
file = reference on output file stream
vector = reference on vector to save
return value: reference on output file stream
friend ofstream& operator << (ofstream& file, const RealVector& vector);
input file stream overload
input parameters:
file = reference on output file stream
vector = reference on vector to load
return value: reference on output file stream
Back to index.