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

spatial_maximum_pooling2d_layer_backward_types.h
1 /* file: spatial_maximum_pooling2d_layer_backward_types.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 backward spatial pyramid maximum 2D pooling layer.
45 //--
46 */
47 
48 #ifndef __SPATIAL_MAXIMUM_POOLING2D_LAYER_BACKWARD_TYPES_H__
49 #define __SPATIAL_MAXIMUM_POOLING2D_LAYER_BACKWARD_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/tensor.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/neural_networks/layers/layer_backward_types.h"
56 #include "algorithms/neural_networks/layers/spatial_pooling2d/spatial_pooling2d_layer_backward_types.h"
57 #include "algorithms/neural_networks/layers/spatial_pooling2d/spatial_maximum_pooling2d_layer_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace spatial_maximum_pooling2d
68 {
78 namespace backward
79 {
80 
84 namespace interface1
85 {
86 
91 class DAAL_EXPORT Input : public spatial_pooling2d::backward::Input
92 {
93 public:
94  typedef spatial_pooling2d::backward::Input super;
95 
99  Input();
100 
102  Input(const Input& other);
103 
104  virtual ~Input() {}
105 
106  using layers::backward::Input::get;
107  using layers::backward::Input::set;
108 
114  data_management::TensorPtr get(LayerDataId id) const;
115 
121  data_management::NumericTablePtr get(LayerDataNumericTableId id) const;
122 
128  void set(LayerDataId id, const data_management::TensorPtr &ptr);
129 
135  void set(LayerDataNumericTableId id, const data_management::NumericTablePtr &ptr);
136 
144  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
145 
146 protected:
147  virtual data_management::NumericTablePtr getAuxInputDimensions() const DAAL_C11_OVERRIDE;
148 };
149 
155 class DAAL_EXPORT Result : public spatial_pooling2d::backward::Result
156 {
157 public:
158  DECLARE_SERIALIZABLE_CAST(Result);
162  Result();
163  virtual ~Result() {}
164 
165  using layers::backward::Result::get;
166  using layers::backward::Result::set;
167 
176  template <typename algorithmFPType>
177  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
178 
187  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
188 
189 protected:
191  template<typename Archive, bool onDeserialize>
192  services::Status serialImpl(Archive *arch)
193  {
194  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
195  }
196 };
197 typedef services::SharedPtr<Result> ResultPtr;
198 
199 } // namespace interface1
200 using interface1::Input;
201 using interface1::Result;
202 using interface1::ResultPtr;
203 } // namespace backward
205 } // namespace spatial_maximum_pooling2d
206 } // namespace layers
207 } // namespace neural_networks
208 } // namespace algorithm
209 } // namespace daal
210 
211 #endif
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Input
Input objects for the backward spatial pyramid maximum 2D pooling layer
Definition: spatial_maximum_pooling2d_layer_backward_types.h:91
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::backward::interface1::Result::get
data_management::TensorPtr get(ResultId id) const
daal_defines.h
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
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::spatial_maximum_pooling2d::LayerDataId
LayerDataId
Identifiers of input tensors for the backward spatial pyramid maximum 2D pooling layer and results fo...
Definition: spatial_maximum_pooling2d_layer_types.h:86
daal::algorithms::neural_networks::layers::spatial_pooling2d::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward 2D spatial l...
Definition: spatial_pooling2d_layer_backward_types.h:131
daal::algorithms::neural_networks::layers::backward::interface1::Input::set
void set(InputId id, const data_management::TensorPtr &ptr)
daal::algorithms::neural_networks::layers::backward::interface1::Input::get
data_management::TensorPtr get(InputId id) const
daal::algorithms::neural_networks::layers::spatial_pooling2d::backward::interface1::Input
Input objects for the backward 2D spatial layer
Definition: spatial_pooling2d_layer_backward_types.h:90
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward spatial pyra...
Definition: spatial_maximum_pooling2d_layer_backward_types.h:155
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::LayerDataNumericTableId
LayerDataNumericTableId
Identifiers of input numeric tables for the backward spatial pyramid maximum 2D pooling layer and res...
Definition: spatial_maximum_pooling2d_layer_types.h:96
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::neural_networks::layers::backward::interface1::Result::set
void set(ResultId id, const data_management::TensorPtr &ptr)

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