Array1D.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2025 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include "Zivid/Detail/UtilsExport.h"
 
#include <memory>
#include <string>
 
namespace Zivid
{
 
#ifndef NO_DOC
    namespace Detail
    {
        ZIVID_UTILS_EXPORT std::string array1DToString(std::size_t size);
    } // namespace Detail
#endif
 
    template<typename DataFormat>
    class Array1D
    {
    public:
        using ValueType = DataFormat;
 
        using ConstIterator = const DataFormat *;
 
        Array1D()
            : m_size{ 0 }
        {}
 
        size_t size() const
        {
            return m_size;
        }
 
        bool isEmpty() const
        {
            return size() == 0;
        }
 
        const DataFormat *data() const
        {
            return m_data.get();
        }
 
        const DataFormat &operator()(size_t idx) const
        {
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic push
#        pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
#    endif
#endif
            return *(data() + idx);
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic pop
#    endif
#endif
        }
 
        ConstIterator begin() const
        {
            return data();
        }
 
        ConstIterator end() const
        {
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic push
#        pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
#    endif
#endif
            return data() + size();
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic pop
#    endif
#endif
        }
 
        ConstIterator cbegin() const
        {
            return begin();
        }
 
        ConstIterator cend() const
        {
            return end();
        }
 
        std::string toString() const
        {
            return Detail::array1DToString(size());
        }
 
    private:
        friend class Array1DFactory;
 
        Array1D(std::size_t size, std::unique_ptr<DataFormat[]> data)
            : m_size{ size }
            , m_data{ std::move(data) }
        {}
 
        size_t m_size;
        std::shared_ptr<const DataFormat[]> m_data;
    };
 
    template<typename T>
    std::ostream &operator<<(std::ostream &stream, const Array1D<T> &array)
    {
        return stream << array.toString();
    }
 
    template<typename T>
    typename Array1D<T>::ConstIterator cbegin(const Array1D<T> &array)
    {
        return array.cbegin();
    }
 
    template<typename T>
    typename Array1D<T>::ConstIterator begin(const Array1D<T> &array)
    {
        return array.begin();
    }
 
    template<typename T>
    typename Array1D<T>::ConstIterator cend(const Array1D<T> &array)
    {
        return array.cend();
    }
 
    template<typename T>
    typename Array1D<T>::ConstIterator end(const Array1D<T> &array)
    {
        return array.end();
    }
} // namespace Zivid