The SDL Component Suite is an industry leading collection of components supporting scientific and engineering computing. Please visit the SDL Web site for more information....


Home MathPack Vector Methods Correlate
See also: SMult, DotProduct, PearsonCorrCoeff 

Correlate


Unit:SDL_vector
Class: TVector, TIntVector
Declaration: function Correlate (OtherVec: TVector; ElemShift: integer): double;{ class TVector }
function Correlate (OtherVec: TIntVector; ElemShift: integer): integer;{ class TIntVector }

The function Correlate calculates and returns the (shifted) dot product (inner product) of the two vectors self and OtherVec. The parameter ElemShift specifies the number of Elements the vector OtherVec is shifted before the dot product is calculated. A value of ElemShift = 0 results in the normal dot product.

Hint: Please note that the two vectors self and OtherVec need not be of equal length. Vector elements which are not available during the calculation are assumed to be zero.


Last Update: 2023-Feb-06