SHOGUN  6.1.3
DataFetcher.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 #include <shogun/lib/SGVector.h>
34 
35 #ifndef DATA_FETCHER_H__
36 #define DATA_FETCHER_H__
37 
38 namespace shogun
39 {
40 
41 class CFeatures;
42 
43 namespace internal
44 {
45 
46 class DataManager;
47 #ifndef DOXYGEN_SHOULD_SKIP_THIS
48 class DataFetcher
49 {
50  friend class DataManager;
51  friend class InitPerFeature;
52 public:
53  DataFetcher(CFeatures* samples);
54  virtual ~DataFetcher();
55 
56  void set_blockwise(bool blockwise);
57 
58  void set_train_test_mode(bool on);
59  bool is_train_test_mode() const;
60 
61  void set_train_mode(bool on);
62  bool is_train_mode() const;
63 
64  void set_train_test_ratio(float64_t ratio);
65  float64_t get_train_test_ratio() const;
66 
67  virtual void shuffle_features();
68  virtual void unshuffle_features();
69 
70  virtual void use_fold(index_t i);
71  virtual void init_active_subset();
72 
73  virtual void start();
74  virtual CFeatures* next();
75  virtual void reset();
76  virtual void end();
77 
78  virtual index_t get_num_samples() const;
79 
80  index_t get_num_folds() const;
81  index_t get_num_training_samples() const;
82  index_t get_num_testing_samples() const;
83 
84  BlockwiseDetails& fetch_blockwise();
85  virtual const char* get_name() const
86  {
87  return "DataFetcher";
88  }
89 protected:
90  DataFetcher();
91  BlockwiseDetails m_block_details;
92  index_t m_num_samples;
93  bool train_test_mode;
94  bool train_mode;
95  float64_t train_test_ratio;
96 private:
97  CFeatures* m_samples;
98  SGVector<index_t> shuffle_subset;
99  SGVector<index_t> active_subset;
100  bool features_shuffled;
101  BlockwiseDetails last_blockwise_details;
102  void allocate_active_subset();
103 };
104 #endif // DOXYGEN_SHOULD_SKIP_THIS
105 }
106 
107 }
108 #endif // DATA_FETCHER_H__
int32_t index_t
Definition: common.h:72
double float64_t
Definition: common.h:60
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18

SHOGUN Machine Learning Toolbox - Documentation