SHOGUN  6.1.3
SGLinalg.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Shogun-Toolbox e.V. <shogun-team@shogun-toolbox.org>
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * Authors: 2016 Pan Deng, Soumyajit De, Heiko Strathmann, Viktor Gal
31  */
32 
33 #ifndef SG_LINALG_H__
34 #define SG_LINALG_H__
35 
36 #include <shogun/lib/config.h>
37 
38 #include <shogun/lib/Lock.h>
39 #include <shogun/lib/common.h>
40 #include <shogun/lib/memory.h>
41 
44 
45 #include <memory>
46 
47 namespace shogun
48 {
49 
51  class SGLinalg
52  {
53  public:
56 
59  {
60  cpu_backend =
61  std::unique_ptr<LinalgBackendBase>(new LinalgBackendEigen());
62  gpu_backend = nullptr;
63  linalg_warnings = true;
64  }
65 
68  {
69  }
70 
75  {
76  cpu_backend = std::unique_ptr<LinalgBackendBase>(backend);
77  }
78 
84  {
85  return cpu_backend.get();
86  }
87 
92  {
93  gpu_backend = std::unique_ptr<LinalgBackendBase>(backend);
94  }
95 
101  {
102  return gpu_backend.get();
103  }
104 
108  void set_linalg_warnings(bool enable_warnings = true)
109  {
110  if (enable_warnings)
111  linalg_warnings = true;
112  else
113  linalg_warnings = false;
114  }
115 
120  bool const get_linalg_warnings() const
121  {
122  return linalg_warnings;
123  }
124 
125  private:
129  std::unique_ptr<LinalgBackendBase> cpu_backend;
130 
134  std::unique_ptr<LinalgBackendBase> gpu_backend;
135 
137  bool linalg_warnings;
138  };
139 }
140 
141 namespace shogun
142 {
144  extern std::unique_ptr<SGLinalg> sg_linalg;
145 }
146 
147 #endif // SG_LINALG_H__
CLock m_gpu_transfer
Definition: SGLinalg.h:55
LinalgBackendBase *const get_gpu_backend() const
Definition: SGLinalg.h:100
bool const get_linalg_warnings() const
Definition: SGLinalg.h:120
std::unique_ptr< SGLinalg > sg_linalg
void set_gpu_backend(LinalgBackendBase *backend)
Definition: SGLinalg.h:91
Class Lock used for synchronization in concurrent programs.
Definition: Lock.h:19
linalg library backend
Definition: SGLinalg.h:51
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
Base interface of generic linalg methods and generic memory transfer methods.
LinalgBackendBase *const get_cpu_backend() const
Definition: SGLinalg.h:83
Linalg methods with Eigen3 backend.
void set_cpu_backend(LinalgBackendBase *backend)
Definition: SGLinalg.h:74
void set_linalg_warnings(bool enable_warnings=true)
Definition: SGLinalg.h:108

SHOGUN Machine Learning Toolbox - Documentation