SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
GPUMatrix.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014, Shogun Toolbox Foundation
3  * All rights reserved.
4  *
5  * Written (W) 2014 Khaled Nasr
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9 
10  * 1. Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from this
19  * software without specific prior written permission.
20 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef __GPUMATRIX_H__
35 #define __GPUMATRIX_H__
36 
37 #include <shogun/lib/config.h>
38 
39 #ifdef HAVE_VIENNACL
40 #ifdef HAVE_CXX11
41 
42 #include <shogun/lib/common.h>
43 
44 #include <memory>
45 
46 namespace viennacl
47 {
48  template <class, class, class, class> class matrix_base;
49  template <class> class const_entry_proxy;
50  template <class> class entry_proxy;
51  class column_major;
52 
53  namespace backend
54  {
55  class mem_handle;
56  }
57 }
58 
59 namespace Eigen
60 {
61  template <class, int, int, int, int, int> class Matrix;
62 }
63 
64 namespace shogun
65 {
66 
67 template <class> class SGMatrix;
68 
80 template <class T> class CGPUMatrix
81 {
82  typedef viennacl::matrix_base<T, viennacl::column_major, std::size_t, std::ptrdiff_t> VCLMatrixBase;
83  typedef viennacl::backend::mem_handle VCLMemoryArray;
84 
85  typedef Eigen::Matrix<T,-1,-1,0,-1,-1> EigenMatrixXt;
86 
87 public:
89  typedef T Scalar;
90 
92  CGPUMatrix();
93 
99  CGPUMatrix(index_t nrows, index_t ncols);
100 
109  CGPUMatrix(std::shared_ptr<VCLMemoryArray> mem, index_t nrows, index_t ncols,
110  index_t mem_offset=0);
111 
113  CGPUMatrix(const SGMatrix<T>& cpu_mat);
114 
115 #ifndef SWIG // SWIG should skip this part
116 #ifdef HAVE_EIGEN3
117  CGPUMatrix(const EigenMatrixXt& cpu_mat);
118 
120  operator EigenMatrixXt() const;
121 #endif
122 #endif
123 
125  operator SGMatrix<T>() const;
126 
130  VCLMatrixBase vcl_matrix();
131 
133  void zero();
134 
139  void set_const(T value);
140 
142  void display_matrix(const char* name="matrix") const;
143 
150  viennacl::const_entry_proxy<T> operator()(index_t i, index_t j) const;
151 
158  viennacl::entry_proxy<T> operator()(index_t i, index_t j);
159 
165  viennacl::const_entry_proxy<T> operator[](index_t index) const;
166 
172  viennacl::entry_proxy<T> operator[](index_t index);
173 
174 private:
175  void init();
176 
177 public:
179  std::shared_ptr<VCLMemoryArray> matrix;
180 
184  index_t offset;
185 
187  index_t num_rows;
188 
190  index_t num_cols;
191 };
192 
193 }
194 
195 #endif // HAVE_CXX11
196 #endif // HAVE_VIENNACL
197 #endif // __GPUMATRIX_H__
int32_t index_t
Definition: common.h:62
Definition: SGMatrix.h:20
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18

SHOGUN Machine Learning Toolbox - Documentation