clblas types

Typedefs
typedef enum clblasOrder_	clblasOrder
typedef enum clblasTranspose_	clblasTranspose
typedef enum clblasUplo_	clblasUplo
typedef enum clblasDiag_	clblasDiag
typedef enum clblasSide_	clblasSide
typedef enum clblasStatus_	clblasStatus
	clblas error codes definition, incorporating OpenCL error definitions. More...

Enumerations
enum	clblasOrder_ { clblasRowMajor, clblasColumnMajor }
enum	clblasTranspose_ { clblasNoTrans, clblasTrans, clblasConjTrans }
enum	clblasUplo_ { clblasUpper, clblasLower }
enum	clblasDiag_ { clblasUnit, clblasNonUnit }
enum	clblasSide_ { clblasLeft, clblasRight }
enum	clblasStatus_ {   clblasSuccess = CL_SUCCESS, clblasInvalidValue = CL_INVALID_VALUE, clblasInvalidCommandQueue = CL_INVALID_COMMAND_QUEUE, clblasInvalidContext = CL_INVALID_CONTEXT,   clblasInvalidMemObject = CL_INVALID_MEM_OBJECT, clblasInvalidDevice = CL_INVALID_DEVICE, clblasInvalidEventWaitList = CL_INVALID_EVENT_WAIT_LIST, clblasOutOfResources = CL_OUT_OF_RESOURCES,   clblasOutOfHostMemory = CL_OUT_OF_HOST_MEMORY, clblasInvalidOperation = CL_INVALID_OPERATION, clblasCompilerNotAvailable = CL_COMPILER_NOT_AVAILABLE, clblasBuildProgramFailure = CL_BUILD_PROGRAM_FAILURE,   clblasNotImplemented = -1024, clblasNotInitialized, clblasInvalidMatA, clblasInvalidMatB,   clblasInvalidMatC, clblasInvalidVecX, clblasInvalidVecY, clblasInvalidDim,   clblasInvalidLeadDimA, clblasInvalidLeadDimB, clblasInvalidLeadDimC, clblasInvalidIncX,   clblasInvalidIncY, clblasInsufficientMemMatA, clblasInsufficientMemMatB, clblasInsufficientMemMatC,   clblasInsufficientMemVecX, clblasInsufficientMemVecY }
	clblas error codes definition, incorporating OpenCL error definitions. More...

Detailed Description

Typedef Documentation

typedef enum clblasDiag_ clblasDiag

It is used by the triangular matrix routines to specify whether the matrix is unit triangular.

typedef enum clblasOrder_ clblasOrder

Shows how matrices are placed in memory.

typedef enum clblasSide_ clblasSide

Indicates the side matrix A is located relative to matrix B during multiplication.

typedef enum clblasStatus_ clblasStatus

clblas error codes definition, incorporating OpenCL error definitions.

This enumeration is a subset of the OpenCL error codes extended with some additional extra codes. For example, CL_OUT_OF_HOST_MEMORY, which is defined in cl.h is aliased as clblasOutOfHostMemory.

typedef enum clblasTranspose_ clblasTranspose

Used to specify whether the matrix is to be transposed or not.

typedef enum clblasUplo_ clblasUplo

Used by the Hermitian, symmetric and triangular matrix routines to specify whether the upper or lower triangle is being referenced.

Enumeration Type Documentation

enum clblasDiag_

It is used by the triangular matrix routines to specify whether the matrix is unit triangular.

Enumerator
clblasUnit	Unit triangular.
clblasNonUnit	Non-unit triangular.

enum clblasOrder_

Shows how matrices are placed in memory.

Enumerator
clblasRowMajor	Every row is placed sequentially
clblasColumnMajor	Every column is placed sequentially

enum clblasSide_

Indicates the side matrix A is located relative to matrix B during multiplication.

Enumerator
clblasLeft	Multiply general matrix by symmetric, Hermitian or triangular matrix on the left.
clblasRight	Multiply general matrix by symmetric, Hermitian or triangular matrix on the right.

enum clblasStatus_

clblas error codes definition, incorporating OpenCL error definitions.

This enumeration is a subset of the OpenCL error codes extended with some additional extra codes. For example, CL_OUT_OF_HOST_MEMORY, which is defined in cl.h is aliased as clblasOutOfHostMemory.

Enumerator
clblasNotImplemented	Functionality is not implemented
clblasNotInitialized	clblas library is not initialized yet
clblasInvalidMatA	Matrix A is not a valid memory object
clblasInvalidMatB	Matrix B is not a valid memory object
clblasInvalidMatC	Matrix C is not a valid memory object
clblasInvalidVecX	Vector X is not a valid memory object
clblasInvalidVecY	Vector Y is not a valid memory object
clblasInvalidDim	An input dimension (M,N,K) is invalid
clblasInvalidLeadDimA	Leading dimension A must not be less than the size of the first dimension
clblasInvalidLeadDimB	Leading dimension B must not be less than the size of the second dimension
clblasInvalidLeadDimC	Leading dimension C must not be less than the size of the third dimension
clblasInvalidIncX	The increment for a vector X must not be 0
clblasInvalidIncY	The increment for a vector Y must not be 0
clblasInsufficientMemMatA	The memory object for Matrix A is too small
clblasInsufficientMemMatB	The memory object for Matrix B is too small
clblasInsufficientMemMatC	The memory object for Matrix C is too small
clblasInsufficientMemVecX	The memory object for Vector X is too small
clblasInsufficientMemVecY	The memory object for Vector Y is too small

enum clblasTranspose_

Used to specify whether the matrix is to be transposed or not.

Enumerator
clblasNoTrans	Operate with the matrix.
clblasTrans	Operate with the transpose of the matrix.
clblasConjTrans	Operate with the conjugate transpose of the matrix.

enum clblasUplo_

Used by the Hermitian, symmetric and triangular matrix routines to specify whether the upper or lower triangle is being referenced.

Enumerator
clblasUpper	Upper triangle.
clblasLower	Lower triangle.