Michele Di Giorgio | 9175392 | 2019-06-13 10:56:59 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2019 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_NEMEANSTDDEVNORMALIZATIONLAYER_H__ |
| 25 | #define __ARM_COMPUTE_NEMEANSTDDEVNORMALIZATIONLAYER_H__ |
| 26 | |
| 27 | #include "arm_compute/core/Types.h" |
| 28 | #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h" |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | class ITensor; |
| 33 | |
| 34 | /** Basic function to execute mean and standard deviation normalization by calling @ref NEMeanStdDevNormalizationKernel */ |
| 35 | class NEMeanStdDevNormalizationLayer : public INESimpleFunctionNoBorder |
| 36 | { |
| 37 | public: |
| 38 | /** Initialise the function's input and outputs. |
| 39 | * |
| 40 | * @note If the output tensor is a nullptr, the normalization will be performed in-place. |
| 41 | * |
| 42 | * @param[in, out] input Input tensor with 2 dimensions. Data types supported: F16/F32. |
| 43 | * @param[out] output (Optional) Destination tensor. It can be nullptr in case of in-place computation. Data type supported: same as @p input |
| 44 | * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8. |
| 45 | */ |
| 46 | void configure(ITensor *input, ITensor *output = nullptr, float epsilon = 1e-8f); |
| 47 | /** Static function to check if given info will lead to a valid configuration of @ref NEMeanStdDevNormalizationKernel |
| 48 | * |
| 49 | * @param[in] input Source tensor info with 2 dimensions. In case of @p output tensor info = nullptr, |
| 50 | * this tensor will store the result of the normalization. Data types supported: F16/F32. |
| 51 | * @param[in] output (Optional) Destination tensor info. It can be nullptr in case of in-place computation. Data type supported: same as @p input |
| 52 | * @param[in] epsilon (Optional) Small float to avoid division by zero in case of zero standard deviation. Defaults to 1e-8. |
| 53 | * |
| 54 | * @return a status |
| 55 | */ |
| 56 | static Status validate(const ITensorInfo *input, const ITensorInfo *output = nullptr, float epsilon = 1e-8f); |
| 57 | }; |
| 58 | } // namespace arm_compute |
| 59 | #endif /*__ARM_COMPUTE_NEMEANSTDDEVNORMALIZATIONLAYER_H__ */ |