blob: 8143d827ae3b1bd61213e6f4ed1e40300e5f2326 [file] [log] [blame]
Anthony Barbierdec3eb42018-11-16 17:12:18 +00001///
Manuel Bottini581c8982019-02-07 10:31:57 +00002/// 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
Michele Di Giorgio7b12bfb2019-10-25 16:34:28 +010032@section S6_1 NEON functions
Anthony Barbierdec3eb42018-11-16 17:12:18 +000033
34- @ref IFunction
35 - @ref INESimpleFunction
36 - @ref NEAbsoluteDifference
Isabella Gottardi62538972019-02-12 19:52:44 +000037 - @ref NEArithmeticAddition
38 - @ref NEArithmeticSubtraction
39 - @ref NEBox3x3
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +010040 - @ref NECast
Isabella Gottardi62538972019-02-12 19:52:44 +000041 - @ref NEConvolution3x3
42 - @ref NEConvolutionRectangle
43 - @ref NEDilate
44 - @ref NEElementwiseComparison
45 - @ref NEElementwiseComparisonStatic
46 - @ref NEElementwiseDivision
47 - @ref NEElementwiseMax
48 - @ref NEElementwiseMin
49 - @ref NEElementwiseSquaredDiff
50 - @ref NEErode
51 - @ref NEExpLayer
52 - @ref NEGaussian3x3
53 - @ref NEIntegralImage
54 - @ref NEMedian3x3
55 - @ref NENonLinearFilter
56 - @ref NENonMaximaSuppression3x3
57 - @ref NEPixelWiseMultiplication
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +010058 - @ref NEPReluLayer
Isabella Gottardi62538972019-02-12 19:52:44 +000059 - @ref NERemap
60 - @ref NERsqrtLayer
61 - @ref NEScharr3x3
62 - @ref NESelect
63 - @ref NESobel3x3
64 - @ref NEStridedSlice
65 - @ref NEWarpAffine
66 - @ref NEWarpPerspective
67 - @ref INESimpleFunctionNoBorder
Anthony Barbierdec3eb42018-11-16 17:12:18 +000068 - @ref NEAccumulate
69 - @ref NEAccumulateSquared
70 - @ref NEAccumulateWeighted
71 - @ref NEActivationLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +010072 - @ref NEBatchToSpaceLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000073 - @ref NEBitwiseAnd
74 - @ref NEBitwiseNot
75 - @ref NEBitwiseOr
76 - @ref NEBitwiseXor
Anthony Barbierdec3eb42018-11-16 17:12:18 +000077 - @ref NEChannelCombine
78 - @ref NEChannelExtract
79 - @ref NEChannelShuffleLayer
80 - @ref NECol2Im
81 - @ref NEColorConvert
Anthony Barbierdec3eb42018-11-16 17:12:18 +000082 - @ref NECopy
83 - @ref NEDepthConvertLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000084 - @ref NEFlattenLayer
85 - @ref NEFloor
86 - @ref NEFullyConnectedLayerReshapeWeights
Isabella Gottardi62538972019-02-12 19:52:44 +000087 - @ref NEGather
Anthony Barbierdec3eb42018-11-16 17:12:18 +000088 - @ref NEGEMMInterleave4x4
89 - @ref NEGEMMLowpQuantizeDownInt32ToUint8Scale
90 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
91 - @ref NEGEMMTranspose1xW
Anthony Barbierdec3eb42018-11-16 17:12:18 +000092 - @ref NEHOGDetector
Anthony Barbierdec3eb42018-11-16 17:12:18 +000093 - @ref NEMagnitude
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +010094 - @ref NEMeanStdDevNormalizationLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000095 - @ref NEPermute
96 - @ref NEPhase
Isabella Gottardi8773d7c2018-11-20 09:56:46 +000097 - @ref NEPriorBoxLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +000098 - @ref NEReorgLayer
99 - @ref NEReshapeLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000100 - @ref NEReverse
101 - @ref NESlice
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000102 - @ref NETableLookup
103 - @ref NEThreshold
Isabella Gottardi62538972019-02-12 19:52:44 +0000104 - @ref NETile
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000105 - @ref NETranspose
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000106 - @ref NEYOLOLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000107 - @ref NEArgMinMaxLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000108 - @ref NEBatchNormalizationLayer
109 - @ref NECannyEdge
Michalis Spyrouca82e622019-05-10 16:43:20 +0100110 - @ref NEComplexPixelWiseMultiplication
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000111 - @ref NEConcatenateLayer
112 - @ref NEConvertFullyConnectedWeights
113 - @ref NEConvolutionLayer
114 - @ref NEConvolutionLayerReshapeWeights
Manuel Bottini581c8982019-02-07 10:31:57 +0000115 - @ref NEConvolutionSquare <matrix_size>
Michalis Spyrouca82e622019-05-10 16:43:20 +0100116 - @ref NECropResize
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000117 - @ref NEDeconvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100118 - @ref NEDepthwiseConvolutionAssemblyDispatch
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000119 - @ref NEDepthwiseConvolutionLayer
Manuel Bottini05069f02019-09-26 17:18:26 +0100120 - @ref NEDepthwiseConvolutionLayerOptimized
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000121 - @ref NEDequantizationLayer
122 - @ref NEDerivative
123 - @ref NEDirectConvolutionLayer
124 - @ref NEEqualizeHistogram
125 - @ref NEFastCorners
Michalis Spyrouca82e622019-05-10 16:43:20 +0100126 - @ref NEFFT1D
127 - @ref NEFFT2D
128 - @ref NEFFTConvolutionLayer
Kurtis Charnock2963a6f2019-11-15 11:53:32 +0000129 - @ref NEFill
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000130 - @ref NEFillBorder
131 - @ref NEFullyConnectedLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000132 - @ref NEFuseBatchNormalization
133 - @ref NEGaussian5x5
134 - @ref NEGaussianPyramid
135 - @ref NEGaussianPyramidHalf
136 - @ref NEGaussianPyramidOrb
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000137 - @ref NEGEMM
138 - @ref NEGEMMAssemblyDispatch
139 - @ref NEGEMMConvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000140 - @ref NEGEMMLowpAssemblyMatrixMultiplyCore
141 - @ref NEGEMMLowpMatrixMultiplyCore
Isabella Gottardi62538972019-02-12 19:52:44 +0000142 - @ref NEHarrisCorners
143 - @ref NEHistogram
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000144 - @ref NEHOGDescriptor
145 - @ref NEHOGGradient
146 - @ref NEHOGMultiDetection
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000147 - @ref NEIm2Col
148 - @ref NEL2NormalizeLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000149 - @ref NELaplacianPyramid
150 - @ref NELaplacianReconstruct
151 - @ref NELocallyConnectedLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000152 - @ref NELSTMLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100153 - @ref NELSTMLayerQuantized
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000154 - @ref NEMeanStdDev
155 - @ref NEMinMaxLocation
156 - @ref NENormalizationLayer
157 - @ref NEOpticalFlow
Isabella Gottardi62538972019-02-12 19:52:44 +0000158 - @ref NEPadLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000159 - @ref NEPoolingLayer
160 - @ref NEQuantizationLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000161 - @ref NERange
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000162 - @ref NEReduceMean
163 - @ref NEReductionOperation
Isabella Gottardi62538972019-02-12 19:52:44 +0000164 - @ref NERNNLayer
165 - @ref NEROIPoolingLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000166 - @ref NEScale
167 - @ref NESimpleAssemblyFunction
168 - @ref NESobel5x5
169 - @ref NESobel7x7
170 - @ref NESoftmaxLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100171 - @ref NESpaceToBatchLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100172 - @ref NESpaceToDepthLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000173 - @ref NESplit
174 - @ref NEStackLayer
175 - @ref NEUnstack
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000176 - @ref NEUpsampleLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000177 - @ref NEWinogradConvolutionLayer
178
Michele Di Giorgio7b12bfb2019-10-25 16:34:28 +0100179@section S6_2 OpenCL functions
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000180
181- @ref IFunction
182 - @ref CLBatchNormalizationLayer
183 - @ref CLBatchToSpaceLayer
184 - @ref CLCannyEdge
Michalis Spyrouca82e622019-05-10 16:43:20 +0100185 - @ref CLComplexPixelWiseMultiplication
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000186 - @ref CLConcatenateLayer
187 - @ref CLConvolutionLayer
188 - @ref CLConvolutionLayerReshapeWeights
Manuel Bottini581c8982019-02-07 10:31:57 +0000189 - @ref CLConvolutionSquare <matrix_size>
Michalis Spyrouca82e622019-05-10 16:43:20 +0100190 - @ref CLCropResize
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000191 - @ref CLDeconvolutionLayer
192 - @ref CLDeconvolutionLayerUpsample
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100193 - @ref CLDepthToSpaceLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000194 - @ref CLDepthwiseConvolutionLayer
195 - @ref CLDepthwiseConvolutionLayer3x3
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000196 - @ref CLDequantizationLayer
197 - @ref CLDirectConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100198 - @ref CLDirectDeconvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000199 - @ref CLEqualizeHistogram
200 - @ref CLFastCorners
Michalis Spyrouca82e622019-05-10 16:43:20 +0100201 - @ref CLFFT1D
202 - @ref CLFFT2D
203 - @ref CLFFTConvolutionLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000204 - @ref CLFullyConnectedLayer
205 - @ref CLFuseBatchNormalization
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000206 - @ref CLGaussian5x5
207 - @ref CLGaussianPyramid
208 - @ref CLGaussianPyramidHalf
209 - @ref CLGaussianPyramidOrb
Isabella Gottardi62538972019-02-12 19:52:44 +0000210 - @ref CLGEMM
211 - @ref CLGEMMConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100212 - @ref CLGEMMDeconvolutionLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000213 - @ref CLGEMMLowpMatrixMultiplyCore
Manuel Bottini5209be52019-02-13 16:34:56 +0000214 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000215 - @ref CLHarrisCorners
216 - @ref CLHistogram
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000217 - @ref CLHOGDescriptor
218 - @ref CLHOGDetector
219 - @ref CLHOGGradient
220 - @ref CLHOGMultiDetection
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000221 - @ref CLIntegralImage
222 - @ref CLL2NormalizeLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000223 - @ref CLLaplacianPyramid
224 - @ref CLLaplacianReconstruct
225 - @ref CLLocallyConnectedLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000226 - @ref CLLSTMLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100227 - @ref CLLSTMLayerQuantized
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000228 - @ref CLMeanStdDev
229 - @ref CLMinMaxLocation
230 - @ref CLNormalizationLayer
231 - @ref CLNormalizePlanarYUVLayer
232 - @ref CLOpticalFlow
233 - @ref CLPadLayer
234 - @ref CLQuantizationLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000235 - @ref CLReduceMean
236 - @ref CLReductionOperation
Isabella Gottardi62538972019-02-12 19:52:44 +0000237 - @ref CLRNNLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000238 - @ref CLSobel5x5
239 - @ref CLSobel7x7
240 - @ref CLSoftmaxLayer
241 - @ref CLSpaceToBatchLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100242 - @ref CLSpaceToDepthLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000243 - @ref CLSplit
Isabella Gottardi62538972019-02-12 19:52:44 +0000244 - @ref CLStackLayer
245 - @ref CLUnstack
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000246 - @ref CLUpsampleLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000247 - @ref CLWinogradConvolutionLayer
248 - @ref ICLSimpleFunction
249 - @ref CLAbsoluteDifference
250 - @ref CLAccumulate
251 - @ref CLAccumulateSquared
252 - @ref CLAccumulateWeighted
253 - @ref CLActivationLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000254 - @ref CLArgMinMaxLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000255 - @ref CLArithmeticAddition
256 - @ref CLArithmeticDivision
257 - @ref CLArithmeticSubtraction
258 - @ref CLBitwiseAnd
259 - @ref CLBitwiseNot
260 - @ref CLBitwiseOr
261 - @ref CLBitwiseXor
262 - @ref CLBoundingBoxTransform
263 - @ref CLBox3x3
Isabella Gottardi62538972019-02-12 19:52:44 +0000264 - @ref CLCast
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000265 - @ref CLChannelCombine
266 - @ref CLChannelExtract
267 - @ref CLChannelShuffleLayer
268 - @ref CLColorConvert
Isabella Gottardi62538972019-02-12 19:52:44 +0000269 - @ref CLComparison
270 - @ref CLComparisonStatic
Manuel Bottini5209be52019-02-13 16:34:56 +0000271 - @ref CLComputeAllAnchors
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000272 - @ref CLConvertFullyConnectedWeights
273 - @ref CLConvolution3x3
274 - @ref CLConvolutionRectangle
275 - @ref CLCopy
276 - @ref CLDepthConvertLayer
277 - @ref CLDerivative
278 - @ref CLDilate
Isabella Gottardi62538972019-02-12 19:52:44 +0000279 - @ref CLElementwiseMax
280 - @ref CLElementwiseMin
281 - @ref CLElementwiseSquaredDiff
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000282 - @ref CLErode
Isabella Gottardi62538972019-02-12 19:52:44 +0000283 - @ref CLExpLayer
Kurtis Charnock9afc41a2019-11-11 17:24:37 +0000284 - @ref CLFill
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000285 - @ref CLFillBorder
286 - @ref CLFlattenLayer
287 - @ref CLFloor
288 - @ref CLFullyConnectedLayerReshapeWeights
Isabella Gottardi62538972019-02-12 19:52:44 +0000289 - @ref CLGather
290 - @ref CLGaussian3x3
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000291 - @ref CLGEMMLowpQuantizeDownInt32ToUint8Scale
292 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
293 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000294 - @ref CLMagnitude
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100295 - @ref CLMeanStdDevNormalizationLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000296 - @ref CLMedian3x3
297 - @ref CLNonLinearFilter
298 - @ref CLNonMaximaSuppression3x3
299 - @ref CLPermute
300 - @ref CLPhase
301 - @ref CLPixelWiseMultiplication
302 - @ref CLPoolingLayer
Gian Marco Iodicec7ec1942019-08-28 11:40:30 +0100303 - @ref CLPReluLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000304 - @ref CLPriorBoxLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000305 - @ref CLRange
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000306 - @ref CLRemap
307 - @ref CLReorgLayer
308 - @ref CLReshapeLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000309 - @ref CLReverse
310 - @ref CLROIAlignLayer
311 - @ref CLROIPoolingLayer
312 - @ref CLRsqrtLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000313 - @ref CLScale
314 - @ref CLScharr3x3
Isabella Gottardi62538972019-02-12 19:52:44 +0000315 - @ref CLSelect
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000316 - @ref CLSlice
317 - @ref CLSobel3x3
318 - @ref CLStridedSlice
319 - @ref CLTableLookup
320 - @ref CLThreshold
Isabella Gottardi62538972019-02-12 19:52:44 +0000321 - @ref CLTile
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000322 - @ref CLTranspose
323 - @ref CLWarpAffine
324 - @ref CLWarpPerspective
325 - @ref CLWinogradInputTransform
326 - @ref CLYOLOLayer
327
Michele Di Giorgio7b12bfb2019-10-25 16:34:28 +0100328@section S6_3 GLES Compute functions
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000329
330- @ref IFunction
331 - @ref GCBatchNormalizationLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100332 - @ref GCConcatenateLayer
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000333 - @ref GCConvolutionLayer
334 - @ref GCConvolutionLayerReshapeWeights
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000335 - @ref GCDepthwiseConvolutionLayer3x3
336 - @ref GCDirectConvolutionLayer
337 - @ref GCDropoutLayer
338 - @ref GCFullyConnectedLayer
339 - @ref GCGEMM
340 - @ref GCNormalizationLayer
341 - @ref GCNormalizePlanarYUVLayer
342 - @ref GCPoolingLayer
343 - @ref GCSoftmaxLayer
344 - @ref IGCSimpleFunction
345 - @ref GCAbsoluteDifference
346 - @ref GCActivationLayer
347 - @ref GCArithmeticAddition
348 - @ref GCFillBorder
349 - @ref GCFullyConnectedLayerReshapeWeights
350 - @ref GCGEMMInterleave4x4
351 - @ref GCGEMMTranspose1xW
352 - @ref GCPixelWiseMultiplication
353 - @ref GCScale
354 - @ref GCTensorShift
355 - @ref GCTranspose
Isabella Gottardi62538972019-02-12 19:52:44 +0000356
Michele Di Giorgio7b12bfb2019-10-25 16:34:28 +0100357@section S6_4 CPP functions
Isabella Gottardi62538972019-02-12 19:52:44 +0000358
359 - @ref IFunction
Isabella Gottardi62538972019-02-12 19:52:44 +0000360 - @ref CPPDetectionOutputLayer
361 - @ref ICPPSimpleFunction
362 - @ref CPPBoxWithNonMaximaSuppressionLimit
363 - @ref CPPPermute
364 - @ref CPPTopKV
365 - @ref CPPUpsample
366
Anthony Barbierdec3eb42018-11-16 17:12:18 +0000367*/
368} // namespace