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

dropout_layer_forward.h
1 /* file: dropout_layer_forward.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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  Parameter &parameter;
133  Input input;
136  Batch() : parameter(_defaultParameter)
137  {
138  initialize();
139  };
140 
146  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
147  {
148  initialize();
149  }
150 
157  Batch(const Batch<algorithmFPType, method> &other) : super(other),
158  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
159  {
160  initialize();
161  }
162 
167  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
168 
173  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
174 
179  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
180 
185  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
186  {
187  return getResult();
188  }
189 
194  ResultPtr getResult()
195  {
196  return _result;
197  }
198 
205  services::Status setResult(const ResultPtr& result)
206  {
207  DAAL_CHECK(result, services::ErrorNullResult)
208  _result = result;
209  _res = _result.get();
210  return services::Status();
211  }
212 
219  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
220  {
221  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
222  }
223 
229  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
230  {
231  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
232  this->_res = this->_result.get();
233  return s;
234  }
235 
236 protected:
237  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
238  {
239  return new Batch<algorithmFPType, method>(*this);
240  }
241 
242  void initialize()
243  {
244  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
245  _in = &input;
246  _par = &parameter;
247  _result.reset(new Result());
248  }
249 
250 private:
251  ResultPtr _result;
252  Parameter _defaultParameter;
253 };
255 } // namespace interface1
256 using interface1::BatchContainer;
257 using interface1::Batch;
258 } // namespace forward
259 } // namespace dropout
260 } // namespace layers
261 } // namespace neural_networks
262 } // namespace algorithms
263 } // namespace daal
264 #endif
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:179
daal
Definition: algorithm_base_common.h:57
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::input
Input input
Definition: dropout_layer_forward.h:133
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: dropout_layer_forward.h:146
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: dropout_layer_forward.h:219
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Input
Input objects for the forward dropout layer
Definition: dropout_layer_forward_types.h:88
daal_defines.h
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: dropout_layer_forward.h:205
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:167
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::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:194
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::parameter
Parameter & parameter
Definition: dropout_layer_forward.h:132
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: dropout_layer_forward.h:157
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::forward::interface1::Batch::getLayerResult
layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:185
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:229
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: dropout_layer_forward.h:173
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::dropout::forward::interface1::Batch::Batch
Batch()
Definition: dropout_layer_forward.h:136

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