CxDotProduct

Advanced Analysis Library Only

AnalysisLibErrType CxDotProduct (ComplexNum vectorX[], ComplexNum vectorY[], int numberOfElements, ComplexNum *dotProduct);

Purpose

Calculates the dot product of the complex input arrays. Use the following formula to obtain the dot product d:

Parameters

Input
Name Type Description
vectorX ComplexNum array First complex input vector.

The following C typedef statement defines the ComplexNum structure:

typedef struct {

double real;

double imaginary;

} ComplexNum;
vectorY ComplexNum array Second complex input vector.

The following C typedef statement defines the ComplexNum structure:

typedef struct {

double real;

double imaginary;

} ComplexNum;
numberOfElements integer Number of elements in each vector.
Output
Name Type Description
dotProduct ComplexNum Complex dot product of the input vectors.

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.