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

dropout_layer_backward.h
1 /* file: dropout_layer_backward.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 backward dropout layer in the batch processing mode
45 //--
46 */
47 
48 #ifndef __DROPOUT_LAYER_BACKWARD_H__
49 #define __DROPOUT_LAYER_BACKWARD_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_backward_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 backward
69 {
70 namespace interface1
71 {
87 template<typename algorithmFPType, Method method, CpuType cpu>
88 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
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::backward::LayerIfaceImpl
127 {
128 public:
129  typedef layers::backward::LayerIfaceImpl super;
130  Parameter &parameter;
131  Input input;
134  Batch() : parameter(_defaultParameter)
135  {
136  initialize();
137  };
138 
144  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
145  {
146  initialize();
147  }
148 
149 
156  Batch(const Batch<algorithmFPType, method> &other) : super(other),
157  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
158  {
159  initialize();
160  }
161 
166  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
167 
172  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
173 
178  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
179 
184  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
185  {
186  return _result;
187  }
188 
193  ResultPtr getResult()
194  {
195  return _result;
196  }
197 
204  services::Status setResult(const ResultPtr& result)
205  {
206  DAAL_CHECK(result, services::ErrorNullResult)
207  _result = result;
208  _res = _result.get();
209  return services::Status();
210  }
211 
218  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
219  {
220  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
221  }
222 
228  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
229  {
230  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
231  this->_res = this->_result.get();
232  return s;
233  }
234 
235 protected:
236  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
237  {
238  return new Batch<algorithmFPType, method>(*this);
239  }
240 
241  void initialize()
242  {
243  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
244  _in = &input;
245  _par = &parameter;
246  _result.reset(new Result());
247  }
248 
249 private:
250  ResultPtr _result;
251  Parameter _defaultParameter;
252 };
254 } // namespace interface1
255 using interface1::BatchContainer;
256 using interface1::Batch;
257 } // namespace backward
258 } // namespace dropout
259 } // namespace layers
260 } // namespace neural_networks
261 } // namespace algorithms
262 } // namespace daal
263 #endif
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::input
Input input
Definition: dropout_layer_backward.h:131
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: dropout_layer_backward.h:218
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::neural_networks::layers::dropout::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:184
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch
Provides methods for the backward dropout layer in the batch processing mode.
Definition: dropout_layer_backward.h:126
daal_defines.h
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:166
daal::batch
Definition: daal_defines.h:131
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: dropout_layer_backward.h:204
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:228
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: dropout_layer_backward.h:193
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: dropout_layer_backward.h:144
daal::algorithms::neural_networks::layers::dropout::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward dropout layer This class is associated...
Definition: dropout_layer_backward.h:88
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::backward::interface1::Input
Input objects for the backward dropout layer
Definition: dropout_layer_backward_types.h:88
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:172
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:178
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::Batch
Batch()
Definition: dropout_layer_backward.h:134
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::parameter
Parameter & parameter
Definition: dropout_layer_backward.h:130
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: dropout_layer_backward.h:156
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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