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

svd_batch.h
1 /* file: svd_batch.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 SVD algorithm in the batch processing mode
45 //--
46 */
47 
48 #ifndef __SVD_BATCH_H__
49 #define __SVD_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "services/daal_defines.h"
54 #include "algorithms/svd/svd_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace svd
61 {
62 
63 namespace interface1
64 {
78 template<typename algorithmFPType, Method method, CpuType cpu>
79 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
80 {
81 public:
87  BatchContainer(daal::services::Environment::env *daalEnv);
89  virtual ~BatchContainer();
93  virtual services::Status compute() DAAL_C11_OVERRIDE;
94 };
95 
107 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
108 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
109 {
110 public:
111  typedef algorithms::svd::Input InputType;
112  typedef algorithms::svd::Parameter ParameterType;
113  typedef algorithms::svd::Result ResultType;
114 
115  InputType input;
116  ParameterType parameter;
118  Batch()
119  {
120  initialize();
121  }
122 
129  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
130  {
131  initialize();
132  }
133 
138  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
139 
144  ResultPtr getResult()
145  {
146  return _result;
147  }
148 
152  services::Status setResult(const ResultPtr& res)
153  {
154  DAAL_CHECK(res, services::ErrorNullResult)
155  _result = res;
156  _res = _result.get();
157  return services::Status();
158  }
159 
165  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
166  {
167  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
168  }
169 
170 protected:
171  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
172  {
173  return new Batch<algorithmFPType, method>(*this);
174  }
175 
176  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
177  {
178  _result.reset(new ResultType());
179  services::Status s = _result->allocate<algorithmFPType>(_in, 0, 0);
180  _res = _result.get();
181  return s;
182  }
183 
184  void initialize()
185  {
186  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
187  _in = &input;
188  _par = &parameter;
189  }
190 
191 private:
192  ResultPtr _result;
193 };
195 } // namespace interface1
196 using interface1::BatchContainer;
197 using interface1::Batch;
198 
199 } // namespace daal::algorithms::svd
200 }
201 } // namespace daal
202 #endif
daal::algorithms::svd::interface1::Batch::input
InputType input
Definition: svd_batch.h:115
daal::algorithms::svd::interface1::Parameter
Parameters for the computation method of the SVD algorithm.
Definition: svd_types.h:187
daal::algorithms::svd::interface1::Batch
Computes results of the SVD algorithm in the batch processing mode.
Definition: svd_batch.h:108
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::svd::interface1::Batch::parameter
ParameterType parameter
Definition: svd_batch.h:116
daal::algorithms::svd::interface1::Result
Provides methods to access final results obtained with the compute() method of the SVD algorithm in t...
Definition: svd_types.h:425
daal::algorithms::svd::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: svd_batch.h:152
daal::algorithms::svd::interface1::BatchContainer
Provides methods to run implementations of the SVD algorithm.
Definition: svd_batch.h:79
daal_defines.h
daal::batch
Definition: daal_defines.h:132
daal::algorithms::svd::interface1::Input
Input objects for the SVD algorithm in the batch processing and online processing modes...
Definition: svd_types.h:207
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::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::svd::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: svd_batch.h:138
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::svd::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: svd_batch.h:129
daal::algorithms::svd::interface1::Batch::getResult
ResultPtr getResult()
Definition: svd_batch.h:144
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::svd::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: svd_batch.h:165

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