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

apriori.h
1 /* file: apriori.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 association rules algorithm
21 //--
22 */
23 
24 #ifndef __APRIORI_H__
25 #define __APRIORI_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "services/daal_defines.h"
30 #include "algorithms/association_rules/apriori_types.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
36 namespace association_rules
37 {
38 namespace interface1
39 {
53 template<typename algorithmFPType, Method method, CpuType cpu>
54 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
55 {
56 public:
62  BatchContainer(daal::services::Environment::env *daalEnv);
64  ~BatchContainer();
68  virtual services::Status compute();
69 };
70 
84 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = apriori>
85 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
86 {
87 public:
88  typedef algorithms::association_rules::Input InputType;
89  typedef algorithms::association_rules::Parameter ParameterType;
90  typedef algorithms::association_rules::Result ResultType;
91 
93  Batch()
94  {
95  initialize();
96  }
97 
104  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
105  {
106  initialize();
107  }
108 
113  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
114 
119  ResultPtr getResult()
120  {
121  return _result;
122  }
123 
128  services::Status setResult(const ResultPtr& res)
129  {
130  DAAL_CHECK(res, services::ErrorNullResult)
131  _result = res;
132  _res = _result.get();
133  return services::Status();
134  }
135 
141  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
142  {
143  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
144  }
145 
146 protected:
147  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
148  {
149  return new Batch<algorithmFPType, method>(*this);
150  }
151 
152  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
153  {
154  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int) method);
155  _res = _result.get();
156  return s;
157  }
158 
159  void initialize()
160  {
161  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
162  _in = &input;
163  _par = &parameter;
164  _result.reset(new ResultType());
165  }
166 public:
167  InputType input;
168  ParameterType parameter;
170 private:
171  ResultPtr _result;
172 };
174 } // namespace interface1
175 using interface1::BatchContainer;
176 using interface1::Batch;
177 
178 } // namespace association_rules
179 } // namespace algorithm
180 } // namespace daal
181 #endif
daal::algorithms::association_rules::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::association_rules::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: apriori.h:104
daal::algorithms::association_rules::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: apriori.h:113
daal::algorithms::association_rules::interface1::Batch::parameter
ParameterType parameter
Definition: apriori.h:168
daal::batch
Definition: daal_defines.h:112
daal::algorithms::association_rules::interface1::BatchContainer
Provides methods to run implementations of the association rules algorithm. This class is associated ...
Definition: apriori.h:54
daal::algorithms::association_rules::interface1::Batch::Batch
Batch()
Definition: apriori.h:93
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal_defines.h
daal::algorithms::association_rules::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: apriori.h:128
daal::algorithms::association_rules::interface1::BatchContainer::compute
virtual services::Status compute()
daal::algorithms::association_rules::interface1::BatchContainer::~BatchContainer
~BatchContainer()
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::association_rules::interface1::Batch
Computes the result of the association rules algorithm in the batch processing mode.
Definition: apriori.h:85
daal::algorithms::association_rules::interface1::Batch::input
InputType input
Definition: apriori.h:167
daal::algorithms::association_rules::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: apriori.h:141
daal::algorithms::association_rules::interface1::Batch::getResult
ResultPtr getResult()
Definition: apriori.h:119

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