Compute Library
 21.11
FunctionDescriptors.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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_RUNTIME_FUNCTION_DESCRIPTORS_H
25 #define ARM_COMPUTE_RUNTIME_FUNCTION_DESCRIPTORS_H
26 
27 #include "arm_compute/core/Types.h"
28 
29 #include <utility>
30 
31 namespace arm_compute
32 {
33 /** FFT direction to use */
34 enum class FFTDirection
35 {
36  Forward,
37  Inverse
38 };
39 
40 /** Descriptor used by the FFT1D function */
41 struct FFT1DInfo
42 {
43  unsigned int axis{ 0 }; /**< Axis to run the FFT on. */
44  FFTDirection direction{ FFTDirection::Forward }; /**< Direction of the FFT. */
45 };
46 
47 /** Descriptor used by the FFT2D function */
48 struct FFT2DInfo
49 {
50  unsigned int axis0{ 0 }; /**< Axis to run first pass on. If same, multiple transforms are performed on single axis*/
51  unsigned int axis1{ 1 }; /**< Axis to run second pass on. If same, multiple transforms are performed on single axis*/
52  FFTDirection direction{ FFTDirection::Forward }; /**< Direction of the FFT. */
53 };
54 
55 /** Descriptor used by the 2d Convolution function */
56 struct Conv2dInfo
57 {
58  Conv2dInfo() = default;
59 
61  const Size2D &dilation,
62  const ActivationLayerInfo &act_info,
63  bool enable_fast_math,
64  unsigned int num_groups,
66  : conv_info(conv_info), dilation(dilation), act_info(act_info), enable_fast_math(enable_fast_math), num_groups(num_groups), post_ops(post_ops)
67  {
68  }
69 
70  PadStrideInfo conv_info{};
71  Size2D dilation{ 1U, 1U };
72  ActivationLayerInfo act_info{};
73  bool enable_fast_math{ false };
74  unsigned int num_groups{ 1 };
76 };
77 
78 /** Descriptor used by the 3d Convolution function */
79 struct Conv3dInfo
80 {
81  Conv3dInfo() = default;
82 
83  Conv3dInfo(const Size3D &stride,
84  const Padding3D &padding,
85  const ActivationLayerInfo &act_info,
86  const Size3D &dilation,
87  const DimensionRoundingType &round_type,
88  bool enable_fast_math)
89  : stride(stride), padding(padding), act_info(act_info), dilation(dilation), round_type(round_type), enable_fast_math(enable_fast_math)
90  {
91  }
92 
93  Size3D stride{ 1U, 1U, 1U };
94  Padding3D padding{};
95  ActivationLayerInfo act_info{};
96  Size3D dilation{ 1U, 1U, 1U };
97  DimensionRoundingType round_type{};
98  bool enable_fast_math{ false };
99 };
100 
101 } // namespace arm_compute
102 #endif /* ARM_COMPUTE_RUNTIME_FUNCTION_DESCRIPTORS_H */
experimental::PostOpList< ITensorInfo * > post_ops
Descriptor used by the 3d Convolution function.
Descriptor used by the FFT1D function.
Descriptor used by the FFT2D function.
Class for specifying the size of a 3D shape or object.
Definition: Size3D.h:32
DimensionRoundingType
Dimension rounding type when down-scaling on CNNs.
Definition: Types.h:537
Conv2dInfo(const PadStrideInfo &conv_info, const Size2D &dilation, const ActivationLayerInfo &act_info, bool enable_fast_math, unsigned int num_groups, const experimental::PostOpList< ITensorInfo *> &post_ops=experimental::PostOpList< ITensorInfo *> {})
Activation Layer Information class.
Definition: Types.h:1509
Copyright (c) 2017-2021 Arm Limited.
const unsigned int num_groups
Definition: Im2Col.cpp:153
FFTDirection
FFT direction to use.
Padding and stride information class.
Definition: Types.h:656
Descriptor used by the 2d Convolution function.
Class for specifying the size of an image or rectangle.
Definition: Size2D.h:34
Conv3dInfo(const Size3D &stride, const Padding3D &padding, const ActivationLayerInfo &act_info, const Size3D &dilation, const DimensionRoundingType &round_type, bool enable_fast_math)
A sequence of PostOps that can be appended to the end of other operators.
Definition: IPostOp.h:119
Padding information for 3D operations like Conv3d.
Definition: Types.h:773