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

split_layer_backward.h
1 /* file: split_layer_backward.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 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  typedef algorithms::neural_networks::layers::split::backward::Input InputType;
135  typedef algorithms::neural_networks::layers::split::Parameter ParameterType;
136  typedef algorithms::neural_networks::layers::split::backward::Result ResultType;
137 
138  ParameterType &parameter;
139  InputType input;
142  Batch() : parameter(_defaultParameter)
143  {
144  initialize();
145  };
146 
152  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
153  {
154  initialize();
155  }
156 
162  Batch(const Batch<algorithmFPType, method> &other) : _defaultParameter(other.parameter), parameter(_defaultParameter)
163  {
164  initialize();
165  input.set(layers::backward::inputFromForward, other.input.get(layers::backward::inputFromForward));
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::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
191  {
192  return _result;
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 
223  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
224  {
225  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
226  }
227 
233  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
234  {
235  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input),&parameter, (int) method);
236  this->_res = this->_result.get();
237  return s;
238  }
239 
240 protected:
241  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
242  {
243  return new Batch<algorithmFPType, method>(*this);
244  }
245 
246  void initialize()
247  {
248  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
249  _in = &input;
250  _par = &parameter;
251  _result.reset(new ResultType());
252  }
253 
254 private:
255  ResultPtr _result;
256  ParameterType _defaultParameter;
257 };
259 } // namespace interface1
260 using interface1::BatchContainer;
261 using interface1::Batch;
262 } // namespace backward
263 } // namespace split
264 } // namespace layers
265 } // namespace neural_networks
266 } // namespace algorithms
267 } // namespace daal
268 #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::algorithms::neural_networks::layers::backward::interface1::LayerIfaceImpl
Implements the abstract interface LayerIface. LayerIfaceImpl is, in turn, the base class for the clas...
Definition: layer_backward.h:153
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: split_layer_backward.h:138
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::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::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: split_layer_backward.h:223
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:184
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:233
daal_defines.h
daal::algorithms::neural_networks::layers::backward::inputFromForward
Definition: layer_backward_types.h:100
daal::algorithms::neural_networks::layers::split::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward split layer...
Definition: split_layer_backward_types.h:184
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:172
daal::batch
Definition: daal_defines.h:132
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: split_layer_backward.h:178
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::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: split_layer_backward.h:210
daal::algorithms::neural_networks::layers::split::interface1::Parameter
split layer parameters
Definition: split_layer_types.h:94
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: split_layer_backward.h:199
daal::algorithms::neural_networks::layers::backward::interface1::Input::set
void set(InputId id, const data_management::TensorPtr &ptr)
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::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_backward_types.h:224
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: split_layer_backward.h:152
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::Batch
Batch()
Definition: split_layer_backward.h:142
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: split_layer_backward.h:162
daal::algorithms::neural_networks::layers::split::backward::interface1::Batch::input
InputType input
Definition: split_layer_backward.h:139
daal::algorithms::neural_networks::layers::split::backward::interface1::Input
Input parameters for the backward split layer
Definition: split_layer_backward_types.h:101
daal::algorithms::neural_networks::layers::backward::interface1::Input
Input parameters for the layer algorithm
Definition: layer_backward_types.h:150
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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