SHOGUN  6.1.3
ParameterObserverInterface.h
Go to the documentation of this file.
1 /*
2 * BSD 3-Clause License
3 *
4 * Copyright (c) 2017, Shogun-Toolbox e.V. <shogun-team@shogun-toolbox.org>
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 * * Redistributions of source code must retain the above copyright notice, this
11 * list of conditions and the following disclaimer.
12 *
13 * * Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 *
17 * * Neither the name of the copyright holder nor the names of its
18 * contributors may be used to endorse or promote products derived from
19 * this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 * Written (W) 2017 Giovanni De Toni
33 *
34 */
35 #ifndef SHOGUN_PARAMETEROBSERVERINTERFACE_H
36 #define SHOGUN_PARAMETEROBSERVERINTERFACE_H
37 
38 #include <stdexcept>
39 #include <vector>
40 
41 #include <shogun/lib/any.h>
43 
44 /* Used to check if the observed value type */
45 #define CHECK_OBSERVED_VALUE_TYPE(type) \
46  if (type != m_type) \
47  return;
48 
49 namespace shogun
50 {
51 
56  {
57 
58  public:
63 
68  ParameterObserverInterface(std::vector<std::string>& parameters);
69 
76  const std::string& filename, std::vector<std::string>& parameters);
81 
88  virtual bool filter(const std::string& param);
89 
95  virtual void on_next(const TimedObservedValue& value) = 0;
99  virtual void on_error(std::exception_ptr) = 0;
103  virtual void on_complete() = 0;
104 
109  virtual void clear(){};
110 
111  protected:
115  std::vector<std::string> m_parameters;
116 
121  };
122 }
123 
124 #endif // SHOGUN_PARAMETEROBSERVER_H
std::pair< ObservedValue, time_point > TimedObservedValue
SG_OBS_VALUE_TYPE
Definition: ObservedValue.h:54
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
virtual void on_error(std::exception_ptr)=0
virtual bool filter(const std::string &param)
virtual void on_next(const TimedObservedValue &value)=0

SHOGUN Machine Learning Toolbox - Documentation