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

split_layer_backward.h
1 /* file: split_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 split layer in the batch
45 // processing mode
46 //--
47 */
48 
49 #ifndef __SPLIT_LAYER_BACKWARD_H__
50 #define __SPLIT_LAYER_BACKWARD_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/tensor.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/neural_networks/layers/layer.h"
56 #include "algorithms/neural_networks/layers/split/split_layer_types.h"
57 #include "algorithms/neural_networks/layers/split/split_layer_backward_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
70 namespace split
71 {
75 namespace backward
76 {
77 namespace interface1
78 {
94 template<typename algorithmFPType, Method method, CpuType cpu>
95 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
96 {
97 public:
103  BatchContainer(daal::services::Environment::env *daalEnv);
105  ~BatchContainer();
111  services::Status compute() DAAL_C11_OVERRIDE;
112 };
113 
130 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
131 class Batch : public layers::backward::LayerIfaceImpl
132 {
133 public:
134  Parameter &parameter;
135  Input input;
138  Batch() : parameter(_defaultParameter)
139  {
140  initialize();
141  };
142 
148  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
149  {
150  initialize();
151  }
152 
158  Batch(const Batch<algorithmFPType, method> &other) : _defaultParameter(other.parameter), parameter(_defaultParameter)
159  {
160  initialize();
161  input.set(layers::backward::inputFromForward, other.input.get(layers::backward::inputFromForward));
162  }
163 
168  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
169 
174  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
175 
180  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
181 
186  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
187  {
188  return _result;
189  }
190 
195  ResultPtr getResult()
196  {
197  return _result;
198  }
199 
206  services::Status setResult(const ResultPtr& result)
207  {
208  DAAL_CHECK(result, services::ErrorNullResult)
209  _result = result;
210  _res = _result.get();
211  return services::Status();
212  }
213 
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_CONTAINER(batch, 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 backward
259 } // namespace split
260 } // namespace layers
261 } // namespace neural_networks
262 } // namespace algorithms
263 } // namespace daal
264 #endif
daal::algorithms::neural_networks::layers::split::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward split layer This class is associated w...
Definition: split_layer_backward.h:95
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::split::backward::interface1::Input::set
void set(InputLayerDataId id, const data_management::TensorPtr &value, size_t index)
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:180
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: split_layer_backward.h:148
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::parameter
Parameter & parameter
Definition: split_layer_backward.h:134
daal::algorithms::neural_networks::layers::backward::inputFromForward
Definition: layer_backward_types.h:100
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:186
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:229
daal_defines.h
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch
Computes the results of the backward split layer in the batch processing mode.
Definition: split_layer_backward.h:131
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:168
daal::batch
Definition: daal_defines.h:131
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: split_layer_backward.h:206
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:174
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::input
Input input
Definition: split_layer_backward.h:135
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: split_layer_backward.h:195
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::split::backward::interface1::Batch::Batch
Batch()
Definition: split_layer_backward.h:138
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: split_layer_backward.h:158
daal::algorithms::neural_networks::layers::split::backward::interface1::Input
Input parameters for the backward split layer
Definition: split_layer_backward_types.h:101
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: split_layer_backward.h:219

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