clSPARSE.h

Go to the documentation of this file.

/* ************************************************************************
 * Copyright 2015 Advanced Micro Devices, Inc.
 * Copyright 2015 Vratis, Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ************************************************************************ */

#pragma once
#ifndef _CL_SPARSE_H_
#define _CL_SPARSE_H_

// CMake-generated file to define export related preprocessor macros
#include "clsparse_export.h"

#ifdef __cplusplus
extern "C" {
#endif

#if( BUILD_CLVERSION < 200 )
#include "clSPARSE-1x.h"
#else
#error clSPARSE does not yet implement OpenCL 2.0 interfaces
#include "clSPARSE-2x.h"
#endif

    typedef enum clsparseStatus_
    {
        clsparseSuccess = CL_SUCCESS,
        clsparseInvalidValue = CL_INVALID_VALUE,
        clsparseInvalidCommandQueue = CL_INVALID_COMMAND_QUEUE,
        clsparseInvalidContext = CL_INVALID_CONTEXT,
        clsparseInvalidMemObject = CL_INVALID_MEM_OBJECT,
        clsparseInvalidDevice = CL_INVALID_DEVICE,
        clsparseInvalidEventWaitList = CL_INVALID_EVENT_WAIT_LIST,
        clsparseInvalidEvent = CL_INVALID_EVENT,
        clsparseOutOfResources = CL_OUT_OF_RESOURCES,
        clsparseOutOfHostMemory = CL_OUT_OF_HOST_MEMORY,
        clsparseInvalidOperation = CL_INVALID_OPERATION,
        clsparseCompilerNotAvailable = CL_COMPILER_NOT_AVAILABLE,
        clsparseBuildProgramFailure = CL_BUILD_PROGRAM_FAILURE,
        clsparseInvalidKernelArgs = CL_INVALID_KERNEL_ARGS,
        clsparseNotImplemented = -1024,  
        clsparseNotInitialized,          
        clsparseStructInvalid,           
        clsparseInvalidSize,             
        clsparseInvalidMemObj,           
        clsparseInsufficientMemory,      
        clsparseInvalidControlObject,    
        clsparseInvalidFile,             
        clsparseInvalidFileFormat,       
        clsparseInvalidKernelExecution,  
        clsparseInvalidType,             
        clsparseInvalidSolverControlObject = -2048,
        clsparseInvalidSystemSize,
        clsparseIterationsExceeded,
        clsparseToleranceNotReached,
        clsparseSolverError,
    } clsparseStatus;


    CLSPARSE_EXPORT clsparseStatus
        clsparseSetup( void );

    CLSPARSE_EXPORT clsparseStatus
        clsparseTeardown( void );

    CLSPARSE_EXPORT clsparseStatus
        clsparseGetVersion( cl_uint* major, cl_uint* minor, cl_uint* patch, cl_uint* tweak );
    CLSPARSE_EXPORT clsparseStatus
        clsparseInitScalar( clsparseScalar* scalar );

    CLSPARSE_EXPORT clsparseStatus
        clsparseInitVector( cldenseVector* vec );

    CLSPARSE_EXPORT clsparseStatus
        clsparseInitCooMatrix( clsparseCooMatrix* cooMatx );

    CLSPARSE_EXPORT clsparseStatus
        clsparseInitCsrMatrix( clsparseCsrMatrix* csrMatx );

    CLSPARSE_EXPORT clsparseStatus
        cldenseInitMatrix( cldenseMatrix* denseMatx );
    typedef struct _clsparseControl*  clsparseControl;

    typedef struct _clsparseCreateResult
    {
        clsparseStatus status;      
        clsparseControl control;    
    } clsparseCreateResult;

    CLSPARSE_EXPORT clsparseCreateResult
        clsparseCreateControl( cl_command_queue queue );

    CLSPARSE_EXPORT clsparseStatus
        clsparseEnableAsync( clsparseControl control, cl_bool async );

    CLSPARSE_EXPORT clsparseStatus
        clsparseEnableExtendedPrecision( clsparseControl control, cl_bool extPrecision );

    typedef struct _clsparseEventResult
    {
        clsparseStatus status;      
        cl_event event;             
    } clsparseEventResult;

    CLSPARSE_EXPORT clsparseEventResult
        clsparseGetEvent( clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseReleaseControl( clsparseControl control );
    typedef enum _print_mode
    {
        QUIET = 0,
        NORMAL,
        VERBOSE
    } PRINT_MODE;

    typedef enum _precond
    {
        NOPRECOND = 0,
        DIAGONAL
    } PRECONDITIONER;

    typedef struct _solverControl*  clSParseSolverControl;

    typedef struct _clsparseCreateSolverResult
    {
        clsparseStatus status;              
        clSParseSolverControl control;      
    } clsparseCreateSolverResult;

    CLSPARSE_EXPORT clsparseCreateSolverResult
        clsparseCreateSolverControl( PRECONDITIONER precond, cl_int maxIters,
                                     cl_double relTol, cl_double absTol );

    CLSPARSE_EXPORT clsparseStatus
        clsparseReleaseSolverControl( clSParseSolverControl solverControl );

    CLSPARSE_EXPORT clsparseStatus
        clsparseSetSolverParams( clSParseSolverControl solverControl,
                                 PRECONDITIONER precond,
                                 cl_int maxIters, cl_double relTol, cl_double absTol );

    CLSPARSE_EXPORT clsparseStatus
        clsparseSolverPrintMode( clSParseSolverControl solverControl, PRINT_MODE mode );

    CLSPARSE_EXPORT clsparseStatus
        clsparseScsrcg( cldenseVector* x, const clsparseCsrMatrix *A, const cldenseVector *b,
                        clSParseSolverControl solverControl, clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcsrcg( cldenseVector* x, const clsparseCsrMatrix *A, const cldenseVector *b,
                        clSParseSolverControl solverControl, clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseScsrbicgStab( cldenseVector* x, const clsparseCsrMatrix *A, const cldenseVector *b,
                              clSParseSolverControl solverControl, clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcsrbicgStab( cldenseVector* x, const clsparseCsrMatrix *A, const cldenseVector *b,
                              clSParseSolverControl solverControl, clsparseControl control );
    CLSPARSE_EXPORT clsparseStatus
        clsparseHeaderfromFile( clsparseIdx_t* nnz, clsparseIdx_t* row, clsparseIdx_t* col, const char* filePath);

    CLSPARSE_EXPORT clsparseStatus
        clsparseSCooMatrixfromFile( clsparseCooMatrix* cooMatx, const char* filePath, clsparseControl control, cl_bool read_explicit_zeroes );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDCooMatrixfromFile( clsparseCooMatrix* cooMatx, const char* filePath, clsparseControl control, cl_bool read_explicit_zeroes );

    CLSPARSE_EXPORT clsparseStatus
        clsparseSCsrMatrixfromFile( clsparseCsrMatrix* csrMatx, const char* filePath, clsparseControl control, cl_bool read_explicit_zeroes );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDCsrMatrixfromFile( clsparseCsrMatrix* csrMatx, const char* filePath, clsparseControl control, cl_bool read_explicit_zeroes );

    typedef struct _clsparseMetaSizeResult
    {
        clsparseStatus status;      
        clsparseIdx_t metaSize;     
    } clsparseMetaSizeResult;

    CLSPARSE_EXPORT clsparseMetaSizeResult
        clsparseCsrMetaSize( clsparseCsrMatrix* csrMatx, clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseCsrMetaCreate( clsparseCsrMatrix* csrMatx, clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseCsrMetaDelete( clsparseCsrMatrix* csrMatx );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSscale( cldenseVector* r,
                       const clsparseScalar* alpha,
                       const cldenseVector* y,
                       const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDscale( cldenseVector* r,
                       const clsparseScalar* alpha,
                       const cldenseVector* y,
                       const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSaxpy( cldenseVector* r,
                      const clsparseScalar* alpha, const cldenseVector* x,
                      const cldenseVector* y,
                      const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDaxpy( cldenseVector* r,
                      const clsparseScalar* alpha, const cldenseVector* x,
                      const cldenseVector* y,
                      const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSaxpby( cldenseVector* r,
                       const clsparseScalar* alpha, const cldenseVector* x,
                       const clsparseScalar* beta,
                       const cldenseVector* y,
                       const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDaxpby( cldenseVector* r,
                       const clsparseScalar* alpha, const cldenseVector* x,
                       const clsparseScalar* beta,
                       const cldenseVector* y,
                       const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseIreduce( clsparseScalar* s,
                        const cldenseVector* x,
                        const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSreduce( clsparseScalar* s,
                        const cldenseVector* x,
                        const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDreduce( clsparseScalar* s,
                        const cldenseVector* x,
                        const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSnrm1( clsparseScalar* s,
                      const cldenseVector* x,
                      const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDnrm1( clsparseScalar *s,
                      const cldenseVector* x,
                      const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSnrm2( clsparseScalar* s,
                      const cldenseVector* x,
                      const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDnrm2( clsparseScalar* s,
                      const cldenseVector* x,
                      const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSdot( clsparseScalar* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDdot( clsparseScalar* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

                 /* element-wise operations for dense vectors +, -, *, / */

    CLSPARSE_EXPORT clsparseStatus
        cldenseSadd( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDadd( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSsub( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDsub( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSmul( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDmul( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseSdiv( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        cldenseDdiv( cldenseVector* r,
                     const cldenseVector* x,
                     const cldenseVector* y,
                     const clsparseControl control );
    CLSPARSE_EXPORT clsparseStatus
        clsparseScsrmv( const clsparseScalar* alpha,
                        const clsparseCsrMatrix* matx,
                        const cldenseVector* x,
                        const clsparseScalar* beta,
                        cldenseVector* y,
                        const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcsrmv( const clsparseScalar* alpha,
                        const clsparseCsrMatrix* matx,
                        const cldenseVector* x,
                        const clsparseScalar* beta,
                        cldenseVector* y,
                        const clsparseControl control );


    CLSPARSE_EXPORT clsparseStatus
        clsparseScoomv( const clsparseScalar* alpha,
                        const clsparseCooMatrix* matx,
                        const cldenseVector* x,
                        const clsparseScalar* beta,
                        cldenseVector* y,
                        const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcoomv( const clsparseScalar* alpha,
                        const clsparseCooMatrix* matx,
                        const cldenseVector* x,
                        const clsparseScalar* beta,
                        cldenseVector* y,
                        const clsparseControl control );
    CLSPARSE_EXPORT clsparseStatus
        clsparseScsrmm( const clsparseScalar* alpha,
                        const clsparseCsrMatrix* sparseMatA,
                        const cldenseMatrix* denseMatB,
                        const clsparseScalar* beta,
                        cldenseMatrix* denseMatC,
                        const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcsrmm( const clsparseScalar* alpha,
                        const clsparseCsrMatrix* sparseMatA,
                        const cldenseMatrix* denseMatB,
                        const clsparseScalar* beta,
                        cldenseMatrix* denseMatC,
                        const clsparseControl control );

   CLSPARSE_EXPORT clsparseStatus
      clsparseScsrSpGemm( const clsparseCsrMatrix* sparseMatA,
                          const clsparseCsrMatrix* sparseMatB,
                                clsparseCsrMatrix* sparseMatC,
                          const clsparseControl control );
    CLSPARSE_EXPORT clsparseStatus
        clsparseScsr2coo( const clsparseCsrMatrix* csr,
                          clsparseCooMatrix* coo,
                          const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcsr2coo( const clsparseCsrMatrix* csr,
                          clsparseCooMatrix* coo,
                          const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseScoo2csr( const clsparseCooMatrix* coo,
                          clsparseCsrMatrix* csr,
                          const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcoo2csr( const clsparseCooMatrix* coo,
                          clsparseCsrMatrix* csr,
                          const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseScsr2dense( const clsparseCsrMatrix* csr,
                            cldenseMatrix* A,
                            const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDcsr2dense( const clsparseCsrMatrix* csr,
                            cldenseMatrix* A,
                            clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseSdense2csr( const cldenseMatrix* A,
                            clsparseCsrMatrix* csr,
                            const clsparseControl control );

    CLSPARSE_EXPORT clsparseStatus
        clsparseDdense2csr( const cldenseMatrix* A, clsparseCsrMatrix* csr,
                            const clsparseControl control );
#ifdef __cplusplus
}      // extern C
#endif

#endif // _CL_SPARSE_H_