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

initializer_types.h
1 /* file: initializer_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 neural_networks Network layer.
45 //--
46 */
47 
48 #ifndef __INITIALIZERS__TYPES__H__
49 #define __INITIALIZERS__TYPES__H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/tensor.h"
53 #include "services/daal_defines.h"
54 #include "services/collection.h"
55 #include "data_management/data/data_collection.h"
56 #include "algorithms/neural_networks/initializers/initializer_types_defs.h"
57 #include "algorithms/engines/engine.h"
58 #include "algorithms/engines/mt19937/mt19937.h"
59 
60 namespace daal
61 {
62 namespace algorithms
63 {
64 namespace neural_networks
65 {
75 namespace initializers
76 {
81 enum InputId
82 {
83  data,
84  lastInputId = data
85 };
86 
91 enum ResultId
92 {
93  value,
94  lastResultId = value
95 };
96 
100 namespace interface1
101 {
102 
107 class Parameter: public daal::algorithms::Parameter
108 {
109 public:
110  Parameter(layers::forward::LayerIfacePtr layerForParameter = layers::forward::LayerIfacePtr()): layer(layerForParameter) {}
111  virtual ~Parameter() {}
112 
113  layers::forward::LayerIfacePtr layer;
114  engines::EnginePtr engine;
115 };
116 
121 class DAAL_EXPORT Input : public daal::algorithms::Input
122 {
123 public:
127  Input() : daal::algorithms::Input(1) {}
129  Input(const Input& other) : daal::algorithms::Input(other){}
130 
131  virtual ~Input() {}
132 
138  data_management::TensorPtr get(InputId id) const
139  {
140  return data_management::Tensor::cast(Argument::get(id));
141  }
142 
148  void set(InputId id, const data_management::TensorPtr &ptr)
149  {
150  Argument::set(id, ptr);
151  }
152 
160  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
161 };
162 
167 class DAAL_EXPORT Result : public daal::algorithms::Result
168 {
169 public:
171  Result() : daal::algorithms::Result(1) {}
172 
173  virtual ~Result() {}
174 
183  template <typename algorithmFPType>
184  services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method)
185  {
186  const Input *algInput = static_cast<const Input *>(input);
187 
188  set(value, algInput->get(data));
189  return services::Status();
190  }
191 
197  data_management::TensorPtr get(ResultId id) const
198  {
199  return data_management::Tensor::cast(Argument::get(id));
200  }
201 
207  void set(ResultId id, const data_management::TensorPtr &ptr)
208  {
209  Argument::set(id, ptr);
210  }
211 
220  virtual services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter,
221  int method) const DAAL_C11_OVERRIDE;
222 
223 protected:
225  template<typename Archive, bool onDeserialize>
226  services::Status serialImpl(Archive *arch)
227  {
228  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
229  }
230 };
231 typedef services::SharedPtr<Result> ResultPtr;
232 } // interface1
233 using interface1::Input;
234 using interface1::Result;
235 using interface1::ResultPtr;
236 using interface1::Parameter;
237 } // namespace initializers
239 } // namespace neural_networks
240 } // namespace algorithm
241 } // namespace daal
242 #endif
daal::algorithms::neural_networks::initializers::value
Definition: initializer_types.h:93
daal::algorithms::neural_networks::initializers::interface1::Parameter::layer
layers::forward::LayerIfacePtr layer
Definition: initializer_types.h:113
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::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::algorithms::neural_networks::initializers::interface1::Input::Input
Input()
Definition: initializer_types.h:127
daal::algorithms::neural_networks::initializers::interface1::Input::Input
Input(const Input &other)
Definition: initializer_types.h:129
daal::algorithms::neural_networks::initializers::interface1::Input
Input objects for initializer algorithm
Definition: initializer_types.h:121
daal::algorithms::neural_networks::initializers::interface1::Result::Result
Result()
Constructor.
Definition: initializer_types.h:171
daal_defines.h
daal::algorithms::neural_networks::initializers::interface1::Parameter::engine
engines::EnginePtr engine
Definition: initializer_types.h:114
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::initializers::data
Definition: initializer_types.h:83
daal::algorithms::neural_networks::initializers::ResultId
ResultId
Definition: initializer_types.h:91
daal::algorithms::neural_networks::initializers::interface1::Result
Provides methods to access the result obtained with the compute() method of the neural network weight...
Definition: initializer_types.h:167
daal::algorithms::neural_networks::initializers::interface1::Result::allocate
services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method)
Definition: initializer_types.h:184
daal::algorithms::neural_networks::initializers::InputId
InputId
Definition: initializer_types.h:81
daal::algorithms::neural_networks::initializers::interface1::Input::get
data_management::TensorPtr get(InputId id) const
Definition: initializer_types.h:138
daal::algorithms::interface1::Argument::get
const data_management::SerializationIfacePtr & get(size_t index) const
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::interface1::Argument::set
void set(size_t index, const data_management::SerializationIfacePtr &value)
daal::algorithms::neural_networks::initializers::interface1::Parameter
Definition: initializer_types.h:107

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