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

smoothrelu_layer_forward.h
1 /* file: smoothrelu_layer_forward.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 forward SmoothReLU layer in the batch processing mode
45 //--
46 */
47 
48 #ifndef __SMOOTHRELU_LAYER_FORWARD_H__
49 #define __SMOOTHRELU_LAYER_FORWARD_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/tensor.h"
53 #include "services/daal_defines.h"
54 #include "algorithms/neural_networks/layers/layer.h"
55 #include "algorithms/neural_networks/layers/smoothrelu/smoothrelu_layer_types.h"
56 #include "algorithms/neural_networks/layers/smoothrelu/smoothrelu_layer_forward_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace neural_networks
63 {
64 namespace layers
65 {
66 namespace smoothrelu
67 {
68 namespace forward
69 {
70 namespace interface1
71 {
87 template<typename algorithmFPType, Method method, CpuType cpu>
88 class DAAL_EXPORT BatchContainer : public layers::forward::LayerContainerIfaceImpl
89 {
90 public:
96  BatchContainer(daal::services::Environment::env *daalEnv);
98  ~BatchContainer();
104  services::Status compute() DAAL_C11_OVERRIDE;
105 };
106 
125 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
126 class Batch : public layers::forward::LayerIfaceImpl
127 {
128 public:
129  typedef layers::forward::LayerIfaceImpl super;
130 
131  typedef algorithms::neural_networks::layers::smoothrelu::forward::Input InputType;
132  typedef algorithms::neural_networks::layers::smoothrelu::Parameter ParameterType;
133  typedef algorithms::neural_networks::layers::smoothrelu::forward::Result ResultType;
134 
135  ParameterType &parameter;
136  InputType input;
139  Batch() : parameter(_defaultParameter)
140  {
141  initialize();
142  };
143 
149  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
150  {
151  initialize();
152  }
153 
160  Batch(const Batch<algorithmFPType, method> &other) : super(other),
161  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
162  {
163  initialize();
164  }
165 
170  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
171 
176  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
177 
182  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
183 
188  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
189  {
190  return getResult();
191  }
192 
197  ResultPtr getResult()
198  {
199  return _result;
200  }
201 
208  services::Status setResult(const ResultPtr& result)
209  {
210  DAAL_CHECK(result, services::ErrorNullResult)
211  _result = result;
212  _res = _result.get();
213  return services::Status();
214  }
215 
222  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
223  {
224  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
225  }
226 
232  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
233  {
234  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
235  this->_res = this->_result.get();
236  return s;
237  }
238 
239 protected:
240  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
241  {
242  return new Batch<algorithmFPType, method>(*this);
243  }
244 
245  void initialize()
246  {
247  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
248  _in = &input;
249  _par = &parameter;
250  _result.reset(new ResultType());
251  }
252 
253 private:
254  ResultPtr _result;
255  ParameterType _defaultParameter;
256 };
258 } // namespace interface1
259 using interface1::BatchContainer;
260 using interface1::Batch;
261 } // namespace forward
262 } // namespace smoothrelu
263 } // namespace layers
264 } // namespace neural_networks
265 } // namespace algorithms
266 } // namespace daal
267 #endif
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::BatchContainer
Provides methods to run implementations of the forward smooth relu layer This class is associated wit...
Definition: smoothrelu_layer_forward.h:88
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch
Provides methods for the forward smooth relu layer in the batch processing mode.
Definition: smoothrelu_layer_forward.h:126
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::neural_networks::layers::smoothrelu::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: smoothrelu_layer_forward.h:232
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: smoothrelu_layer_forward.h:160
daal::algorithms::neural_networks::layers::smoothrelu::interface1::Parameter
Parameters for the smoothrelu layer.
Definition: smoothrelu_layer_types.h:104
daal::algorithms::neural_networks::layers::forward::interface1::LayerIface
Abstract class which defines interface for the layer.
Definition: layer_forward.h:86
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: smoothrelu_layer_forward.h:182
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::Batch
Batch()
Definition: smoothrelu_layer_forward.h:139
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: smoothrelu_layer_forward.h:135
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::input
InputType input
Definition: smoothrelu_layer_forward.h:136
daal_defines.h
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: smoothrelu_layer_forward.h:170
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: smoothrelu_layer_forward.h:197
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::neural_networks::layers::smoothrelu::forward::interface1::Input
Input objects for the forward smooth relu layer
Definition: smoothrelu_layer_forward_types.h:88
daal::algorithms::neural_networks::layers::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_forward_types.h:241
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: smoothrelu_layer_forward.h:222
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: smoothrelu_layer_forward.h:208
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the forward smooth relu l...
Definition: smoothrelu_layer_forward_types.h:128
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: smoothrelu_layer_forward.h:176
daal::algorithms::neural_networks::layers::smoothrelu::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: smoothrelu_layer_forward.h:149
daal::algorithms::neural_networks::layers::forward::interface1::Input
Input objects for layer algorithm
Definition: layer_forward_types.h:149
daal::algorithms::neural_networks::layers::forward::interface1::LayerContainerIfaceImpl
Provides methods of base container for forward layers. This class is associated with the daal::algori...
Definition: layer_forward_container_base.h:86
daal::algorithms::neural_networks::layers::forward::interface1::LayerIfaceImpl
Implements the abstract interface LayerIface. LayerIfaceImpl is, in turn, the base class for the clas...
Definition: layer_forward.h:169
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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