Compute Library
 22.08
NESlice.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2021 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_NE_SLICE_H
25 #define ARM_COMPUTE_NE_SLICE_H
26 
29 
30 namespace arm_compute
31 {
32 // Forward Declarations
33 class ITensor;
34 
35 /** Basic function to perform tensor slicing */
36 class NESlice : public IFunction
37 {
38 public:
39  /** Default Constructor */
40  NESlice();
41  /** Default Destructor */
42  ~NESlice();
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
44  NESlice(const NESlice &) = delete;
45  /** Default move constructor */
46  NESlice(NESlice &&);
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  NESlice &operator=(const NESlice &) = delete;
49  /** Default move assignment operator */
51 
52  /** Configure kernel
53  *
54  * Valid data layouts:
55  * - All
56  *
57  * Valid data type configurations:
58  * |src |dst |
59  * |:------|:------|
60  * |All |All |
61  *
62  * @note Supported tensor rank: up to 4
63  * @note Start indices must be non-negative. 0 <= starts[i]
64  * @note End coordinates can be negative, which represents the number of elements before the end of that dimension.
65  * @note End indices are not inclusive unless negative.
66  *
67  * @param[in] input Source tensor. Data type supported: All
68  * @param[out] output Destination tensor. Data type supported: Same as @p input
69  * @param[in] starts The starts of the dimensions of the input tensor to be sliced. The length must be of rank(input).
70  * @param[in] ends The ends of the dimensions of the input tensor to be sliced. The length must be of rank(input).
71  */
72  void configure(const ITensor *input, ITensor *output, const Coordinates &starts, const Coordinates &ends);
73 
74  /** Static function to check if given info will lead to a valid configuration of @ref NESlice
75  *
76  * @note Supported tensor rank: up to 4
77  * @note Start indices must be non-negative. 0 <= starts[i]
78  * @note End coordinates can be negative, which represents the number of elements before the end of that dimension.
79  * @note End indices are not inclusive unless negative.
80  *
81  * @param[in] input Source tensor info. Data type supported: All
82  * @param[in] output Destination tensor info. Data type supported: Same as @p input
83  * @param[in] starts The starts of the dimensions of the input tensor to be sliced. The length must be of rank(input).
84  * @param[in] ends The ends of the dimensions of the input tensor to be sliced. The length must be of rank(input).
85  *
86  * @return A status
87  */
88  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Coordinates &starts, const Coordinates &ends);
89 
90  // Inherited methods overridden:
91  void run() override;
92 
93 private:
94  struct Impl;
95  std::unique_ptr<Impl> _impl;
96 };
97 
98 namespace experimental
99 {
100 /** Basic function to perform tensor slicing */
101 class NESlice : public INEOperator
102 {
103 public:
104  /** Configure kernel
105  *
106  * @note Supported tensor rank: up to 4
107  * @note Start indices must be non-negative. 0 <= starts[i]
108  * @note End coordinates can be negative, which represents the number of elements before the end of that dimension.
109  * @note End indices are not inclusive unless negative.
110  *
111  * @param[in] input Source tensor info. Data type supported: All
112  * @param[out] output Destination tensor info. Data type supported: Same as @p input
113  * @param[in] starts The starts of the dimensions of the input tensor to be sliced. The length must be of rank(input).
114  * @param[in] ends The ends of the dimensions of the input tensor to be sliced. The length must be of rank(input).
115  */
116  void configure(const ITensorInfo *input, ITensorInfo *output, const Coordinates &starts, const Coordinates &ends);
117 
118  /** Static function to check if given info will lead to a valid configuration of @ref NESlice
119  *
120  * @note Supported tensor rank: up to 4
121  * @note Start indices must be non-negative. 0 <= starts[i]
122  * @note End coordinates can be negative, which represents the number of elements before the end of that dimension.
123  * @note End indices are not inclusive unless negative.
124  *
125  * @param[in] input Source tensor info. Data type supported: All
126  * @param[in] output Destination tensor info. Data type supported: Same as @p input
127  * @param[in] starts The starts of the dimensions of the input tensor to be sliced. The length must be of rank(input).
128  * @param[in] ends The ends of the dimensions of the input tensor to be sliced. The length must be of rank(input).
129  *
130  * @return A status
131  */
132  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Coordinates &starts, const Coordinates &ends);
133 };
134 } // namespace experimental
135 } // namespace arm_compute
136 #endif /* ARM_COMPUTE_NE_SLICE_H */
NESlice & operator=(const NESlice &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Base class for all functions.
Definition: IFunction.h:30
Basic interface for functions which have a single async CPU kernel.
Definition: INEOperator.h:43
Basic function to perform tensor slicing.
Definition: NESlice.h:36
Basic function to perform tensor slicing.
Definition: NESlice.h:101
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
void configure(const ITensor *input, ITensor *output, const Coordinates &starts, const Coordinates &ends)
Configure kernel.
Definition: NESlice.cpp:87
~NESlice()
Default Destructor.
Coordinates of an item.
Definition: Coordinates.h:37
NESlice()
Default Constructor.
Definition: NESlice.cpp:74
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Coordinates &starts, const Coordinates &ends)
Static function to check if given info will lead to a valid configuration of NESlice.
Definition: NESlice.cpp:82
void run() override
Run the kernels contained in the function.
Definition: NESlice.cpp:95