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

lcn_layer_forward.h
1 /* file: lcn_layer_forward.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 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 
130  typedef algorithms::neural_networks::layers::lcn::forward::Input InputType;
131  typedef algorithms::neural_networks::layers::lcn::Parameter ParameterType;
132  typedef algorithms::neural_networks::layers::lcn::forward::Result ResultType;
133 
134  ParameterType &parameter;
135  InputType input;
138  Batch() : parameter(_defaultParameter)
139  {
140  initialize();
141  };
142 
148  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
149  {
150  initialize();
151  };
152 
158  Batch(const Batch<algorithmFPType, method> &other) : super(other),
159  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
160  {
161  initialize();
162  }
163 
168  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
169 
174  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
175 
180  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
181 
186  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
187  {
188  return getResult();
189  }
190 
195  ResultPtr getResult()
196  {
197  return _result;
198  }
199 
206  services::Status setResult(const ResultPtr& result)
207  {
208  DAAL_CHECK(result, services::ErrorNullResult);
209  _result = result;
210  _res = _result.get();
211  return services::Status();
212  }
213 
219  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
220  {
221  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
222  }
223 
224  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
225  {
226  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
227  this->_res = this->_result.get();
228  return s;
229  }
230 
231 protected:
232  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
233  {
234  return new Batch<algorithmFPType, method>(*this);
235  }
236 
237  void initialize()
238  {
239  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
240  _in = &input;
241  _par = &parameter;
242  _result.reset(new ResultType());
243  }
244 
245 private:
246  ResultPtr _result;
247  ParameterType _defaultParameter;
248 };
250 } // namespace interface1
251 using interface1::BatchContainer;
252 using interface1::Batch;
253 } // namespace forward
254 } // namespace lcn
255 } // namespace layers
256 } // namespace neural_networks
257 } // namespace algorithms
258 } // namespace daal
259 #endif
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:168
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::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::parameter
ParameterType & parameter
Definition: lcn_layer_forward.h:134
daal::algorithms::neural_networks::layers::forward::interface1::LayerIface
Abstract class which defines interface for the layer.
Definition: layer_forward.h:86
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: lcn_layer_forward.h:219
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: lcn_layer_forward.h:195
daal::algorithms::neural_networks::layers::lcn::interface1::Parameter
local contrast normalization layer parameters
Definition: lcn_layer_types.h:118
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:174
daal_defines.h
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: lcn_layer_forward.h:148
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: lcn_layer_forward.h:206
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::Batch
Batch()
Definition: lcn_layer_forward.h:138
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::lcn::forward::interface1::Result
Results obtained with the compute() method of the forward local contrast normalization layer in the b...
Definition: lcn_layer_forward_types.h:139
daal::algorithms::neural_networks::layers::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_forward_types.h:241
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:180
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::input
InputType input
Definition: lcn_layer_forward.h:135
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: lcn_layer_forward.h:224
daal::algorithms::neural_networks::layers::forward::interface1::Input
Input objects for layer algorithm
Definition: layer_forward_types.h:149
daal::algorithms::neural_networks::layers::lcn::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: lcn_layer_forward.h:158
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::forward::interface1::LayerContainerIfaceImpl
Provides methods of base container for forward layers. This class is associated with the daal::algori...
Definition: layer_forward_container_base.h:86
daal::algorithms::neural_networks::layers::forward::interface1::LayerIfaceImpl
Implements the abstract interface LayerIface. LayerIfaceImpl is, in turn, the base class for the clas...
Definition: layer_forward.h:169
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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