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

lcn_layer_forward.h
1 /* file: lcn_layer_forward.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 forward local contrast normalization layer in the batch
45 // processing mode
46 //--
47 */
48 
49 #ifndef __NEURAL_NETWORK_LCN_LAYER_FORWARD_H__
50 #define __NEURAL_NETWORK_LCN_LAYER_FORWARD_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/lcn/lcn_layer_types.h"
57 #include "algorithms/neural_networks/layers/lcn/lcn_layer_forward_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace lcn
68 {
69 namespace forward
70 {
71 namespace interface1
72 {
87 template<typename algorithmFPType, Method method, CpuType cpu>
88 class DAAL_EXPORT BatchContainer : public layers::forward::LayerContainerIfaceImpl
89 {
90 public:
96  BatchContainer(daal::services::Environment::env *daalEnv);
98  ~BatchContainer();
104  services::Status compute() DAAL_C11_OVERRIDE;
105  services::Status setupCompute() DAAL_C11_OVERRIDE;
106  services::Status resetCompute() DAAL_C11_OVERRIDE;
107 };
108 
124 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
125 class Batch : public layers::forward::LayerIfaceImpl
126 {
127 public:
128  typedef layers::forward::LayerIfaceImpl super;
129  Parameter &parameter;
130  Input input;
133  Batch() : parameter(_defaultParameter)
134  {
135  initialize();
136  };
137 
143  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
144  {
145  initialize();
146  };
147 
153  Batch(const Batch<algorithmFPType, method> &other) : super(other),
154  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
155  {
156  initialize();
157  }
158 
163  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
164 
169  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
170 
175  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
176 
181  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
182  {
183  return getResult();
184  }
185 
190  ResultPtr getResult()
191  {
192  return _result;
193  }
194 
201  services::Status setResult(const ResultPtr& result)
202  {
203  DAAL_CHECK(result, services::ErrorNullResult);
204  _result = result;
205  _res = _result.get();
206  return services::Status();
207  }
208 
214  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
215  {
216  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
217  }
218 
219  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
220  {
221  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
222  this->_res = this->_result.get();
223  return s;
224  }
225 
226 protected:
227  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
228  {
229  return new Batch<algorithmFPType, method>(*this);
230  }
231 
232  void initialize()
233  {
234  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
235  _in = &input;
236  _par = &parameter;
237  _result.reset(new Result());
238  }
239 
240 private:
241  ResultPtr _result;
242  Parameter _defaultParameter;
243 };
245 } // namespace interface1
246 using interface1::BatchContainer;
247 using interface1::Batch;
248 } // namespace forward
249 } // namespace lcn
250 } // namespace layers
251 } // namespace neural_networks
252 } // namespace algorithms
253 } // namespace daal
254 #endif
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::parameter
Parameter & parameter
Definition: lcn_layer_forward.h:129
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:163
daal
Definition: algorithm_base_common.h:57
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:169
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:88
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: lcn_layer_forward.h:190
daal_defines.h
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerResult
layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:181
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: lcn_layer_forward.h:201
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::input
Input input
Definition: lcn_layer_forward.h:130
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::Batch
Batch()
Definition: lcn_layer_forward.h:133
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: lcn_layer_forward.h:143
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:175
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:125
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::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::Input
Input objects for the forward local contrast normalization layer
Definition: lcn_layer_forward_types.h:89
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: lcn_layer_forward.h:214
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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