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

logistic_cross_layer_backward.h
1 /* file: logistic_cross_layer_backward.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 backward logistic cross-entropy layer in the batch processing mode
45 //--
46 */
47 
48 #ifndef __NEURAL_NENTWORK_LOSS_LOGISTIC_CROSS_LAYER_BACKWARD_H__
49 #define __NEURAL_NENTWORK_LOSS_LOGISTIC_CROSS_LAYER_BACKWARD_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/tensor.h"
53 #include "services/daal_defines.h"
54 #include "algorithms/neural_networks/layers/layer.h"
55 #include "algorithms/neural_networks/layers/loss/loss_layer_backward.h"
56 #include "algorithms/neural_networks/layers/loss/logistic_cross_layer_types.h"
57 #include "algorithms/neural_networks/layers/loss/logistic_cross_layer_backward_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace loss
68 {
69 namespace logistic_cross
70 {
71 namespace backward
72 {
73 namespace interface1
74 {
90 template<typename algorithmFPType, Method method, CpuType cpu>
91 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
92 {
93 public:
99  BatchContainer(daal::services::Environment::env *daalEnv);
101  ~BatchContainer();
107  services::Status compute() DAAL_C11_OVERRIDE;
108 };
109 
128 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
129 class Batch : public loss::backward::Batch
130 {
131 public:
132  typedef loss::backward::Batch super;
133 
134  typedef algorithms::neural_networks::layers::loss::logistic_cross::backward::Input InputType;
135  typedef algorithms::neural_networks::layers::loss::logistic_cross::Parameter ParameterType;
136  typedef algorithms::neural_networks::layers::loss::logistic_cross::backward::Result ResultType;
137 
138  ParameterType &parameter;
139  InputType input;
142  Batch() : parameter(_defaultParameter)
143  {
144  initialize();
145  };
146 
152  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
153  {
154  initialize();
155  }
156 
157 
164  Batch(const Batch<algorithmFPType, method> &other) : super(other),
165  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
166  {
167  initialize();
168  }
169 
174  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
175 
180  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
181 
186  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
187 
192  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
193  {
194  return _result;
195  }
196 
201  ResultPtr getResult()
202  {
203  return _result;
204  }
205 
212  services::Status setResult(const ResultPtr& result)
213  {
214  DAAL_CHECK(result, services::ErrorNullResult)
215  _result = result;
216  _res = _result.get();
217  return services::Status();
218  }
219 
226  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
227  {
228  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
229  }
230 
236  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
237  {
238  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
239  this->_res = this->_result.get();
240  return s;
241  }
242 
243 protected:
244  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
245  {
246  return new Batch<algorithmFPType, method>(*this);
247  }
248 
249  void initialize()
250  {
251  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
252  _in = &input;
253  _par = &parameter;
254  _result.reset(new ResultType());
255  }
256 
257 private:
258  ResultPtr _result;
259  ParameterType _defaultParameter;
260 };
262 } // namespace interface1
263 using interface1::BatchContainer;
264 using interface1::Batch;
265 } // namespace backward
266 } // namespace logistic_cross
267 } // namespace loss
268 } // namespace layers
269 } // namespace neural_networks
270 } // namespace algorithms
271 } // namespace daal
272 #endif
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: logistic_cross_layer_backward.h:212
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch
Provides methods for the backward logistic cross-entropy layer in the batch processing mode...
Definition: logistic_cross_layer_backward.h:129
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::Batch
Batch()
Definition: logistic_cross_layer_backward.h:142
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::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: logistic_cross_layer_backward.h:174
daal::algorithms::neural_networks::layers::loss::backward::interface1::Batch
Provides methods for the backward loss layer in the batch processing mode.
Definition: loss_layer_backward.h:92
daal::algorithms::neural_networks::layers::backward::interface1::LayerIface
Abstract class which defines interface for the layer.
Definition: layer_backward.h:85
daal::algorithms::neural_networks::layers::loss::logistic_cross::interface1::Parameter
Parameters for the logistic cross-entropy layer.
Definition: logistic_cross_layer_types.h:108
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward logistic cro...
Definition: logistic_cross_layer_backward_types.h:142
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::input
InputType input
Definition: logistic_cross_layer_backward.h:139
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: logistic_cross_layer_backward.h:201
daal_defines.h
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: logistic_cross_layer_backward.h:164
daal::batch
Definition: daal_defines.h:132
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::loss::logistic_cross::backward::interface1::Input
Input objects for the backward logistic cross-entropy layer
Definition: logistic_cross_layer_backward_types.h:91
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: logistic_cross_layer_backward.h:226
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward logistic cross-entropy layer This clas...
Definition: logistic_cross_layer_backward.h:91
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::loss::logistic_cross::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: logistic_cross_layer_backward.h:138
daal::algorithms::neural_networks::layers::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_backward_types.h:224
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: logistic_cross_layer_backward.h:236
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: logistic_cross_layer_backward.h:152
daal::algorithms::neural_networks::layers::backward::interface1::Input
Input parameters for the layer algorithm
Definition: layer_backward_types.h:150
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: logistic_cross_layer_backward.h:180
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::loss::logistic_cross::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: logistic_cross_layer_backward.h:186

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