SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Block.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2014 Soumyajit De
4  * Written (w) 2014 Khaled Nasr
5  * All rights reserved.
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, this
11  * list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * The views and conclusions contained in the software and documentation are those
28  * of the authors and should not be interpreted as representing official policies,
29  * either expressed or implied, of the Shogun Development Team.
30  */
31 
32 #ifndef BLOCK_H_
33 #define BLOCK_H_
34 
35 #include <shogun/lib/config.h>
36 
37 namespace shogun
38 {
39 
40 namespace linalg
41 {
42 
48 template <class Matrix>
49 struct Block
50 {
52  typedef typename Matrix::Scalar Scalar;
53 
67  Block<Matrix>(Matrix matrix,
68  index_t row_begin, index_t col_begin,
69  index_t row_size, index_t col_size)
70  : m_matrix(matrix), m_row_begin(row_begin), m_col_begin(col_begin),
71  m_row_size(row_size), m_col_size(col_size)
72  {
73  }
74 
76  Matrix m_matrix;
77 
80 
83 
86 
89 };
90 
101 template <class Matrix>
102 Block<Matrix> block(Matrix matrix, index_t row_begin,
103  index_t col_begin, index_t row_size, index_t col_size)
104 {
105  return Block<Matrix>(matrix, row_begin, col_begin, row_size, col_size);
106 }
107 
108 }
109 
110 }
111 #endif // BLOCK_H_
index_t m_row_size
Definition: Block.h:85
int32_t index_t
Definition: common.h:62
Generic class Block which wraps a matrix class and contains block specific information, providing a uniform way to deal with matrix blocks for all supported backend matrices.
Definition: Block.h:49
index_t m_row_begin
Definition: Block.h:79
index_t m_col_size
Definition: Block.h:88
Matrix::Scalar Scalar
Definition: Block.h:52
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
index_t m_col_begin
Definition: Block.h:82
Block< Matrix > block(Matrix matrix, index_t row_begin, index_t col_begin, index_t row_size, index_t col_size)
Definition: Block.h:102

SHOGUN Machine Learning Toolbox - Documentation