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

relu.h
1 /* file: relu.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 rectified linear function
45 //--
46 */
47 
48 #ifndef __RELU_H__
49 #define __RELU_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "services/daal_defines.h"
54 #include "algorithms/math/relu_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace math
61 {
62 namespace relu
63 {
64 namespace interface1
65 {
75 template<typename algorithmFPType, Method method, CpuType cpu>
76 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
77 {
78 public:
84  BatchContainer(daal::services::Environment::env *daalEnv);
86  ~BatchContainer();
92  virtual services::Status compute() DAAL_C11_OVERRIDE;
93 };
94 
109 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
110 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
111 {
112 public:
113  typedef algorithms::math::relu::Input InputType;
114  typedef algorithms::math::relu::Result ResultType;
115 
117  Batch()
118  {
119  initialize();
120  }
121 
126  Batch(const Batch<algorithmFPType, method> &other) : input(other.input)
127  {
128  initialize();
129  }
130 
135  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
136 
141  ResultPtr getResult()
142  {
143  return _result;
144  }
145 
152  services::Status setResult(const ResultPtr &result)
153  {
154  DAAL_CHECK(result, services::ErrorNullResult)
155  _result = result;
156  _res = _result.get();
157  return services::Status();
158  }
159 
160  InputType input;
167  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
168  {
169  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
170  }
171 
172 protected:
173  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
174  {
175  return new Batch<algorithmFPType, method>(*this);
176  }
177 
178  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
179  {
180  _result.reset(new ResultType());
181  services::Status s = _result->allocate<algorithmFPType>(&input, NULL, (int) method);
182  _res = _result.get();
183  return s;
184  }
185 
186  void initialize()
187  {
188  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
189  _in = &input;
190  }
191 private:
192  ResultPtr _result;
193 };
195 } // namespace interface1
196 using interface1::BatchContainer;
197 using interface1::Batch;
198 
199 } // namespace relu
200 } // namespace math
201 } // namespace algorithms
202 } // namespace daal
203 #endif
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::math::relu::interface1::Batch::input
InputType input
Definition: relu.h:160
daal::algorithms::math::relu::interface1::Batch::getResult
ResultPtr getResult()
Definition: relu.h:141
daal::algorithms::math::relu::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: relu.h:135
daal_defines.h
daal::algorithms::math::relu::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: relu.h:126
daal::algorithms::math::relu::interface1::Result
Results obtained with the compute() method of the rectified linear function in the batch processing m...
Definition: relu_types.h:155
daal::algorithms::math::relu::interface1::BatchContainer
Class containing methods for the rectified linear function computing using algorithmFPType precision ...
Definition: relu.h:76
daal::batch
Definition: daal_defines.h:132
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::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::math::relu::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: relu.h:152
daal::algorithms::math::relu::interface1::Batch::Batch
Batch()
Definition: relu.h:117
daal::algorithms::math::relu::interface1::Input
Input objects for the rectified linear function
Definition: relu_types.h:116
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::math::relu::interface1::Batch
Computes the rectified linear function in the batch processing mode.
Definition: relu.h:110
daal::algorithms::math::relu::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: relu.h:167
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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