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

locallyconnected2d_layer_forward.h
1 /* file: locallyconnected2d_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 two-dimensional (2D) locally connected layer in the batch
45 // processing mode
46 //--
47 */
48 
49 #ifndef __LOCALLYCONNECTED2D_LAYER_FORWARD_H__
50 #define __LOCALLYCONNECTED2D_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/locallyconnected2d/locallyconnected2d_layer_types.h"
57 #include "algorithms/neural_networks/layers/locallyconnected2d/locallyconnected2d_layer_forward_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace locallyconnected2d
68 {
69 namespace forward
70 {
71 namespace interface1
72 {
88 template<typename algorithmFPType, Method method, CpuType cpu>
89 class DAAL_EXPORT BatchContainer : public layers::forward::LayerContainerIfaceImpl
90 {
91 public:
97  BatchContainer(daal::services::Environment::env *daalEnv);
99  ~BatchContainer();
105  services::Status compute() DAAL_C11_OVERRIDE;
106  services::Status setupCompute() DAAL_C11_OVERRIDE;
107  virtual services::Status allocateInput() DAAL_C11_OVERRIDE
108  {
109  Input *input = static_cast<Input *>(_in);
110  return input->allocate<algorithmFPType>(_par, (int) method);
111  }
112 };
113 
129 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
130 class Batch : public layers::forward::LayerIfaceImpl
131 {
132 public:
133  typedef layers::forward::LayerIfaceImpl super;
134 
135  typedef algorithms::neural_networks::layers::locallyconnected2d::forward::Input InputType;
136  typedef algorithms::neural_networks::layers::locallyconnected2d::Parameter ParameterType;
137  typedef algorithms::neural_networks::layers::locallyconnected2d::forward::Result ResultType;
138 
139  ParameterType &parameter;
140  InputType input;
143  Batch() : parameter(_defaultParameter)
144  {
145  initialize();
146  };
147 
153  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
154  {
155  initialize();
156  };
157 
163  Batch(const Batch<algorithmFPType, method> &other) : super(other),
164  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
165  {
166  initialize();
167  }
168 
173  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
174 
179  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
180 
185  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
186 
191  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
192  {
193  return getResult();
194  }
195 
200  ResultPtr getResult()
201  {
202  return _result;
203  }
204 
211  services::Status setResult(const ResultPtr& result)
212  {
213  DAAL_CHECK(result, services::ErrorNullResult)
214  _result = result;
215  _res = _result.get();
216  return services::Status();
217  }
218 
224  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
225  {
226  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
227  }
228 
229  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  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
238  {
239  return new Batch<algorithmFPType, method>(*this);
240  }
241 
242  void initialize()
243  {
244  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
245  _in = &input;
246  _par = &parameter;
247  _result.reset(new ResultType());
248  }
249 
250 private:
251  ResultPtr _result;
252  ParameterType _defaultParameter;
253 };
254 
256 } // namespace interface1
257 using interface1::BatchContainer;
258 using interface1::Batch;
259 } // namespace forward
260 } // namespace locallyconnected2d
261 } // namespace layers
262 } // namespace neural_networks
263 } // namespace algorithms
264 } // namespace daal
265 #endif
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch
Provides methods for forward 2D locally connected layer computations in the batch processing mode...
Definition: locallyconnected2d_layer_forward.h:130
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::forward::interface1::LayerIface
Abstract class which defines interface for the layer.
Definition: layer_forward.h:86
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::input
InputType input
Definition: locallyconnected2d_layer_forward.h:140
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Result
Results obtained with the compute() method of the forward 2D locally connected layer in the batch pro...
Definition: locallyconnected2d_layer_forward_types.h:149
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: locallyconnected2d_layer_forward.h:139
daal_defines.h
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: locallyconnected2d_layer_forward.h:163
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::BatchContainer
Provides methods to run implementations of the forward 2D locally connected layer. This class is associated with the daal::algorithms::neural_networks::layers::locallyconnected2d::forward::Batch class and supports the method of forward 2D locally connected layer computation in the batch processing mode.
Definition: locallyconnected2d_layer_forward.h:89
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::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::locallyconnected2d::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: locallyconnected2d_layer_forward.h:200
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: locallyconnected2d_layer_forward.h:173
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Input
Input objects for the forward 2D locally connected layer
Definition: locallyconnected2d_layer_forward_types.h:89
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: locallyconnected2d_layer_forward.h:185
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::Batch
Batch()
Definition: locallyconnected2d_layer_forward.h:143
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Input::allocate
DAAL_EXPORT services::Status allocate(const daal::algorithms::Parameter *parameter, const int method)
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::BatchContainer::allocateInput
virtual services::Status allocateInput() DAAL_C11_OVERRIDE
Definition: locallyconnected2d_layer_forward.h:107
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: locallyconnected2d_layer_forward.h:211
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::forward::interface1::Input
Input objects for layer algorithm
Definition: layer_forward_types.h:149
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::locallyconnected2d::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: locallyconnected2d_layer_forward.h:229
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: locallyconnected2d_layer_forward.h:179
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: locallyconnected2d_layer_forward.h:224
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
daal::algorithms::neural_networks::layers::locallyconnected2d::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: locallyconnected2d_layer_forward.h:153
daal::algorithms::neural_networks::layers::locallyconnected2d::interface1::Parameter
2D locally connected layer parameters
Definition: locallyconnected2d_layer_types.h:161

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