blob: 1f4794f131b7ba75a986ef02b3182ea7a5021028 [file] [log] [blame]
Anthony Barbierdec3eb42018-11-16 17:12:18 +00001///
Michele Di Giorgiod9eaf612020-07-08 11:12:57 +01002/// Copyright (c) 2018-2019 Arm Limited.
Anthony Barbierdec3eb42018-11-16 17:12:18 +00003///
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///
24namespace arm_compute
25{
26/**
27
28@page functions_list List of functions
29
30@tableofcontents
31
Sheri Zhangac6499a2021-02-10 15:32:38 +000032@section S6_1 Neon functions
Anthony Barbierdec3eb42018-11-16 17:12:18 +000033
34- @ref IFunction
35 - @ref INESimpleFunction
Isabella Gottardi62538972019-02-12 19:52:44 +000036 - @ref NEArithmeticAddition
37 - @ref NEArithmeticSubtraction
SiCong Lica1f98c2019-11-28 11:06:11 +000038 - @ref NEBoundingBoxTransform
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +010039 - @ref NECast
SiCong Lica1f98c2019-11-28 11:06:11 +000040 - @ref NEComplexPixelWiseMultiplication
Isabella Gottardi62538972019-02-12 19:52:44 +000041 - @ref NEConvolution3x3
42 - @ref NEConvolutionRectangle
Isabella Gottardi62538972019-02-12 19:52:44 +000043 - @ref NEElementwiseComparison
44 - @ref NEElementwiseComparisonStatic
45 - @ref NEElementwiseDivision
46 - @ref NEElementwiseMax
47 - @ref NEElementwiseMin
48 - @ref NEElementwiseSquaredDiff
Isabella Gottardi62538972019-02-12 19:52:44 +000049 - @ref NEExpLayer
morgolockfbcf65c2020-11-20 14:44:22 +000050 - @ref NELogicalAnd
51 - @ref NELogicalNot
52 - @ref NELogicalOr
Isabella Gottardi62538972019-02-12 19:52:44 +000053 - @ref NENonMaximaSuppression3x3
54 - @ref NEPixelWiseMultiplication
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +010055 - @ref NEPReluLayer
SiCong Lica1f98c2019-11-28 11:06:11 +000056 - @ref NEROIAlignLayer
57 - @ref NERoundLayer
Isabella Gottardi62538972019-02-12 19:52:44 +000058 - @ref NERsqrtLayer
Isabella Gottardi62538972019-02-12 19:52:44 +000059 - @ref NESelect
Isabella Gottardi62538972019-02-12 19:52:44 +000060 - @ref NEStridedSlice
Isabella Gottardi62538972019-02-12 19:52:44 +000061 - @ref INESimpleFunctionNoBorder
Anthony Barbierdec3eb42018-11-16 17:12:18 +000062 - @ref NEActivationLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +010063 - @ref NEBatchToSpaceLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000064 - @ref NEBitwiseAnd
65 - @ref NEBitwiseNot
66 - @ref NEBitwiseOr
67 - @ref NEBitwiseXor
Anthony Barbierdec3eb42018-11-16 17:12:18 +000068 - @ref NEChannelShuffleLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000069 - @ref NECopy
70 - @ref NEDepthConvertLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000071 - @ref NEFlattenLayer
72 - @ref NEFloor
73 - @ref NEFullyConnectedLayerReshapeWeights
Isabella Gottardi62538972019-02-12 19:52:44 +000074 - @ref NEGather
Anthony Barbierdec3eb42018-11-16 17:12:18 +000075 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Manuel Bottini1f332d42019-11-29 17:25:25 +000076 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +010077 - @ref NEMeanStdDevNormalizationLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000078 - @ref NEPermute
Isabella Gottardi8773d7c2018-11-20 09:56:46 +000079 - @ref NEPriorBoxLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000080 - @ref NEReorgLayer
81 - @ref NEReshapeLayer
Isabella Gottardi62538972019-02-12 19:52:44 +000082 - @ref NEReverse
83 - @ref NESlice
Isabella Gottardi62538972019-02-12 19:52:44 +000084 - @ref NETile
Anthony Barbierdec3eb42018-11-16 17:12:18 +000085 - @ref NETranspose
Isabella Gottardi62538972019-02-12 19:52:44 +000086 - @ref NEArgMinMaxLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000087 - @ref NEBatchNormalizationLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +010088 - @ref NEComplexPixelWiseMultiplication
Anthony Barbierdec3eb42018-11-16 17:12:18 +000089 - @ref NEConcatenateLayer
90 - @ref NEConvertFullyConnectedWeights
91 - @ref NEConvolutionLayer
92 - @ref NEConvolutionLayerReshapeWeights
Manuel Bottini581c8982019-02-07 10:31:57 +000093 - @ref NEConvolutionSquare <matrix_size>
Michalis Spyrouca82e622019-05-10 16:43:20 +010094 - @ref NECropResize
Anthony Barbierdec3eb42018-11-16 17:12:18 +000095 - @ref NEDeconvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +010096 - @ref NEDepthwiseConvolutionAssemblyDispatch
Anthony Barbierdec3eb42018-11-16 17:12:18 +000097 - @ref NEDepthwiseConvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000098 - @ref NEDequantizationLayer
SiCong Lica1f98c2019-11-28 11:06:11 +000099 - @ref NEDetectionPostProcessLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000100 - @ref NEDirectConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100101 - @ref NEFFT1D
102 - @ref NEFFT2D
103 - @ref NEFFTConvolutionLayer
Kurtis Charnock2963a6f2019-11-15 11:53:32 +0000104 - @ref NEFill
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000105 - @ref NEFillBorder
106 - @ref NEFullyConnectedLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000107 - @ref NEFuseBatchNormalization
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000108 - @ref NEGEMM
109 - @ref NEGEMMAssemblyDispatch
Georgios Pinitasc0b6f762020-11-02 01:37:17 +0000110 - @ref NEGEMMConv2d
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000111 - @ref NEGEMMConvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000112 - @ref NEGEMMLowpMatrixMultiplyCore
SiCong Lica1f98c2019-11-28 11:06:11 +0000113 - @ref NEGenerateProposalsLayer
SiCong Lica1f98c2019-11-28 11:06:11 +0000114 - @ref NEInstanceNormalizationLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000115 - @ref NEL2NormalizeLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000116 - @ref NELSTMLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100117 - @ref NELSTMLayerQuantized
Manuel Bottini79c88862020-05-22 14:04:30 +0100118 - @ref NEQLSTMLayer
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100119 - @ref NEMaxUnpoolingLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000120 - @ref NENormalizationLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000121 - @ref NEPadLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000122 - @ref NEPoolingLayer
123 - @ref NEQuantizationLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000124 - @ref NERange
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000125 - @ref NEReduceMean
126 - @ref NEReductionOperation
Isabella Gottardi62538972019-02-12 19:52:44 +0000127 - @ref NERNNLayer
128 - @ref NEROIPoolingLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000129 - @ref NEScale
SiCong Lica1f98c2019-11-28 11:06:11 +0000130 - @ref NESoftmaxLayerGeneric <IS_LOG>
Michalis Spyrouca82e622019-05-10 16:43:20 +0100131 - @ref NESpaceToBatchLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100132 - @ref NESpaceToDepthLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000133 - @ref NESplit
134 - @ref NEStackLayer
135 - @ref NEUnstack
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000136 - @ref NEWinogradConvolutionLayer
137
Michele Di Giorgio7b12bfb2019-10-25 16:34:28 +0100138@section S6_2 OpenCL functions
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000139
140- @ref IFunction
141 - @ref CLBatchNormalizationLayer
142 - @ref CLBatchToSpaceLayer
143 - @ref CLCannyEdge
Michalis Spyrouca82e622019-05-10 16:43:20 +0100144 - @ref CLComplexPixelWiseMultiplication
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000145 - @ref CLConcatenateLayer
146 - @ref CLConvolutionLayer
147 - @ref CLConvolutionLayerReshapeWeights
Manuel Bottini581c8982019-02-07 10:31:57 +0000148 - @ref CLConvolutionSquare <matrix_size>
Michalis Spyrouca82e622019-05-10 16:43:20 +0100149 - @ref CLCropResize
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000150 - @ref CLDeconvolutionLayer
151 - @ref CLDeconvolutionLayerUpsample
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100152 - @ref CLDepthToSpaceLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000153 - @ref CLDepthwiseConvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000154 - @ref CLDequantizationLayer
155 - @ref CLDirectConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100156 - @ref CLDirectDeconvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000157 - @ref CLEqualizeHistogram
158 - @ref CLFastCorners
Michalis Spyrouca82e622019-05-10 16:43:20 +0100159 - @ref CLFFT1D
160 - @ref CLFFT2D
161 - @ref CLFFTConvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000162 - @ref CLFullyConnectedLayer
163 - @ref CLFuseBatchNormalization
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000164 - @ref CLGaussian5x5
165 - @ref CLGaussianPyramid
166 - @ref CLGaussianPyramidHalf
167 - @ref CLGaussianPyramidOrb
Isabella Gottardi62538972019-02-12 19:52:44 +0000168 - @ref CLGEMM
169 - @ref CLGEMMConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100170 - @ref CLGEMMDeconvolutionLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000171 - @ref CLGEMMLowpMatrixMultiplyCore
Manuel Bottini5209be52019-02-13 16:34:56 +0000172 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000173 - @ref CLHarrisCorners
174 - @ref CLHistogram
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000175 - @ref CLHOGDescriptor
176 - @ref CLHOGDetector
177 - @ref CLHOGGradient
178 - @ref CLHOGMultiDetection
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000179 - @ref CLIntegralImage
180 - @ref CLL2NormalizeLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000181 - @ref CLLaplacianPyramid
182 - @ref CLLaplacianReconstruct
morgolockfbcf65c2020-11-20 14:44:22 +0000183 - @ref CLLogicalAnd
184 - @ref CLLogicalNot
185 - @ref CLLogicalOr
Isabella Gottardi62538972019-02-12 19:52:44 +0000186 - @ref CLLSTMLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100187 - @ref CLLSTMLayerQuantized
Manuel Bottini79c88862020-05-22 14:04:30 +0100188 - @ref CLQLSTMLayer
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100189 - @ref CLMaxUnpoolingLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000190 - @ref CLMeanStdDev
191 - @ref CLMinMaxLocation
192 - @ref CLNormalizationLayer
193 - @ref CLNormalizePlanarYUVLayer
194 - @ref CLOpticalFlow
195 - @ref CLPadLayer
196 - @ref CLQuantizationLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000197 - @ref CLReduceMean
198 - @ref CLReductionOperation
Isabella Gottardi62538972019-02-12 19:52:44 +0000199 - @ref CLRNNLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000200 - @ref CLSobel5x5
201 - @ref CLSobel7x7
SiCong Lica1f98c2019-11-28 11:06:11 +0000202 - @ref CLSoftmaxLayerGeneric <IS_LOG>
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000203 - @ref CLSpaceToBatchLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100204 - @ref CLSpaceToDepthLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000205 - @ref CLSplit
Isabella Gottardi62538972019-02-12 19:52:44 +0000206 - @ref CLStackLayer
207 - @ref CLUnstack
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000208 - @ref CLWinogradConvolutionLayer
209 - @ref ICLSimpleFunction
210 - @ref CLAbsoluteDifference
211 - @ref CLAccumulate
212 - @ref CLAccumulateSquared
213 - @ref CLAccumulateWeighted
214 - @ref CLActivationLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000215 - @ref CLArgMinMaxLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000216 - @ref CLArithmeticAddition
217 - @ref CLArithmeticDivision
218 - @ref CLArithmeticSubtraction
219 - @ref CLBitwiseAnd
220 - @ref CLBitwiseNot
221 - @ref CLBitwiseOr
222 - @ref CLBitwiseXor
223 - @ref CLBoundingBoxTransform
224 - @ref CLBox3x3
Isabella Gottardi62538972019-02-12 19:52:44 +0000225 - @ref CLCast
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000226 - @ref CLChannelCombine
227 - @ref CLChannelExtract
228 - @ref CLChannelShuffleLayer
229 - @ref CLColorConvert
Isabella Gottardi62538972019-02-12 19:52:44 +0000230 - @ref CLComparison
231 - @ref CLComparisonStatic
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000232 - @ref CLConvertFullyConnectedWeights
233 - @ref CLConvolution3x3
234 - @ref CLConvolutionRectangle
235 - @ref CLCopy
236 - @ref CLDepthConvertLayer
237 - @ref CLDerivative
238 - @ref CLDilate
Isabella Gottardi62538972019-02-12 19:52:44 +0000239 - @ref CLElementwiseMax
240 - @ref CLElementwiseMin
241 - @ref CLElementwiseSquaredDiff
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000242 - @ref CLErode
Isabella Gottardi62538972019-02-12 19:52:44 +0000243 - @ref CLExpLayer
Kurtis Charnock9afc41a2019-11-11 17:24:37 +0000244 - @ref CLFill
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000245 - @ref CLFillBorder
246 - @ref CLFlattenLayer
247 - @ref CLFloor
248 - @ref CLFullyConnectedLayerReshapeWeights
Isabella Gottardi62538972019-02-12 19:52:44 +0000249 - @ref CLGather
250 - @ref CLGaussian3x3
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000251 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Manuel Bottini1f332d42019-11-29 17:25:25 +0000252 - @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
morgolockfbcf65c2020-11-20 14:44:22 +0000253 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000254 - @ref CLMagnitude
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100255 - @ref CLMeanStdDevNormalizationLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000256 - @ref CLMedian3x3
257 - @ref CLNonLinearFilter
258 - @ref CLNonMaximaSuppression3x3
259 - @ref CLPermute
260 - @ref CLPhase
261 - @ref CLPixelWiseMultiplication
262 - @ref CLPoolingLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100263 - @ref CLPReluLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000264 - @ref CLPriorBoxLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000265 - @ref CLRange
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000266 - @ref CLRemap
267 - @ref CLReorgLayer
268 - @ref CLReshapeLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000269 - @ref CLReverse
270 - @ref CLROIAlignLayer
271 - @ref CLROIPoolingLayer
272 - @ref CLRsqrtLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000273 - @ref CLScale
274 - @ref CLScharr3x3
Isabella Gottardi62538972019-02-12 19:52:44 +0000275 - @ref CLSelect
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000276 - @ref CLSlice
277 - @ref CLSobel3x3
278 - @ref CLStridedSlice
279 - @ref CLTableLookup
280 - @ref CLThreshold
Isabella Gottardi62538972019-02-12 19:52:44 +0000281 - @ref CLTile
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000282 - @ref CLTranspose
283 - @ref CLWarpAffine
284 - @ref CLWarpPerspective
285 - @ref CLWinogradInputTransform
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000286
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000287@section S6_3 CPP functions
Isabella Gottardi62538972019-02-12 19:52:44 +0000288
289 - @ref IFunction
Isabella Gottardi62538972019-02-12 19:52:44 +0000290 - @ref CPPDetectionOutputLayer
SiCong Lica1f98c2019-11-28 11:06:11 +0000291 - @ref CPPDetectionPostProcessLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000292 - @ref ICPPSimpleFunction
293 - @ref CPPBoxWithNonMaximaSuppressionLimit
294 - @ref CPPPermute
295 - @ref CPPTopKV
296 - @ref CPPUpsample
297
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000298*/
299} // namespace