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

lcn_layer_forward.h
1 /* file: lcn_layer_forward.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 forward local contrast normalization layer in the batch
21 // processing mode
22 //--
23 */
24 
25 #ifndef __NEURAL_NETWORK_LCN_LAYER_FORWARD_H__
26 #define __NEURAL_NETWORK_LCN_LAYER_FORWARD_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/lcn/lcn_layer_types.h"
33 #include "algorithms/neural_networks/layers/lcn/lcn_layer_forward_types.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
43 namespace lcn
44 {
45 namespace forward
46 {
47 namespace interface1
48 {
64 template<typename algorithmFPType, Method method, CpuType cpu>
65 class BatchContainer : public layers::forward::LayerContainerIfaceImpl
66 {
67 public:
74  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
79  DAAL_DEPRECATED ~BatchContainer();
86  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
87  /*
88  * \DAAL_DEPRECATED
89  */
90  DAAL_DEPRECATED services::Status setupCompute() DAAL_C11_OVERRIDE;
91  /*
92  * \DAAL_DEPRECATED
93  */
94  DAAL_DEPRECATED services::Status resetCompute() DAAL_C11_OVERRIDE;
95 };
96 
114 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
115 class Batch : public layers::forward::LayerIfaceImpl
116 {
117 public:
118  typedef layers::forward::LayerIfaceImpl super;
119 
120  typedef algorithms::neural_networks::layers::lcn::forward::Input InputType;
121  typedef algorithms::neural_networks::layers::lcn::Parameter ParameterType;
122  typedef algorithms::neural_networks::layers::lcn::forward::Result ResultType;
123 
124  ParameterType &parameter;
125  InputType input;
131  DAAL_DEPRECATED Batch() : parameter(_defaultParameter)
132  {
133  initialize();
134  };
135 
142  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
143  {
144  initialize();
145  };
146 
153  Batch(const Batch<algorithmFPType, method> &other) : super(other),
154  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
155  {
156  initialize();
157  }
158 
164  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
165 
171  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
172 
178  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
179 
185  DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
186  {
187  return getResult();
188  }
189 
195  ResultPtr getResult()
196  {
197  return _result;
198  }
199 
207  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
208  {
209  DAAL_CHECK(result, services::ErrorNullResult);
210  _result = result;
211  _res = _result.get();
212  return services::Status();
213  }
214 
221  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
222  {
223  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
224  }
225 
226  /*
227  * \DAAL_DEPRECATED
228  */
229  DAAL_DEPRECATED_VIRTUAL 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  /*
238  * \DAAL_DEPRECATED
239  */
240  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
241  {
242  return new Batch<algorithmFPType, method>(*this);
243  }
244 
245  /*
246  * \DAAL_DEPRECATED
247  */
248  void initialize()
249  {
250  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
251  _in = &input;
252  _par = &parameter;
253  _result.reset(new ResultType());
254  }
255 
256 private:
257  ResultPtr _result;
258  ParameterType _defaultParameter;
259 };
261 } // namespace interface1
262 using interface1::BatchContainer;
263 using interface1::Batch;
264 } // namespace forward
265 } // namespace lcn
266 } // namespace layers
267 } // namespace neural_networks
268 } // namespace algorithms
269 } // namespace daal
270 #endif
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:185
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch
Provides methods for forward local contrast normalization layer computations in the batch processing ...
Definition: lcn_layer_forward.h:115
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:178
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: lcn_layer_forward.h:142
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:164
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: lcn_layer_forward.h:124
daal_defines.h
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: lcn_layer_forward.h:221
daal::algorithms::neural_networks::layers::lcn::forward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: lcn_layer_forward.h:195
daal::algorithms::neural_networks::layers::lcn::forward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:171
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: lcn_layer_forward.h:153
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: lcn_layer_forward.h:207
daal::algorithms::neural_networks::layers::lcn::forward::interface1::BatchContainer
Provides methods to run implementations of the forward local contrast normalization layer...
Definition: lcn_layer_forward.h:65
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::lcn::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Definition: lcn_layer_forward.h:131
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::input
InputType input
Definition: lcn_layer_forward.h:125
daal::algorithms::neural_networks::layers::lcn::forward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()

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