BLAS Level 1 Complex

Functions
iclblasStatus_t	iclblasCcopy (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, oclComplex_t *y, int incy)
	Copy the elements from the vector x to the vector y. More...
iclblasStatus_t	iclblasCscal (iclblasHandle_t handle, int n, const oclComplex_t *alpha, oclComplex_t *x, int incx)
	Multiply the complex vector by the scalar. More...
iclblasStatus_t	iclblasCsscal (iclblasHandle_t handle, int n, const float *alpha, oclComplex_t *x, int incx)
	Multiply the complex vector by the scalar. More...
iclblasStatus_t	iclblasCswap (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, oclComplex_t *y, int incy)
	Interchanges two complex vectors x and y. More...
iclblasStatus_t	iclblasCdotu (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, oclComplex_t *y, int incy, oclComplex_t *result)
	Computes the dot product from complex vector x and vector y. More...
iclblasStatus_t	iclblasScnrm2 (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, float *result)
	Computes the Euclidean norm of the complex vector x. More...
iclblasStatus_t	iclblasIcamax (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, int *result)
	Computes the first index of the highest magnitude value in complex vector x. More...
iclblasStatus_t	iclblasIcamin (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, int *result)
	Computes the first index of the lowest magnitude value in complex vector x. More...
iclblasStatus_t	iclblasCaxpy (iclblasHandle_t handle, int n, const oclComplex_t *alpha, oclComplex_t *x, int incx, oclComplex_t *y, int incy)
	Multiply the complex vector x by the complex scalar and add it to the complex vector y. More...
iclblasStatus_t	iclblasCrotg (iclblasHandle_t handle, oclComplex_t *a, oclComplex_t *b, float *c, oclComplex_t *s)
	Creates the Givens rotation matrix. More...
iclblasStatus_t	iclblasCdotc (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, oclComplex_t *y, int incy, oclComplex_t *result)
	Computes the dot product from complex vector x and vector y. More...
iclblasStatus_t	iclblasCrot (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, oclComplex_t *y, int incy, const float *c, const oclComplex_t *s)
	Applies Givens rotation matrix. More...
iclblasStatus_t	iclblasCsrot (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, oclComplex_t *y, int incy, const float *c, const float *s)
	Applies Givens rotation matrix. More...
iclblasStatus_t	iclblasScasum (iclblasHandle_t handle, int n, oclComplex_t *x, int incx, float *result)
	Computes the sum of the absolute values from vector x. More...

Detailed Description

Function Documentation

iclblasCaxpy()

iclblasStatus_t iclblasCaxpy	(	iclblasHandle_t	handle,
		int	n,
		const oclComplex_t *	alpha,
		oclComplex_t *	x,
		int	incx,
		oclComplex_t *	y,
		int	incy
	)

Multiply the complex vector x by the complex scalar and add it to the complex vector y.

y = alpha * x + y

Where x and y are complex n element vectors

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in]	alpha	complex scalar used in multiplication
[in]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in,out]	y	complex vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1

iclblasCcopy()

iclblasStatus_t iclblasCcopy	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		oclComplex_t *	y,
		int	incy
	)

Copy the elements from the vector x to the vector y.

y = x

Where x and y are complex n element vectors

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in]	x	vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in,out]	y	vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1

iclblasCdotc()

iclblasStatus_t iclblasCdotc	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		oclComplex_t *	y,
		int	incy,
		oclComplex_t *	result
	)

Computes the dot product from complex vector x and vector y.

result = x^H * y

Where x and y are complex n element vectors; and H - complex conjugation on elements of x

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in]	y	complex vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1
[out]	result	calculated dot product

iclblasCdotu()

iclblasStatus_t iclblasCdotu	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		oclComplex_t *	y,
		int	incy,
		oclComplex_t *	result
	)

Computes the dot product from complex vector x and vector y.

result = x^T * y

Where x and y are complex n element vectors

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in]	y	complex vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1
[out]	result	calculated dot product

iclblasCrot()

iclblasStatus_t iclblasCrot	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		oclComplex_t *	y,
		int	incy,
		const float *	c,
		const oclComplex_t *	s
	)

Applies Givens rotation matrix.

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in,out]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in,out]	y	complex vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1
[in]	c	cosine of the rotation matrix
[in]	s	sine of the rotation matrix

iclblasCrotg()

iclblasStatus_t iclblasCrotg	(	iclblasHandle_t	handle,
		oclComplex_t *	a,
		oclComplex_t *	b,
		float *	c,
		oclComplex_t *	s
	)

Creates the Givens rotation matrix.

Parameters

[in]	handle	handle to the library context
[in,out]	a	complex scalar, later overwritten with r
[in,out]	b	complex scalar, later overwritten with z
[out]	c	Contains the parameter c associated with the Givens rotation.
[out]	s	complex Contains the parameter s associated with the Givens rotation.

iclblasCscal()

iclblasStatus_t iclblasCscal	(	iclblasHandle_t	handle,
		int	n,
		const oclComplex_t *	alpha,
		oclComplex_t *	x,
		int	incx
	)

Multiply the complex vector by the scalar.

x = alpha * x

Where x is complex n element vector

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x
[in]	alpha	complex scalar used in multiplication
[in,out]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1

iclblasCsrot()

iclblasStatus_t iclblasCsrot	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		oclComplex_t *	y,
		int	incy,
		const float *	c,
		const float *	s
	)

Applies Givens rotation matrix.

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in,out]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in,out]	y	complex vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1
[in]	c	cosine of the rotation matrix
[in]	s	sine of the rotation matrix

iclblasCsscal()

iclblasStatus_t iclblasCsscal	(	iclblasHandle_t	handle,
		int	n,
		const float *	alpha,
		oclComplex_t *	x,
		int	incx
	)

Multiply the complex vector by the scalar.

x = alpha * x

Where x is complex n element vector

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x
[in]	alpha	scalar used in multiplication
[in,out]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1

iclblasCswap()

iclblasStatus_t iclblasCswap	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		oclComplex_t *	y,
		int	incy
	)

Interchanges two complex vectors x and y.

y = x, x = y

Where x and y are complex n element vectors

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in,out]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in,out]	y	complex vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1

iclblasIcamax()

iclblasStatus_t iclblasIcamax	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		int *	result
	)

Computes the first index of the highest magnitude value in complex vector x.

Where x is complex n element vector

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x
[in]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[out]	result	calculated index

iclblasIcamin()

iclblasStatus_t iclblasIcamin	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		int *	result
	)

Computes the first index of the lowest magnitude value in complex vector x.

Where x is complex n element vector

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x
[in]	x	complex vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[in,out]	result	calculated index

iclblasScasum()

iclblasStatus_t iclblasScasum	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		float *	result
	)

Computes the sum of the absolute values from vector x.

Where x is n elements vector

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x
[in]	x	vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[out]	result	result of the calculation

iclblasScnrm2()

iclblasStatus_t iclblasScnrm2	(	iclblasHandle_t	handle,
		int	n,
		oclComplex_t *	x,
		int	incx,
		float *	result
	)

Computes the Euclidean norm of the complex vector x.

Where x is n element vector

Parameters

[in]	handle	handle to the library context
[in]	n	number of computed elements
[in]	x	vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1
[out]	result	Computed Euclidean norm