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

maximum_pooling3d_layer_backward_types.h
1 /* file: maximum_pooling3d_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 maximum 3D pooling layer.
45 //--
46 */
47 
48 #ifndef __MAXIMUM_POOLING3D_LAYER_BACKWARD_TYPES_H__
49 #define __MAXIMUM_POOLING3D_LAYER_BACKWARD_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/tensor.h"
53 #include "data_management/data/homogen_tensor.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/neural_networks/layers/pooling3d/pooling3d_layer_backward_types.h"
56 #include "algorithms/neural_networks/layers/pooling3d/maximum_pooling3d_layer_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace neural_networks
63 {
64 namespace layers
65 {
66 namespace maximum_pooling3d
67 {
77 namespace backward
78 {
79 
83 namespace interface1
84 {
85 
90 class DAAL_EXPORT Input : public pooling3d::backward::Input
91 {
92 public:
93  typedef pooling3d::backward::Input super;
97  Input();
98 
100  Input(const Input& other);
101 
102  virtual ~Input() {}
103 
104  using layers::backward::Input::get;
105  using layers::backward::Input::set;
106 
112  data_management::TensorPtr get(LayerDataId id) const;
113 
119  data_management::NumericTablePtr get(LayerDataNumericTableId id) const;
120 
126  void set(LayerDataId id, const data_management::TensorPtr &ptr);
127 
133  void set(LayerDataNumericTableId id, const data_management::NumericTablePtr &ptr);
134 
142  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
143 
144 protected:
145  virtual data_management::NumericTablePtr getAuxInputDimensions() const DAAL_C11_OVERRIDE;
146 };
147 
153 class DAAL_EXPORT Result : public pooling3d::backward::Result
154 {
155 public:
156  DECLARE_SERIALIZABLE_CAST(Result);
160  Result();
161  virtual ~Result() {}
162 
163  using layers::backward::Result::get;
164  using layers::backward::Result::set;
165 
174  template <typename algorithmFPType>
175  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
176 
185  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
186 
187 protected:
189  template<typename Archive, bool onDeserialize>
190  services::Status serialImpl(Archive *arch)
191  {
192  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
193  }
194 };
195 typedef services::SharedPtr<Result> ResultPtr;
196 
197 } // namespace interface1
198 using interface1::Input;
199 using interface1::Result;
200 using interface1::ResultPtr;
201 } // namespace backward
203 } // namespace maximum_pooling3d
204 } // namespace layers
205 } // namespace neural_networks
206 } // namespace algorithm
207 } // namespace daal
208 
209 #endif
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::algorithms::neural_networks::layers::maximum_pooling3d::backward::interface1::Input
Input objects for the backward maximum 3D pooling layer
Definition: maximum_pooling3d_layer_backward_types.h:90
daal_defines.h
daal::algorithms::neural_networks::layers::maximum_pooling3d::LayerDataId
LayerDataId
Identifiers of input tensors for the backward maximum 3D pooling layer and results for the forward ma...
Definition: maximum_pooling3d_layer_types.h:86
daal::algorithms::neural_networks::layers::pooling3d::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward 3D pooling l...
Definition: pooling3d_layer_backward_types.h:120
daal::algorithms::neural_networks::layers::pooling3d::backward::interface1::Input
Input objects for the backward 3D pooling layer
Definition: pooling3d_layer_backward_types.h:89
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::maximum_pooling3d::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward maximum 3D p...
Definition: maximum_pooling3d_layer_backward_types.h:153
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::maximum_pooling3d::LayerDataNumericTableId
LayerDataNumericTableId
Identifiers of input numeric tables for the backward maximum 3D pooling layer and results for the for...
Definition: maximum_pooling3d_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.