C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

softmax_cross_layer_forward.h
1 /* file: softmax_cross_layer_forward.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of the interface for the forward softmax cross-entropy layer in the batch processing mode
21 //--
22 */
23 
24 #ifndef __LOSS_SOFTMAX_CROSS_LAYER_FORWARD_H__
25 #define __LOSS_SOFTMAX_CROSS_LAYER_FORWARD_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "services/daal_defines.h"
29 #include "algorithms/neural_networks/layers/layer.h"
30 #include "algorithms/neural_networks/layers/loss/loss_layer_forward.h"
31 #include "algorithms/neural_networks/layers/loss/softmax_cross_layer_types.h"
32 #include "algorithms/neural_networks/layers/loss/softmax_cross_layer_forward_types.h"
33 #include "algorithms/neural_networks/layers/softmax/softmax_layer_forward.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
43 namespace loss
44 {
45 namespace softmax_cross
46 {
47 namespace forward
48 {
49 namespace interface1
50 {
68 template<typename algorithmFPType, Method method, CpuType cpu>
69 class BatchContainer : public layers::forward::LayerContainerIfaceImpl
70 {
71 public:
78  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
83  DAAL_DEPRECATED ~BatchContainer();
90  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
91 };
92 
113 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
114 class Batch : public loss::forward::Batch
115 {
116 public:
117  typedef loss::forward::Batch super;
118 
119  typedef algorithms::neural_networks::layers::loss::softmax_cross::forward::Input InputType;
120  typedef algorithms::neural_networks::layers::loss::softmax_cross::Parameter ParameterType;
121  typedef algorithms::neural_networks::layers::loss::softmax_cross::forward::Result ResultType;
122 
123  ParameterType &parameter;
124  InputType input;
130  DAAL_DEPRECATED Batch() : parameter(_defaultParameter)
131  {
132  initialize();
133  };
134 
141  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
142  {
143  initialize();
144  }
145 
153  Batch(const Batch<algorithmFPType, method> &other) : super(other),
154  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
155  {
156  initialize();
157  }
158 
164  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
165 
171  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
172 
178  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
179 
185  DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
186  {
187  return getResult();
188  }
189 
195  ResultPtr getResult()
196  {
197  return _result;
198  }
199 
207  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
208  {
209  DAAL_CHECK(result, services::ErrorNullResult)
210  _result = result;
211  _res = _result.get();
212  return services::Status();
213  }
214 
222  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
223  {
224  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
225  }
226 
233  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateResult() DAAL_C11_OVERRIDE
234  {
235  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
236  this->_res = this->_result.get();
237  return s;
238  }
239 
245  DAAL_DEPRECATED_VIRTUAL virtual layers::forward::LayerIfacePtr getLayerForPrediction() const DAAL_C11_OVERRIDE
246  {
247  return layers::forward::LayerIfacePtr(
248  new layers::softmax::forward::Batch<algorithmFPType>());
249  }
250 
251 protected:
252  /*
253  * \DAAL_DEPRECATED
254  */
255  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
256  {
257  return new Batch<algorithmFPType, method>(*this);
258  }
259 
260  /*
261  * \DAAL_DEPRECATED
262  */
263  void initialize()
264  {
265  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
266  _in = &input;
267  _par = &parameter;
268  _result.reset(new ResultType());
269  }
270 
271 private:
272  ResultPtr _result;
273  ParameterType _defaultParameter;
274 };
276 } // namespace interface1
277 using interface1::BatchContainer;
278 using interface1::Batch;
279 } // namespace forward
280 } // namespace softmax_cross
281 } // namespace loss
282 } // namespace layers
283 } // namespace neural_networks
284 } // namespace algorithms
285 } // namespace daal
286 #endif
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: softmax_cross_layer_forward.h:207
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: softmax_cross_layer_forward.h:141
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: softmax_cross_layer_forward.h:178
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::allocateResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: softmax_cross_layer_forward.h:233
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: softmax_cross_layer_forward.h:164
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: softmax_cross_layer_forward.h:185
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: softmax_cross_layer_forward.h:222
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch
Provides methods for the forward softmax cross layer in the batch processing mode.
Definition: softmax_cross_layer_forward.h:114
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: softmax_cross_layer_forward.h:195
daal_defines.h
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: softmax_cross_layer_forward.h:123
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: softmax_cross_layer_forward.h:153
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Definition: softmax_cross_layer_forward.h:130
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::input
InputType input
Definition: softmax_cross_layer_forward.h:124
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: softmax_cross_layer_forward.h:171
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::Batch::getLayerForPrediction
virtual DAAL_DEPRECATED_VIRTUAL layers::forward::LayerIfacePtr getLayerForPrediction() const DAAL_C11_OVERRIDE
Definition: softmax_cross_layer_forward.h:245
daal::algorithms::neural_networks::layers::loss::softmax_cross::forward::interface1::BatchContainer
Provides methods to run implementations of the of the forward softmax cross-entropy layer This class ...
Definition: softmax_cross_layer_forward.h:69

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