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

fullyconnected_layer_backward.h
1 /* file: fullyconnected_layer_backward.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of the interface for the backward fully-connected layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __FULLYCONNECTED_LAYER_BACKWARD_H__
26 #define __FULLYCONNECTED_LAYER_BACKWARD_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "data_management/data/tensor.h"
30 #include "services/daal_defines.h"
31 #include "algorithms/neural_networks/layers/layer.h"
32 #include "algorithms/neural_networks/layers/fullyconnected/fullyconnected_layer_types.h"
33 #include "algorithms/neural_networks/layers/fullyconnected/fullyconnected_layer_backward_types.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
43 namespace fullyconnected
44 {
45 namespace backward
46 {
47 namespace interface1
48 {
66 template<typename algorithmFPType, Method method, CpuType cpu>
67 class BatchContainer : public AnalysisContainerIface<batch>
68 {
69 public:
76  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
81  DAAL_DEPRECATED ~BatchContainer();
88  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
89 };
90 
108 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
109 class Batch : public layers::backward::LayerIfaceImpl
110 {
111 public:
112  typedef layers::backward::LayerIfaceImpl super;
113 
114  typedef algorithms::neural_networks::layers::fullyconnected::backward::Input InputType;
115  typedef algorithms::neural_networks::layers::fullyconnected::Parameter ParameterType;
116  typedef algorithms::neural_networks::layers::fullyconnected::backward::Result ResultType;
117 
118  ParameterType &parameter;
119  InputType input;
126  DAAL_DEPRECATED Batch(const size_t nOutputs) : _defaultParameter(nOutputs), parameter(_defaultParameter)
127  {
128  initialize();
129  };
130 
137  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
138  {
139  initialize();
140  }
141 
148  Batch(const Batch<algorithmFPType, method> &other) : super(other),
149  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
150  {
151  initialize();
152  }
153 
159  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
160 
166  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
167 
173  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
174 
180  DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
181  {
182  return getResult();
183  }
184 
190  ResultPtr getResult()
191  {
192  return _result;
193  }
194 
202  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
203  {
204  DAAL_CHECK(result, services::ErrorNullResult)
205  _result = result;
206  _res = _result.get();
207  return services::Status();
208  }
209 
216  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
217  {
218  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
219  }
220 
227  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateResult() DAAL_C11_OVERRIDE
228  {
229  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
230  this->_res = this->_result.get();
231  return s;
232  }
233 
234 protected:
235  /*
236  * \DAAL_DEPRECATED
237  */
238  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
239  {
240  return new Batch<algorithmFPType, method>(*this);
241  }
242 
243  /*
244  * \DAAL_DEPRECATED
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 fullyconnected
264 } // namespace layers
265 } // namespace neural_networks
266 } // namespace algorithms
267 } // namespace daal
268 #endif
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: fullyconnected_layer_backward.h:216
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: fullyconnected_layer_backward.h:180
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: fullyconnected_layer_backward.h:173
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::input
InputType input
Definition: fullyconnected_layer_backward.h:119
daal::batch
Definition: daal_defines.h:112
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: fullyconnected_layer_backward.h:159
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal_defines.h
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: fullyconnected_layer_backward.h:118
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::allocateResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: fullyconnected_layer_backward.h:227
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: fullyconnected_layer_backward.h:148
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: fullyconnected_layer_backward.h:190
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: fullyconnected_layer_backward.h:166
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: fullyconnected_layer_backward.h:137
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(const size_t nOutputs)
Definition: fullyconnected_layer_backward.h:126
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward fully-connected layer This class is as...
Definition: fullyconnected_layer_backward.h:67
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch
Provides methods for backward fully-connected layer computations in the batch processing mode...
Definition: fullyconnected_layer_backward.h:109
daal::algorithms::neural_networks::layers::fullyconnected::backward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: fullyconnected_layer_backward.h:202

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