IArray.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2018 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_IARRAY_H__
#define __ARM_COMPUTE_IARRAY_H__

#include "arm_compute/core/Error.h"
#include <cstddef>
#include <cstdint>

namespace arm_compute
{
struct KeyPoint;
struct Coordinates2D;
struct DetectionWindow;
class Size2D;
struct ROI;

template <class T>
class IArray
{
public:
    IArray()
        : _num_values(0), _max_size(0) {};
    IArray(size_t max_num_values)
        : _num_values(0), _max_size(max_num_values)
    {
    }
    size_t max_num_values() const
    {
        return _max_size;
    }
    virtual ~IArray() = default;
    size_t num_values() const
    {
        return _num_values;
    }
    bool push_back(const T &val)
    {
        ARM_COMPUTE_ERROR_ON(0 == _max_size);
        if(_num_values >= max_num_values())
        {
            _num_values = max_num_values() + 1;
            return false;
        }
        at(_num_values) = val;
        _num_values++;
        return true;
    }
    void clear()
    {
        _num_values = 0;
    }
    bool overflow() const
    {
        return _num_values > max_num_values();
    }
    virtual T *buffer() const = 0;
    virtual T &at(size_t index) const
    {
        ARM_COMPUTE_ERROR_ON(buffer() == nullptr);
        ARM_COMPUTE_ERROR_ON(index >= max_num_values());
        return buffer()[index];
    }
    void resize(size_t num)
    {
        ARM_COMPUTE_ERROR_ON(num > max_num_values());
        _num_values = num;
    };

private:
    size_t _num_values;
    size_t _max_size;
};
using IKeyPointArray = IArray<KeyPoint>;
using ICoordinates2DArray = IArray<Coordinates2D>;
using IDetectionWindowArray = IArray<DetectionWindow>;
using IROIArray = IArray<ROI>;
using ISize2DArray = IArray<Size2D>;
using IUInt8Array = IArray<uint8_t>;
using IUInt16Array = IArray<uint16_t>;
using IUInt32Array = IArray<uint32_t>;
using IInt16Array = IArray<int16_t>;
using IInt32Array = IArray<int32_t>;
using IFloatArray = IArray<float>;
}
#endif /* __ARM_COMPUTE_IARRAY_H__ */