GPUVector.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 __GPUVECTOR_H__
#define __GPUVECTOR_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
{
    template <class, class, class> class vector_base;
    template <class> class const_entry_proxy;
    template <class> class entry_proxy;

    namespace backend
    {
        class mem_handle;
    }
}

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

namespace shogun
{

template <class T> class CGPUVector
{

    typedef viennacl::vector_base<T, std::size_t, std::ptrdiff_t> VCLVectorBase;
    typedef viennacl::backend::mem_handle VCLMemoryArray;

    typedef Eigen::Matrix<T,-1,1,0,-1,1> EigenVectorXt;
    typedef Eigen::Matrix<T,1,-1,0x1,1,-1> EigenRowVectorXt;

public:
    typedef T Scalar;

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

    CGPUVector();

    CGPUVector(index_t length);

    CGPUVector(std::shared_ptr<VCLMemoryArray> mem, index_t length, index_t mem_offset=0);

    CGPUVector(const SGVector<T>& cpu_vec);

    CGPUVector(const EigenVectorXt& cpu_vec);

    CGPUVector(const EigenRowVectorXt& cpu_vec);

    operator EigenVectorXt() const;

    operator EigenRowVectorXt() const;


    inline VCLVectorBase data()
    {
        return vcl_vector();
    }

    inline index_t size() const
    {
        return vlen;
    }

    operator SGVector<T>() const;

    VCLVectorBase vcl_vector();

    void zero();

    void set_const(T value);

    void display_vector(const char* name="vector") const;

    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> vector;

    index_t offset;

    index_t vlen;
};

}
#endif // SWIG

#endif // HAVE_CXX11
#endif // HAVE_VIENNACL
#endif // __GPUVECTOR_H__