xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/core/Steps.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-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_STEPS_H
25 #define ARM_COMPUTE_STEPS_H
26 
27 #include "arm_compute/core/Dimensions.h"
28 #include "arm_compute/core/Error.h"
29 #include "arm_compute/core/Types.h"
30 
31 #include <algorithm>
32 #include <array>
33 #include <cstddef>
34 
35 namespace arm_compute
36 {
37 /** Class to describe a number of elements in each dimension. Similar to @ref
38  *  Strides but not in bytes but number of elements.
39  */
40 class Steps : public Dimensions<uint32_t>
41 {
42 public:
43     /** Constructor to initialize the steps.
44      *
45      * @param[in] steps Values to initialize the steps.
46      */
47     template <typename... Ts>
Steps(Ts...steps)48     Steps(Ts... steps)
49         : Dimensions{ steps... }
50     {
51         // Initialize empty dimensions to 1
52         std::fill(_id.begin() + _num_dimensions, _id.end(), 1);
53     }
54     /** Allow instances of this class to be copy constructed */
55     constexpr Steps(const Steps &) = default;
56     /** Allow instances of this class to be copied */
57     Steps &operator=(const Steps &) = default;
58     /** Allow instances of this class to be move constructed */
59     constexpr Steps(Steps &&) = default;
60     /** Allow instances of this class to be moved */
61     Steps &operator=(Steps &&) = default;
62     /** Default destructor */
63     ~Steps() = default;
64 };
65 }
66 #endif /*ARM_COMPUTE_STEPS_H*/
67