GPUMatrix.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014, Shogun Toolbox Foundation
 * All rights reserved.
 *
 * Written (W) 2014 Khaled Nasr
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:

 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __GPUMATRIX_H__
#define __GPUMATRIX_H__

#include <shogun/lib/config.h>

#ifdef HAVE_VIENNACL
#ifdef HAVE_CXX11

#include <shogun/lib/common.h>
#include <memory>

#ifndef SWIG // SWIG should skip this part
namespace viennacl
{
#if VIENNACL_VERSION >= 10600
    template <class, class, class> class matrix_base;
#else
    template <class, class, class, class> class matrix_base;
#endif
    template <class> class const_entry_proxy;
    template <class> class entry_proxy;
    struct column_major;

    namespace backend
    {
        class mem_handle;
    }
}

namespace Eigen
{
    template <class, int, int, int, int, int> class Matrix;
}

namespace shogun
{

template <class> class SGMatrix;

template <class T> class CGPUMatrix
{
#if VIENNACL_VERSION >= 10600
    typedef viennacl::matrix_base<T, std::size_t, std::ptrdiff_t> VCLMatrixBase;
#else
    typedef viennacl::matrix_base<T, viennacl::column_major, std::size_t, std::ptrdiff_t> VCLMatrixBase;
#endif
    typedef viennacl::backend::mem_handle VCLMemoryArray;

    typedef Eigen::Matrix<T,-1,-1,0,-1,-1> EigenMatrixXt;

public:
    typedef T Scalar;

    template <typename ST> using container_type = CGPUMatrix<ST>;

    CGPUMatrix();

    CGPUMatrix(index_t nrows, index_t ncols);

    CGPUMatrix(std::shared_ptr<VCLMemoryArray> mem, index_t nrows, index_t ncols,
        index_t mem_offset=0);

    CGPUMatrix(const SGMatrix<T>& cpu_mat);

    operator SGMatrix<T>() const;

    CGPUMatrix(const EigenMatrixXt& cpu_mat);

    operator EigenMatrixXt() const;

    inline VCLMatrixBase data()
    {
        return vcl_matrix();
    }

    inline uint64_t size() const
    {
        const uint64_t c=num_cols;
        return num_rows*c;
    }

    VCLMatrixBase vcl_matrix();

    void zero();

    void set_const(T value);

    void display_matrix(const char* name="matrix") const;

    viennacl::const_entry_proxy<T> operator()(index_t i, index_t j) const;

    viennacl::entry_proxy<T> operator()(index_t i, index_t j);

    viennacl::const_entry_proxy<T> operator[](index_t index) const;

    viennacl::entry_proxy<T> operator[](index_t index);

private:
    void init();

public:
    std::shared_ptr<VCLMemoryArray> matrix;

    index_t offset;

    index_t num_rows;

    index_t num_cols;
};

}
#endif // SWIG

#endif // HAVE_CXX11
#endif // HAVE_VIENNACL
#endif // __GPUMATRIX_H__