SHOGUN  6.1.3
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 #include <memory>
44 
45 #ifndef SWIG // SWIG should skip this part
46 namespace viennacl
47 {
48 #if VIENNACL_VERSION >= 10600
49  template <class, class, class> class matrix_base;
50 #else
51  template <class, class, class, class> class matrix_base;
52 #endif
53  template <class> class const_entry_proxy;
54  template <class> class entry_proxy;
55  struct column_major;
56 
57  namespace backend
58  {
59  class mem_handle;
60  }
61 }
62 
63 namespace Eigen
64 {
65  template <class, int, int, int, int, int> class Matrix;
66 }
67 
68 namespace shogun
69 {
70 
71 template <class> class SGMatrix;
72 
84 template <class T> class CGPUMatrix
85 {
86 #if VIENNACL_VERSION >= 10600
87  typedef viennacl::matrix_base<T, std::size_t, std::ptrdiff_t> VCLMatrixBase;
88 #else
89  typedef viennacl::matrix_base<T, viennacl::column_major, std::size_t, std::ptrdiff_t> VCLMatrixBase;
90 #endif
91  typedef viennacl::backend::mem_handle VCLMemoryArray;
92 
93  typedef Eigen::Matrix<T,-1,-1,0,-1,-1> EigenMatrixXt;
94 
95 public:
97  typedef T Scalar;
98 
100  template <typename ST> using container_type = CGPUMatrix<ST>;
101 
103  CGPUMatrix();
104 
110  CGPUMatrix(index_t nrows, index_t ncols);
111 
120  CGPUMatrix(std::shared_ptr<VCLMemoryArray> mem, index_t nrows, index_t ncols,
121  index_t mem_offset=0);
122 
124  CGPUMatrix(const SGMatrix<T>& cpu_mat);
125 
127  operator SGMatrix<T>() const;
128 
130  CGPUMatrix(const EigenMatrixXt& cpu_mat);
131 
133  operator EigenMatrixXt() const;
134 
136  inline VCLMatrixBase data()
137  {
138  return vcl_matrix();
139  }
140 
142  inline uint64_t size() const
143  {
144  const uint64_t c=num_cols;
145  return num_rows*c;
146  }
147 
151  VCLMatrixBase vcl_matrix();
152 
154  void zero();
155 
160  void set_const(T value);
161 
163  void display_matrix(const char* name="matrix") const;
164 
171  viennacl::const_entry_proxy<T> operator()(index_t i, index_t j) const;
172 
179  viennacl::entry_proxy<T> operator()(index_t i, index_t j);
180 
186  viennacl::const_entry_proxy<T> operator[](index_t index) const;
187 
193  viennacl::entry_proxy<T> operator[](index_t index);
194 
195 private:
196  void init();
197 
198 public:
200  std::shared_ptr<VCLMemoryArray> matrix;
201 
205  index_t offset;
206 
208  index_t num_rows;
209 
211  index_t num_cols;
212 };
213 
214 }
215 #endif // SWIG
216 
217 #endif // HAVE_CXX11
218 #endif // HAVE_VIENNACL
219 #endif // __GPUMATRIX_H__
int32_t index_t
Definition: common.h:72
Definition: SGMatrix.h:25
void set_const(Container< T > &a, T value)
void zero(Container< T > &a)
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18

SHOGUN Machine Learning Toolbox - Documentation