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

dropout_layer_forward.h
1 /* file: dropout_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 dropout layer in the batch processing mode
45 //--
46 */
47 
48 #ifndef __DROPOUT_LAYER_FORWARD_H__
49 #define __DROPOUT_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/dropout/dropout_layer_types.h"
56 #include "algorithms/neural_networks/layers/dropout/dropout_layer_forward_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace neural_networks
63 {
64 namespace layers
65 {
66 namespace dropout
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  services::Status setupCompute() DAAL_C11_OVERRIDE;
106  services::Status resetCompute() DAAL_C11_OVERRIDE;
107 };
108 
127 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
128 class Batch : public layers::forward::LayerIfaceImpl
129 {
130 public:
131  typedef layers::forward::LayerIfaceImpl super;
132 
133  typedef algorithms::neural_networks::layers::dropout::forward::Input InputType;
134  typedef algorithms::neural_networks::layers::dropout::Parameter ParameterType;
135  typedef algorithms::neural_networks::layers::dropout::forward::Result ResultType;
136 
137  ParameterType &parameter;
138  InputType input;
141  Batch() : parameter(_defaultParameter)
142  {
143  initialize();
144  };
145 
151  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
152  {
153  initialize();
154  }
155 
162  Batch(const Batch<algorithmFPType, method> &other) : super(other),
163  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
164  {
165  initialize();
166  }
167 
172  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
173 
178  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
179 
184  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
185 
190  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
191  {
192  return getResult();
193  }
194 
199  ResultPtr getResult()
200  {
201  return _result;
202  }
203 
210  services::Status setResult(const ResultPtr& result)
211  {
212  DAAL_CHECK(result, services::ErrorNullResult)
213  _result = result;
214  _res = _result.get();
215  return services::Status();
216  }
217 
224  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
225  {
226  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
227  }
228 
234  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
235  {
236  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
237  this->_res = this->_result.get();
238  return s;
239  }
240 
241 protected:
242  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
243  {
244  return new Batch<algorithmFPType, method>(*this);
245  }
246 
247  void initialize()
248  {
249  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
250  _in = &input;
251  _par = &parameter;
252  _result.reset(new ResultType());
253  }
254 
255 private:
256  ResultPtr _result;
257  ParameterType _defaultParameter;
258 };
260 } // namespace interface1
261 using interface1::BatchContainer;
262 using interface1::Batch;
263 } // namespace forward
264 } // namespace dropout
265 } // namespace layers
266 } // namespace neural_networks
267 } // namespace algorithms
268 } // namespace daal
269 #endif
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: dropout_layer_forward.h:224
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::dropout::forward::interface1::Batch::input
InputType input
Definition: dropout_layer_forward.h:138
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Input
Input objects for the forward dropout layer
Definition: dropout_layer_forward_types.h:88
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:178
daal_defines.h
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: dropout_layer_forward.h:210
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:172
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::dropout::forward::interface1::Batch
Provides methods for the forward dropout layer in the batch processing mode.
Definition: dropout_layer_forward.h:128
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: dropout_layer_forward.h:151
daal::algorithms::neural_networks::layers::dropout::forward::interface1::BatchContainer
Provides methods to run implementations of the of the forward dropout layer This class is associated ...
Definition: dropout_layer_forward.h:88
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: dropout_layer_forward.h:199
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: dropout_layer_forward.h:137
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: dropout_layer_forward.h:162
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::dropout::interface1::Parameter
Parameters for the dropout layer.
Definition: dropout_layer_types.h:107
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:184
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:234
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::dropout::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the forward dropout layer...
Definition: dropout_layer_forward_types.h:137
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
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::Batch
Batch()
Definition: dropout_layer_forward.h:141

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