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

concat_layer_backward.h
1 /* file: concat_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 concat layer in the batch processing mode
45 //--
46 */
47 
48 #ifndef __CONCAT_LAYER_BACKWARD_H__
49 #define __CONCAT_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/concat/concat_layer_types.h"
56 #include "algorithms/neural_networks/layers/concat/concat_layer_backward_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace neural_networks
63 {
64 namespace layers
65 {
69 namespace concat
70 {
74 namespace backward
75 {
76 namespace interface1
77 {
93 template<typename algorithmFPType, Method method, CpuType cpu>
94 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
95 {
96 public:
102  BatchContainer(daal::services::Environment::env *daalEnv);
104  ~BatchContainer();
110  services::Status compute() DAAL_C11_OVERRIDE;
111 };
112 
130 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
131 class Batch : public layers::backward::LayerIfaceImpl
132 {
133 public:
134  typedef layers::backward::LayerIfaceImpl super;
135 
136  typedef algorithms::neural_networks::layers::concat::backward::Input InputType;
137  typedef algorithms::neural_networks::layers::concat::Parameter ParameterType;
138  typedef algorithms::neural_networks::layers::concat::backward::Result ResultType;
139 
140  ParameterType &parameter;
141  InputType input;
147  Batch(size_t concatDimension = 0) : _defaultParameter(concatDimension), parameter(_defaultParameter)
148  {
149  initialize();
150  };
151 
152 
158  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
159  {
160  initialize();
161  }
162 
169  Batch(const Batch<algorithmFPType, method> &other) : super(other),
170  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
171  {
172  initialize();
173  }
174 
179  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
180 
185  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
186 
191  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
192 
197  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
198  {
199  return _result;
200  }
201 
206  ResultPtr getResult()
207  {
208  return _result;
209  }
210 
217  services::Status setResult(const ResultPtr& result)
218  {
219  DAAL_CHECK(result, services::ErrorNullResult)
220  _result = result;
221  _res = _result.get();
222  return services::Status();
223  }
224 
230  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
231  {
232  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
233  }
234 
240  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
241  {
242  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
243  this->_res = this->_result.get();
244  return s;
245  }
246 
247 protected:
248  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
249  {
250  return new Batch<algorithmFPType, method>(*this);
251  }
252 
253  void initialize()
254  {
255  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
256  _in = &input;
257  _par = &parameter;
258  _result.reset(new ResultType());
259  }
260 
261 private:
262  ResultPtr _result;
263  ParameterType _defaultParameter;
264 };
266 } // namespace interface1
267 using interface1::BatchContainer;
268 using interface1::Batch;
269 } // namespace backward
270 } // namespace concat
271 } // namespace layers
272 } // namespace neural_networks
273 } // namespace algorithms
274 } // namespace daal
275 #endif
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: concat_layer_backward.h:158
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::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::concat::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: concat_layer_backward.h:169
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::concat::backward::interface1::Input
Input parameters for the backward concat layer
Definition: concat_layer_backward_types.h:92
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::Batch
Batch(size_t concatDimension=0)
Definition: concat_layer_backward.h:147
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: concat_layer_backward.h:240
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: concat_layer_backward.h:140
daal::algorithms::neural_networks::layers::concat::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward concat layer This class is associated ...
Definition: concat_layer_backward.h:94
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::input
InputType input
Definition: concat_layer_backward.h:141
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: concat_layer_backward.h:179
daal_defines.h
daal::batch
Definition: daal_defines.h:132
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: concat_layer_backward.h:191
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::concat::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: concat_layer_backward.h:206
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: concat_layer_backward.h:230
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: concat_layer_backward.h:185
daal::algorithms::neural_networks::layers::concat::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward concat layer...
Definition: concat_layer_backward_types.h:142
daal::algorithms::neural_networks::layers::concat::interface1::Parameter
concat layer parameters
Definition: concat_layer_types.h:105
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::concat::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: concat_layer_backward.h:217
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::concat::backward::interface1::Batch
Computes the results of the backward concat layer in the batch processing mode.
Definition: concat_layer_backward.h:131

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