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

implicit_als_predict_ratings_batch.h
1 /* file: implicit_als_predict_ratings_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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 implicit ALS model-based ratings prediction
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __IMPLICIT_ALS_PREDICT_RATINGS_BATCH_H__
50 #define __IMPLICIT_ALS_PREDICT_RATINGS_BATCH_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "algorithms/implicit_als/implicit_als_predict_ratings_types.h"
54 
55 namespace daal
56 {
57 namespace algorithms
58 {
59 namespace implicit_als
60 {
61 namespace prediction
62 {
63 namespace ratings
64 {
65 namespace interface1
66 {
79 template<typename algorithmFPType, Method method, CpuType cpu>
80 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
81 {
82 public:
88  BatchContainer(daal::services::Environment::env *daalEnv);
90  ~BatchContainer();
95  services::Status compute() DAAL_C11_OVERRIDE;
96 };
97 
109 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
110 class Batch : public daal::algorithms::Prediction
111 {
112 public:
113  Input input;
114  Parameter parameter;
119  Batch()
120  {
121  initialize();
122  }
123 
130  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
131  {
132  initialize();
133  }
134 
135  virtual ~Batch() {}
136 
141  ResultPtr getResult()
142  {
143  return _result;
144  }
145 
150  services::Status setResult(const ResultPtr &result)
151  {
152  DAAL_CHECK(result, services::ErrorNullResult)
153  _result = result;
154  _res = _result.get();
155  return services::Status();
156  }
157 
162  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
163 
169  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
170  {
171  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
172  }
173 
174 protected:
175  ResultPtr _result;
176 
177  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
178  {
179  return new Batch<algorithmFPType, method>(*this);
180  }
181 
182  services::Status allocateResult() DAAL_C11_OVERRIDE
183  {
184  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int)method);
185  _res = _result.get();
186  return s;
187  }
188 
189  void initialize()
190  {
191  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
192  _in = &input;
193  _par = &parameter;
194  _result.reset(new Result());
195  }
196 
197 };
199 } // interface1
200 using interface1::BatchContainer;
201 using interface1::Batch;
202 
203 }
204 }
205 }
206 }
207 }
208 #endif
daal::algorithms::implicit_als::prediction::ratings::interface1::Input
Input objects for the rating prediction stage of the implicit ALS algorithm
Definition: implicit_als_predict_ratings_types.h:169
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::parameter
Parameter parameter
Definition: implicit_als_predict_ratings_batch.h:114
daal
Definition: algorithm_base_common.h:57
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_predict_ratings_batch.h:162
daal::algorithms::Prediction
Provides prediction methods depending on the model such as linear_regression::Model. The methods of the class support different computation modes: batch, distributed, and online(see ComputeMode). Classes that implement specific algorithms of the model based data prediction are derived classes of the Prediction class. The class additionally provides virtual methods for validation of input and output parameters of the algorithms.
Definition: prediction.h:76
daal::algorithms::PredictionContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the algor...
Definition: prediction.h:66
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: implicit_als_predict_ratings_batch.h:150
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::input
Input input
Definition: implicit_als_predict_ratings_batch.h:113
daal::algorithms::implicit_als::prediction::ratings::interface1::BatchContainer
Provides methods to run implementations of the implicit ALS ratings prediction algorithm in the batch...
Definition: implicit_als_predict_ratings_batch.h:80
daal::batch
Definition: daal_defines.h:131
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::getResult
ResultPtr getResult()
Definition: implicit_als_predict_ratings_batch.h:141
daal::algorithms::classifier::prediction::prediction
Definition: classifier_predict_types.h:102
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: implicit_als_predict_ratings_batch.h:130
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::Batch
Batch()
Definition: implicit_als_predict_ratings_batch.h:119
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: implicit_als_predict_ratings_batch.h:169
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::implicit_als::prediction::ratings::interface1::Batch
Predicts the results of the implicit ALS algorithm.
Definition: implicit_als_predict_ratings_batch.h:110

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