Class : TensorProductRealVector
TensorProductRealVector :
prototype: TensorProductRealVector ()
description:default constructor
TensorProductRealVector :
prototype: TensorProductRealVector (AbstractTensorProductStructure* , bool zeroFlag = false )
description:constructor for an empty tensor product real vector
input parameters:
struture = reference on tensor product structure
zeroFlag = true if all coordinates have to be set to zero
TensorProductRealVector :
prototype: TensorProductRealVector (AbstractTensorProductStructure* , double* array )
description:constructor from an array of doubles
input parameters:
struture = reference on tensor product structure
array = array of doublesn
TensorProductRealVector :
prototype: TensorProductRealVector (AbstractTensorProductStructure* , RealVector& v )
description:constructor from a real vector
input parameters:
struture = reference on tensor product structure
v = reference on vector containing datas
TensorProductRealVector :
prototype: TensorProductRealVector (const TensorProductRealVector& , bool duplicateFlag = false )
description:copy constructor
input parameters:
vector = vector to copy
duplicateFlag = true if datas have to be duplicated
~TensorProductRealVector :
prototype: ~TensorProductRealVector ()
description:destructor
operator = :
prototype: TensorProductRealVector& operator = (const TensorProductRealVector& vector )
description:assignement
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
Resize :
prototype: void Resize (AbstractTensorProductStructure* structure )
description:Resize vector
input parameters:
structure = new product tensor structure
ResizeAndClean :
prototype: void ResizeAndClean (AbstractTensorProductStructure* structure )
description:Resize vector and set to zero all components that have been added
input parameters:
structure = new product tensor structure
operator - :
prototype: TensorProductRealVector& operator - ()
description:change sign of a vector
input parameters:
return value: reference on current vector
operator - :
prototype: friend TensorProductRealVector operator - (const TensorProductRealVector& 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 TensorProductRealVector& , const TensorProductRealVector& V2 )
description:scalar product between two vectors
input parameters:
V1 = first vector
V2 = second vector
return value: result of scalar product
operator += :
prototype: TensorProductRealVector& operator += (const TensorProductRealVector& V1 )
description:sum two vectors
input parameters:
V1 = vector to add
return value: reference on current vector
operator -= :
prototype: TensorProductRealVector& operator -= (const TensorProductRealVector& V1 )
description:substract two vectors
input parameters:
V1 = first vector
return value: reference on current vector
operator + :
prototype: friend TensorProductRealVector operator + (const TensorProductRealVector& , const TensorProductRealVector& V2 )
description:sum two vectors
input parameters:
V1 = first vector
V2 = second vector
return value: resulting vector
operator - :
prototype: friend TensorProductRealVector operator - (const TensorProductRealVector& , const TensorProductRealVector& V2 )
description:substract two vectors
input parameters:
V1 = first vector
V2 = second vector
return value: resulting vector
AddLinearCombination :
prototype: TensorProductRealVector& AddLinearCombination (double , const TensorProductRealVector& 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: TensorProductRealVector& AddLinearCombination (double , const TensorProductRealVector& , double ,
const TensorProductRealVector& 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
operator * :
prototype: friend TensorProductRealVector operator * (const TensorProductRealVector& , 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 TensorProductRealVector operator * (double , const TensorProductRealVector& 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: TensorProductRealVector& 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: TensorProductRealVector& 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: TensorProductRealVector& 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: TensorProductRealVector& 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: TensorProductRealVector& Multiply (const RealSymmetricMatrix& , TensorProductRealVector& 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
AddMultiply :
prototype: TensorProductRealVector& AddMultiply (const RealSymmetricMatrix& , TensorProductRealVector& , int , int step )
description:left multiply a vector with a symmetric matrix and add result to the current vector
input parameters:
M = matrix to use
V = vector to multiply
start = vector first coordinate to modify
step = step to add to go to the following vector coordinate
return value: reference on current vector
Multiply :
prototype: TensorProductRealVector& Multiply (const RealMatrix& , TensorProductRealVector& 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: TensorProductRealVector& Multiply (const OneSpaceTensor& , TensorProductRealVector& V )
description:left multiply a vector with a one space tensor and use to store result
in current vector (without creating temporary vector)
input parameters:
T = tensor to use
V = vector to multiply
return value: reference on current vector
Multiply :
prototype: TensorProductRealVector& Multiply (const OneSpaceTensor& , TensorProductRealVector& , int , int nbrComponent )
description:left multiply a vector with a one space tensor for a given range of indices
and use to store result in current vector (without creating temporary vector)
input parameters:
T = tensor to use
V = vector to multiply
firstComponent = index of the first component to evaluate
nbrComponent = number of components to evaluate
return value: reference on current vector
AddMultiply :
prototype: TensorProductRealVector& AddMultiply (const OneSpaceTensor& , TensorProductRealVector& V )
description:left multiply a vector with a one space tensor and
add result to current vector (without creating temporary vector)
input parameters:
T = tensor to use
V = vector to multiply
return value: reference on current vector
AddMultiply :
prototype: TensorProductRealVector& AddMultiply (const OneSpaceTensor& , TensorProductRealVector& , int , int nbrComponent )
description:left multiply a vector with a one space tensor for a given range of indices
and add result to current vector (without creating temporary vector)
input parameters:
T = tensor to use
V = vector to multiply
firstComponent = index of the first component to evaluate
nbrComponent = number of components to evaluate
return value: reference on current vector
Multiply :
prototype: TensorProductRealVector& Multiply (const TwoSpaceTensor& , TensorProductRealVector& V )
description:left multiply a vector with a two space tensor and
use to store result in current vector (without creating temporary vector)
input parameters:
T = tensor to use
V = vector to multiply
return value: reference on current vector
operator [] :
prototype: double& operator [] (int i )
description:return vector i-th global coordinate (without testing if position is valid)
input parameters:
i = global coordinate position
return value: reference on indexed coordinate
operator [] :
prototype: double& operator [] (TensorProductIndex& index )
description:return vector coordinate corresponding to a tensor product index
input parameters:
index = tensor product index
return value: reference on indexed coordinate
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: TensorProductRealVector& Normalize ()
description:normalize vector
input parameters:
return value: reference on current vector
Back to index.