SHOGUN  6.1.3
NextSamples.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 #ifndef NEXT_SAMPLES_H__
32 #define NEXT_SAMPLES_H__
33 
34 #include <vector>
35 #include <shogun/lib/common.h>
37 
38 namespace shogun
39 {
40 
41 class CFeatures;
42 
43 namespace internal
44 {
45 
69 {
70  friend class DataManager;
71 private:
72  NextSamples(index_t num_distributions);
73 public:
77  NextSamples& operator=(const NextSamples& other);
78 
82  ~NextSamples();
83 
91  std::vector<Block>& operator[](size_t i);
92 
97  const std::vector<Block>& operator[](size_t i) const;
98 
103  const index_t num_blocks() const;
104 
112  const bool empty() const;
113 
117  void clear();
118 private:
119  index_t m_num_blocks;
120  std::vector<std::vector<Block> > next_samples;
121 };
122 
123 }
124 
125 }
126 
127 #endif // NEXT_SAMPLES_H__
int32_t index_t
Definition: common.h:72
const bool empty() const
Definition: NextSamples.cpp:76
const index_t num_blocks() const
Definition: NextSamples.cpp:71
std::vector< Block > & operator[](size_t i)
Definition: NextSamples.cpp:55
NextSamples & operator=(const NextSamples &other)
Definition: NextSamples.cpp:42
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
class NextSamples is the return type for next() call in DataManager. If there are no more samples (fr...
Definition: NextSamples.h:68

SHOGUN Machine Learning Toolbox - Documentation