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

kernel_function_linear.h
1 /* file: kernel_function_linear.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 for the linear kernel function algorithm
45 //--
46 */
47 
48 #ifndef __KERNEL_FUNCTION_LINEAR_H__
49 #define __KERNEL_FUNCTION_LINEAR_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "algorithms/kernel_function/kernel_function_types_linear.h"
54 #include "algorithms/kernel_function/kernel_function.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace kernel_function
61 {
62 namespace linear
63 {
64 
65 namespace interface1
66 {
82 template<typename algorithmFPType, Method method, CpuType cpu>
83 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
84 {
85 public:
91  BatchContainer(daal::services::Environment::env *daalEnv);
93  ~BatchContainer();
97  virtual services::Status compute() DAAL_C11_OVERRIDE;
98 };
99 
116 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
117 class DAAL_EXPORT Batch : public KernelIface
118 {
119 public:
120  typedef KernelIface super;
121 
122  typedef algorithms::kernel_function::linear::Input InputType;
123  typedef algorithms::kernel_function::linear::Parameter ParameterType;
124  typedef typename super::ResultType ResultType;
125 
126  ParameterType parameter;
127  InputType input;
130  Batch()
131  {
132  initialize();
133  }
134 
141  Batch(const Batch<algorithmFPType, method> &other) : KernelIface(other), parameter(other.parameter), input(other.input)
142  {
143  initialize();
144  }
145 
150  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
151 
156  virtual InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
157 
162  virtual ParameterBase * getParameter() DAAL_C11_OVERRIDE { return &parameter; }
163 
169  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
170  {
171  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
172  }
173 
174 protected:
175  void initialize()
176  {
177  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
178  _in = &input;
179  _par = &parameter;
180  }
181 
182  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
183  {
184  return new Batch<algorithmFPType, method>(*this);
185  }
186 
187  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
188  {
189  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int) method);
190  _res = _result.get();
191  return s;
192  }
193 };
195 } // namespace interface1
196 using interface1::BatchContainer;
197 using interface1::Batch;
198 
199 } // linear
200 } // namespace kernel_function
201 } // namespace algorithm
202 } // namespace daal
203 #endif
daal::algorithms::kernel_function::linear::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: kernel_function_linear.h:141
daal::algorithms::kernel_function::linear::interface1::Parameter
Parameters for the linear kernel function k(X,Y) + b.
Definition: kernel_function_types_linear.h:96
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
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::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::kernel_function::linear::interface1::Input
Input objects for the kernel function linear algorithm
Definition: kernel_function_types_linear.h:108
daal::algorithms::kernel_function::linear::interface1::Batch::getInput
virtual InputType * getInput() DAAL_C11_OVERRIDE
Definition: kernel_function_linear.h:156
daal::algorithms::kernel_function::linear::interface1::Batch::Batch
Batch()
Definition: kernel_function_linear.h:130
daal::algorithms::kernel_function::linear::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: kernel_function_linear.h:150
daal::algorithms::kernel_function::linear::interface1::BatchContainer
Provides methods to run implementations of the linear kernel function algorithm. This class is associ...
Definition: kernel_function_linear.h:83
daal::algorithms::kernel_function::interface1::Result
Results obtained with the compute() method of the kernel function algorithm in the batch processing m...
Definition: kernel_function_types.h:159
daal::algorithms::kernel_function::interface1::ParameterBase
Optional input objects for the kernel function algorithm.
Definition: kernel_function_types.h:112
daal::batch
Definition: daal_defines.h:132
daal::algorithms::kernel_function::linear::interface1::Batch::input
InputType input
Definition: kernel_function_linear.h:127
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::kernel_function::interface1::KernelIface
Abstract class that specifies the interface of the algorithms for computing kernel functions in the b...
Definition: kernel_function.h:73
daal::algorithms::kernel_function::linear::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: kernel_function_linear.h:169
daal::algorithms::kernel_function::linear::interface1::Batch::parameter
ParameterType parameter
Definition: kernel_function_linear.h:126
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::kernel_function::linear::interface1::Batch
Computes a linear kernel function in the batch processing mode.
Definition: kernel_function_linear.h:117
daal::algorithms::kernel_function::interface1::Input
Input objects for the kernel function algorithm
Definition: kernel_function_types.h:127
daal::algorithms::kernel_function::linear::interface1::Batch::getParameter
virtual ParameterBase * getParameter() DAAL_C11_OVERRIDE
Definition: kernel_function_linear.h:162

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