Compute Library
 20.08
Coordinates.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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_COORDINATES_H
25 #define ARM_COMPUTE_COORDINATES_H
26 
28 #include "arm_compute/core/Error.h"
29 
30 #include <algorithm>
31 #include <array>
32 #include <cstddef>
33 
34 namespace arm_compute
35 {
36 /** Coordinates of an item */
37 class Coordinates : public Dimensions<int>
38 {
39 public:
40  /** Constructor to initialize the coordinates.
41  *
42  * @param[in] coords Values to initialize the dimensions.
43  */
44  template <typename... Ts>
45  constexpr Coordinates(Ts... coords)
46  : Dimensions{ coords... }
47  {
48  }
49  /** Allow instances of this class to be copy constructed */
50  constexpr Coordinates(const Coordinates &) = default;
51  /** Allow instances of this class to be copied */
52  Coordinates &operator=(const Coordinates &) = default;
53  /** Allow instances of this class to be move constructed */
54  constexpr Coordinates(Coordinates &&) = default;
55  /** Allow instances of this class to be moved */
56  Coordinates &operator=(Coordinates &&) = default;
57  /** Default destructor */
58  ~Coordinates() = default;
59 };
60 }
61 #endif /*ARM_COMPUTE_COORDINATES_H*/
constexpr Coordinates(Ts... coords)
Constructor to initialize the coordinates.
Definition: Coordinates.h:45
Copyright (c) 2017-2020 Arm Limited.
Coordinates of an item.
Definition: Coordinates.h:37
Coordinates & operator=(const Coordinates &)=default
Allow instances of this class to be copied.
Dimensions with dimensionality.
Definition: Dimensions.h:41
~Coordinates()=default
Default destructor.