From 6ff3b19ee6120edf015fad8caab2991faa3070af Mon Sep 17 00:00:00 2001 From: Anthony Barbier Date: Mon, 4 Sep 2017 18:44:23 +0100 Subject: COMPMID-344 Updated doxygen Change-Id: I32f7b84daa560e460b77216add529c8fa8b327ae --- arm_compute/core/IPyramid.h | 56 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 arm_compute/core/IPyramid.h (limited to 'arm_compute/core/IPyramid.h') diff --git a/arm_compute/core/IPyramid.h b/arm_compute/core/IPyramid.h new file mode 100644 index 0000000000..e5d7011cf9 --- /dev/null +++ b/arm_compute/core/IPyramid.h @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2016, 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_IPYRAMID_H__ +#define __ARM_COMPUTE_IPYRAMID_H__ + +#include "arm_compute/core/ITensor.h" +#include "arm_compute/core/PyramidInfo.h" +#include "arm_compute/core/Types.h" + +#include + +namespace arm_compute +{ +/** Interface for pyramid data-object */ +class IPyramid +{ +public: + /** Default virtual destructor */ + virtual ~IPyramid() = default; + /** Interface to be implemented by the child class to return the Pyramid's metadata + * + * @return A pointer to the Pyramid's metadata. + */ + virtual const PyramidInfo *info() const = 0; + /** Retrieves a level of the pyramid as a ITensor pointer + * + * @param[in] index The index of the level, such that index is less than levels. + * + * @return An ITensor pointer + */ + virtual ITensor *get_pyramid_level(size_t index) const = 0; +}; +} + +#endif /* __ARM_COMPUTE_IPYRAMID_H__ */ -- cgit v1.2.1