1 /* 2 * Copyright (c) 2021 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_NECONV3D_H 25 #define ARM_COMPUTE_NECONV3D_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/core/ITensorInfo.h" 30 #include "arm_compute/core/Types.h" 31 #include "arm_compute/runtime/FunctionDescriptors.h" 32 33 #include <memory> 34 35 namespace arm_compute 36 { 37 // Forward declarations 38 class ITensor; 39 40 /** Basic function to simulate a 3d convolution. This function calls one of the following functions: 41 * -# @ref cpu::CpuDirectConv3d 42 * 43 */ 44 class NEConv3D : public IFunction 45 { 46 public: 47 /** Constructor */ 48 NEConv3D(); 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NEConv3D(const NEConv3D &) = delete; 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 NEConv3D &operator=(const NEConv3D &) = delete; 53 /** Default move constructor */ 54 NEConv3D(NEConv3D &&) = default; 55 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 56 NEConv3D &operator=(NEConv3D &&) = default; 57 /** Default destructor */ 58 ~NEConv3D(); 59 /** Set the input and output tensors. 60 * 61 * Valid data layouts: 62 * - NDHWC 63 * 64 * Valid data type configurations: 65 * |src0 |src1 |src2 |dst | 66 * |:--------------|:------------------|:------|:--------------| 67 * |F16 |F16 |F16 |F16 | 68 * |F32 |F32 |F32 |F32 | 69 * |QASYMM8 |QASYMM8 |S32 |QASYMM8 | 70 * |QASYMM8_SIGNED |QASYMM8_SIGNED |S32 |QASYMM8_SIGNED | 71 * 72 * @param[in] input Source tensor. 4 lower dimensions represent a single input [IFM, width, height, depth], 73 * while every optional dimension from 5 and above represent a batch of inputs. 74 * @param[in] weights Weights tensor. Weights are 5D tensor with dimensions [OFM, IFM, kernel_x, kernel_y, kernel_z]. 75 * @param[in] biases Biases tensor. Shared biases supported. Biases are 1D tensor with dimensions [OFM]. 76 * @param[out] output Destination tensor. 4 lower dimensions represent a single output [OFM, width, height, depth], while the rest represent batch of outputs. 77 * @param[in] conv_info Contains padding, stride, acitvation information described in @ref Conv3dInfo. 78 */ 79 void configure(ITensor *input, const ITensor *weights, const ITensor *biases, ITensor *output, const Conv3dInfo &conv_info); 80 /** Static function to check if given info will lead to a valid configuration 81 * 82 * Similar to NEConv3D::configure() 83 * 84 * @return a status 85 */ 86 static Status validate(const ITensorInfo *input, const ITensorInfo *weights, const ITensorInfo *biases, const ITensorInfo *output, const Conv3dInfo &conv_info); 87 88 // Inherited methods overridden: 89 void run() override; 90 91 private: 92 struct Impl; 93 std::unique_ptr<Impl> _impl; 94 }; 95 } // namespace arm_compute 96 #endif /* ARM_COMPUTE_NECONV3D_H */ 97