C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 4

cosine_distance_types.h
1 /* file: cosine_distance_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of cosine distance algorithm interface.
19 //--
20 */
21 
22 #ifndef __COSDISTANCE_TYPES_H__
23 #define __COSDISTANCE_TYPES_H__
24 
25 #include "algorithms/algorithm.h"
26 #include "data_management/data/numeric_table.h"
27 #include "services/daal_defines.h"
28 #include "data_management/data/homogen_numeric_table.h"
29 #include "data_management/data/symmetric_matrix.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
44 namespace cosine_distance
45 {
46 
51 enum Method
52 {
53  defaultDense = 0
54 };
55 
60 enum InputId
61 {
62  data,
63  lastInputId = data
64 };
69 enum ResultId
70 {
71  cosineDistance,
72  lastResultId = cosineDistance
73 };
74 
78 namespace interface1
79 {
84 class DAAL_EXPORT Input : public daal::algorithms::Input
85 {
86 public:
87  Input();
88  Input(const Input& other) : daal::algorithms::Input(other){}
89 
90  virtual ~Input() {}
91 
97  data_management::NumericTablePtr get(InputId id) const;
98 
104  void set(InputId id, const data_management::NumericTablePtr &ptr);
105 
111  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
112 };
113 
118 class DAAL_EXPORT Result : public daal::algorithms::Result
119 {
120 public:
121  DECLARE_SERIALIZABLE_CAST(Result);
122  Result();
123 
124  virtual ~Result() {};
125 
132  template <typename algorithmFPType>
133  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
134 
140  data_management::NumericTablePtr get(ResultId id) const;
141 
147  void set(ResultId id, const data_management::NumericTablePtr &ptr);
148 
155  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
156 
157 protected:
159  template<typename Archive, bool onDeserialize>
160  services::Status serialImpl(Archive *arch)
161  {
162  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
163  }
164 };
165 typedef services::SharedPtr<Result> ResultPtr;
167 } // namespace interface1
168 using interface1::Input;
169 using interface1::Result;
170 using interface1::ResultPtr;
171 
172 } // namespace cosine_distance
173 } // namespace algorithms
174 } // namespace daal
175 #endif
daal::algorithms::cosine_distance::InputId
InputId
Definition: cosine_distance_types.h:60
daal
Definition: algorithm_base_common.h:31
daal::algorithms::cosine_distance::ResultId
ResultId
Definition: cosine_distance_types.h:69
daal_defines.h
daal::algorithms::cosine_distance::interface1::Input
Input objects for the cosine distance algorithm
Definition: cosine_distance_types.h:84
daal::algorithms::cosine_distance::cosineDistance
Definition: cosine_distance_types.h:71
daal::algorithms::cosine_distance::defaultDense
Definition: cosine_distance_types.h:53
daal::algorithms::cosine_distance::Method
Method
Definition: cosine_distance_types.h:51
daal::algorithms::cosine_distance::data
Definition: cosine_distance_types.h:62
daal::algorithms::cosine_distance::interface1::Result
Results obtained with the compute() method of the cosine distance algorithm in the batch processing m...
Definition: cosine_distance_types.h:118

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