arm_compute v18.05
[platform/upstream/armcl.git] / arm_compute / runtime / NEON / functions / NEConvertFullyConnectedWeights.h
1 /*
2  * Copyright (c) 2018 ARM Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef __ARM_COMPUTE_NECONVERTFULLYCONNECTEDWEIGHTS_H__
25 #define __ARM_COMPUTE_NECONVERTFULLYCONNECTEDWEIGHTS_H__
26
27 #include "arm_compute/core/NEON/kernels/NEConvertFullyConnectedWeightsKernel.h"
28 #include "arm_compute/runtime/IFunction.h"
29 #include "arm_compute/runtime/NEON/NEScheduler.h"
30
31 namespace arm_compute
32 {
33 class ITensor;
34
35 /** Basic function to run @ref NEConvertFullyConnectedWeightsKernel. */
36 class NEConvertFullyConnectedWeights : public IFunction
37 {
38 public:
39     /** Default constructor */
40     NEConvertFullyConnectedWeights();
41     /** Initialize the function.
42      *
43      * @param[in]  input                Source weights tensor to convert. Must be 2 dimensional. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/U32/S32/QS32/F16/F32.
44      * @param[out] output               The converted weights tensor. Shape and Data Type: Same as @p input.
45      * @param[in]  original_input_shape Shape of the original input tensor (the one entering fully connected layer). Must be in NCHW format.
46      * @param[in]  data_layout          The data layout the weights have been trained in.
47      */
48     void configure(const ITensor *input, ITensor *output, const TensorShape &original_input_shape, DataLayout data_layout);
49     /** Static function to check if given info will lead to a valid configuration of @ref NEConvertFullyConnectedWeights
50      *
51      * @param[in] input                Source weights tensor info to convert. Must be 2 dimensional. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/U32/S32/QS32/F16/F32.
52      * @param[in] output               The converted weights tensor info. Shape and Data Type: Same as @p input.
53      * @param[in] original_input_shape Shape of the original input tensor (the one entering fully connected layer). Must be in NCHW format.
54      * @param[in] data_layout          The data layout the weights have been trained in.
55      */
56     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const TensorShape &original_input_shape, DataLayout data_layout);
57
58     // Inherited methods overriden:
59     void run() override;
60
61 private:
62     NEConvertFullyConnectedWeightsKernel _kernel;
63 };
64 }
65 #endif /* __ARM_COMPUTE_NECONVERTFULLYCONNECTEDWEIGHTS_H__ */