fixed_array.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2022 Intel Corporation. All rights reserved.
 */
 
#ifndef _ADSP_FIXED_ARRAY_H_
#define _ADSP_FIXED_ARRAY_H_
 
#include <stddef.h>
 
namespace intel_adsp
{
    /* \brief Fixed-size container of continuous elements whose size is specified at runtime.
     *
     * This container is very similar to the C-array except that its fixed-size is specified at
     * runtime.
     * It acts as a facade to expose a memory buffer as a array of elements with same type.
     *
     *  \tparam VALUE   type of the array elements.
     */
    template < class VALUE >
    struct FixedArray {
        typedef VALUE ValueType;

        explicit FixedArray(ValueType *array, size_t length) :
                    array_(array), length_(length)
        {}

        ValueType GetValue(int index = 0) const
        {
            return array_[index];
        }

        ValueType operator[](int index) const
        {
            return GetValue(index);
        }

        size_t GetLength(void) const
        {
            return length_;
        }

        void Copy(ValueType *array, size_t length) const
        {
            length = MIN(length, length_);
            for (int i = 0 ; i < length ; i++)
                array[i] = array_[i];
        }
 
    private:
        ValueType * const array_;
        size_t const length_;
    };
 
} /* namespace intel_adsp */
 
#endif /* #ifndef _ADSP_FIXED_ARRAY_H_ */