SHOGUN  6.1.3
BlockwiseDetails.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2016 - 2017 Soumyajit De
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * The views and conclusions contained in the software and documentation are those
27  * of the authors and should not be interpreted as representing official policies,
28  * either expressed or implied, of the Shogun Development Team.
29  */
30 
31 #include <shogun/lib/common.h>
32 
33 #ifndef BLOCK_WISE_DETAILS_H__
34 #define BLOCK_WISE_DETAILS_H__
35 
36 namespace shogun
37 {
38 
39 namespace internal
40 {
41 
47 {
48  friend class DataFetcher;
49  friend class StreamingDataFetcher;
50  friend class DataManager;
51 
52 public:
53 
58 
65 
71  BlockwiseDetails& with_num_blocks_per_burst(index_t num_blocks_per_burst);
72 
73 private:
74 
76  index_t m_blocksize;
77 
79  index_t m_num_blocks_per_burst;
80 
82  index_t m_max_num_samples_per_burst;
83 
85  index_t m_next_block_index;
86 
88  index_t m_total_num_blocks;
89 
91  bool m_full_data;
92 };
93 
94 }
95 
96 }
97 #endif // BLOCK_WISE_DETAILS_H__
BlockwiseDetails & with_blocksize(index_t blocksize)
int32_t index_t
Definition: common.h:72
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
Class DataManager for fetching/streaming test data block-wise. It can handle data coming from multipl...
Definition: DataManager.h:63
BlockwiseDetails & with_num_blocks_per_burst(index_t num_blocks_per_burst)
Class that holds block-details for the data-fetchers. There are one instance of this class per fetche...

SHOGUN Machine Learning Toolbox - Documentation