Compute Library
 20.11
IPyramid.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_IPYRAMID_H
25 #define ARM_COMPUTE_IPYRAMID_H
26 
29 #include "arm_compute/core/Types.h"
30 
31 #include <cstddef>
32 
33 namespace arm_compute
34 {
35 /** Interface for pyramid data-object */
36 class IPyramid
37 {
38 public:
39  /** Default virtual destructor */
40  virtual ~IPyramid() = default;
41  /** Interface to be implemented by the child class to return the Pyramid's metadata
42  *
43  * @return A pointer to the Pyramid's metadata.
44  */
45  virtual const PyramidInfo *info() const = 0;
46  /** Retrieves a level of the pyramid as a ITensor pointer
47  *
48  * @param[in] index The index of the level, such that index is less than levels.
49  *
50  * @return An ITensor pointer
51  */
52  virtual ITensor *get_pyramid_level(size_t index) const = 0;
53 };
54 }
55 
56 #endif /* ARM_COMPUTE_IPYRAMID_H */
virtual const PyramidInfo * info() const =0
Interface to be implemented by the child class to return the Pyramid's metadata.
Interface for NEON tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2020 Arm Limited.
Interface for pyramid data-object.
Definition: IPyramid.h:36
virtual ITensor * get_pyramid_level(size_t index) const =0
Retrieves a level of the pyramid as a ITensor pointer.
Store the Pyramid's metadata.
Definition: PyramidInfo.h:35
virtual ~IPyramid()=default
Default virtual destructor.