Imported Upstream version 1.7.0
[platform/core/ml/nnfw.git] / compute / ARMComputeEx / arm_compute / runtime / CPP / functions / CPPOneHotEx.h
1 /*
2  * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /*
18  * Copyright (c) 2017-2019 ARM Limited.
19  *
20  * SPDX-License-Identifier: MIT
21  *
22  * Permission is hereby granted, free of charge, to any person obtaining a copy
23  * of this software and associated documentation files (the "Software"), to
24  * deal in the Software without restriction, including without limitation the
25  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
26  * sell copies of the Software, and to permit persons to whom the Software is
27  * furnished to do so, subject to the following conditions:
28  *
29  * The above copyright notice and this permission notice shall be included in all
30  * copies or substantial portions of the Software.
31  *
32  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
33  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
34  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
35  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
36  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
37  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38  * SOFTWARE.
39  */
40
41 #ifndef __ARM_COMPUTE_CPPONEHOT_EX_H__
42 #define __ARM_COMPUTE_CPPONEHOT_EX_H__
43
44 #include "arm_compute/runtime/CPP/ICPPSimpleFunction.h"
45 #include "arm_compute/core/Types.h"
46
47 namespace arm_compute
48 {
49 class ITensor;
50
51 /** Basic function to run @ref CPPOneHot */
52 class CPPOneHotEx : public ICPPSimpleFunction
53 {
54 public:
55   /** Configure the one_hot function
56    *
57    * @param[in]  indices     A tensor for indices. Data types supported: S32
58    * @param[in]  depth       A tensor for depth. Data types supported: S32
59    * @param[in]  on_value    A tensor for on_value. Data types supported: F32
60    * @param[in]  off_value   A tensor for off_value. Data types supported: F32
61    * @param[out] output      A tensor for computed value of one hot operator
62    * @param[in]  axis        An int value for axis
63    */
64   void configure(const ITensor *indices, const ITensor *depth, const ITensor *on_value,
65                  const ITensor *off_value, ITensor *output, const int axis);
66 };
67 }
68 #endif /* __ARM_COMPUTE_CPPONEHOT_EX_H__ */