C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

stump_training_types.h
1 /* file: stump_training_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the interface of the decision stump training algorithm.
45 //--
46 */
47 
48 #ifndef __STUMP_TRAINING_TYPES_H__
49 #define __STUMP_TRAINING_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/classifier/classifier_training_types.h"
53 #include "algorithms/weak_learner/weak_learner_training_types.h"
54 #include "algorithms/stump/stump_model.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
63 namespace stump
64 {
74 namespace training
75 {
80 enum Method
81 {
82  defaultDense = 0
83 };
84 
88 namespace interface1
89 {
95 class DAAL_EXPORT Result : public daal::algorithms::weak_learner::training::Result
96 {
97 public:
98  DECLARE_SERIALIZABLE_CAST(Result);
99  Result();
100 
101  virtual ~Result() {}
102 
108  daal::algorithms::stump::ModelPtr get(classifier::training::ResultId id) const;
109 
115  void set(classifier::training::ResultId id, daal::algorithms::stump::ModelPtr &value);
116 
124  template <typename algorithmFPType>
125  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
126 
133  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
134 
135 protected:
137  template<typename Archive, bool onDeserialize>
138  services::Status serialImpl(Archive *arch)
139  {
140  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
141  }
142 };
143 typedef services::SharedPtr<Result> ResultPtr;
144 } // namespace interface1
145 using interface1::Result;
146 using interface1::ResultPtr;
147 
148 } // namespace daal::algorithms::stump::training
150 }
151 }
152 } // namespace daal
153 #endif // __STUMP_TRAINING_TYPES_H__
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::algorithms::stump::training::defaultDense
Definition: stump_training_types.h:82
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::classifier::training::ResultId
ResultId
Definition: classifier_training_types.h:106
daal::algorithms::weak_learner::training::interface1::Result
Provides methods to access final results obtained with compute() method of Batch or finalizeCompute()...
Definition: weak_learner_training_types.h:86
daal::algorithms::stump::training::Method
Method
Definition: stump_training_types.h:80
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::stump::training::interface1::Result
Provides methods to access final results obtained with the compute() method of the decision stump tra...
Definition: stump_training_types.h:95
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217

For more complete information about compiler optimizations, see our Optimization Notice.