SHOGUN  6.1.3
GPUVector.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 __GPUVECTOR_H__
35 #define __GPUVECTOR_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  template <class, class, class> class vector_base;
49  template <class> class const_entry_proxy;
50  template <class> class entry_proxy;
51 
52  namespace backend
53  {
54  class mem_handle;
55  }
56 }
57 
58 namespace Eigen
59 {
60  template <class, int, int, int, int, int> class Matrix;
61 }
62 
63 namespace shogun
64 {
65 
77 template <class T> class CGPUVector
78 {
79 
80  typedef viennacl::vector_base<T, std::size_t, std::ptrdiff_t> VCLVectorBase;
81  typedef viennacl::backend::mem_handle VCLMemoryArray;
82 
83  typedef Eigen::Matrix<T,-1,1,0,-1,1> EigenVectorXt;
84  typedef Eigen::Matrix<T,1,-1,0x1,1,-1> EigenRowVectorXt;
85 
86 public:
88  typedef T Scalar;
89 
91  template <typename ST> using container_type = CGPUVector<ST>;
92 
94  CGPUVector();
95 
100  CGPUVector(index_t length);
101 
109  CGPUVector(std::shared_ptr<VCLMemoryArray> mem, index_t length, index_t mem_offset=0);
110 
112  CGPUVector(const SGVector<T>& cpu_vec);
113 
115  CGPUVector(const EigenVectorXt& cpu_vec);
116 
118  CGPUVector(const EigenRowVectorXt& cpu_vec);
119 
121  operator EigenVectorXt() const;
122 
124  operator EigenRowVectorXt() const;
125 
126 
128  inline VCLVectorBase data()
129  {
130  return vcl_vector();
131  }
132 
134  inline index_t size() const
135  {
136  return vlen;
137  }
138 
140  operator SGVector<T>() const;
141 
145  VCLVectorBase vcl_vector();
146 
148  void zero();
149 
154  void set_const(T value);
155 
157  void display_vector(const char* name="vector") const;
158 
164  viennacl::const_entry_proxy<T> operator[](index_t index) const;
165 
171  viennacl::entry_proxy<T> operator[](index_t index);
172 
173 private:
174  void init();
175 
176 public:
178  std::shared_ptr<VCLMemoryArray> vector;
179 
183  index_t offset;
184 
186  index_t vlen;
187 };
188 
189 }
190 #endif // SWIG
191 
192 #endif // HAVE_CXX11
193 #endif // HAVE_VIENNACL
194 #endif // __GPUVECTOR_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