BLAS Level 1 Single

Functions
iclblasStatus_t	iclblasScopy (iclblasHandle_t handle, int n, float *x, int incx, float *y, int incy)
	Copy the elements from the vector x to the vector y. More...
iclblasStatus_t	iclblasSscal (iclblasHandle_t handle, int n, const float *alpha, float *x, int incx)
	Multiply the vector by the scalar. More...
iclblasStatus_t	iclblasSaxpy (iclblasHandle_t handle, int n, const float *alpha, float *x, int incx, float *y, int incy)
	Multiply the vector x by the scalar and add it to the vector y. More...
iclblasStatus_t	iclblasSnrm2 (iclblasHandle_t handle, int n, float *x, int incx, float *result)
	Computes the Euclidean norm of the vector x. More...
iclblasStatus_t	iclblasSrotmg (iclblasHandle_t handle, float *d1, float *d2, float *x1, const float *y1, float *params)
	Constructs the modified Givens transformation. More...
iclblasStatus_t	iclblasIsamax (iclblasHandle_t handle, int n, float *x, int incx, int *result)
	Computes the first index of the highest value in vector x. More...
iclblasStatus_t	iclblasIsamin (iclblasHandle_t handle, int n, float *x, int incx, int *result)
	Computes the first index of the lowest value in vector x. More...
iclblasStatus_t	iclblasSswap (iclblasHandle_t handle, int n, float *x, int incx, float *y, int incy)
	Interchanges two vectors x and y. More...
iclblasStatus_t	iclblasSrot (iclblasHandle_t handle, int n, float *x, int incx, float *y, int incy, float c, float s)
	Applies Givens rotation matrix. More...
iclblasStatus_t	iclblasSrotm (iclblasHandle_t handle, int n, float *x, int incx, float *y, int incy, float *param)
	Applies modified Givens rotation matrix. More...
iclblasStatus_t	iclblasSasum (iclblasHandle_t handle, int n, float *x, int incx, float *result)
	Computes the sum of the absolute values from vector x. More...
iclblasStatus_t	iclblasSrotg (iclblasHandle_t handle, float *a, float *b, float *c, float *s)
	Creates the Givens rotation matrix. More...
iclblasStatus_t	iclblasSdot (iclblasHandle_t handle, int n, float *x, int incx, float *y, int incy, float *result)
	Computes the dot product from vector x and vector y. More...

Detailed Description

Function Documentation

iclblasIsamax()

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

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

Where x is n element 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	calculated index

iclblasIsamin()

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

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

Where x is n element 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	calculated index

iclblasSasum()

iclblasStatus_t iclblasSasum	(	iclblasHandle_t	handle,
		int	n,
		float *	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

iclblasSaxpy()

iclblasStatus_t iclblasSaxpy	(	iclblasHandle_t	handle,
		int	n,
		const float *	alpha,
		float *	x,
		int	incx,
		float *	y,
		int	incy
	)

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

y = alpha * x + y

Where x and y are n element vectors

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in]	alpha	scalar used in multiplication
[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

iclblasScopy()

iclblasStatus_t iclblasScopy	(	iclblasHandle_t	handle,
		int	n,
		float *	x,
		int	incx,
		float *	y,
		int	incy
	)

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

y = x

Where x and y are 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

iclblasSdot()

iclblasStatus_t iclblasSdot	(	iclblasHandle_t	handle,
		int	n,
		float *	x,
		int	incx,
		float *	y,
		int	incy,
		float *	result
	)

Computes the dot product from vector x and vector y.

Where x and y are n elements 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]	y	vector of size at least n * incy
[in]	incy	stride between elements in y; should be at least 1
[out]	result	result of the calculation

iclblasSnrm2()

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

Computes the Euclidean norm of the 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

iclblasSrot()

iclblasStatus_t iclblasSrot	(	iclblasHandle_t	handle,
		int	n,
		float *	x,
		int	incx,
		float *	y,
		int	incy,
		float	c,
		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	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
[in]	c	cosine of the rotation matrix
[in]	s	sine of the rotation matrix

iclblasSrotg()

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

Creates the Givens rotation matrix.

Parameters

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

iclblasSrotm()

iclblasStatus_t iclblasSrotm	(	iclblasHandle_t	handle,
		int	n,
		float *	x,
		int	incx,
		float *	y,
		int	incy,
		float *	param
	)

Applies modified Givens rotation matrix.

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in,out]	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
[in]	param	vector of 5 elements, param[0] contain the flag, param[1-4] contain the matrix H

iclblasSrotmg()

iclblasStatus_t iclblasSrotmg	(	iclblasHandle_t	handle,
		float *	d1,
		float *	d2,
		float *	x1,
		const float *	y1,
		float *	params
	)

Constructs the modified Givens transformation.

Parameters

[in]	handle	handle to the library context
[in,out]	d1	scalar result of the computation
[in,out]	d2	scalar result of the computation
[in,out]	x1	scalar result of the computation
[in]	y1	scalar
[out]	params	vector of 5 elements, param[0] contain the flag, param[1-4] contain the matrix H

iclblasSscal()

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

Multiply the vector by the scalar.

x = alpha * x

Where x is 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	vector of size at least n * incx
[in]	incx	stride between elements in x; should be at least 1

iclblasSswap()

iclblasStatus_t iclblasSswap	(	iclblasHandle_t	handle,
		int	n,
		float *	x,
		int	incx,
		float *	y,
		int	incy
	)

Interchanges two vectors x and y.

y = x, x = y

Where x and y are n element vectors

Parameters

[in]	handle	handle to the library context
[in]	n	number of elements in x and y
[in,out]	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