iterable.hpp

Go to the documentation of this file.

//=======================================================================
// Copyright (c) 2014-2023 Baptiste Wicht
// Distributed under the terms of the MIT License.
// (See accompanying file LICENSE or copy at
//  http://opensource.org/licenses/MIT)
//=======================================================================

#pragma once

namespace etl {

template <typename D, bool DMA = false>
struct iterable {
    using derived_t = D; 

    derived_t& as_derived() noexcept {
        return *static_cast<derived_t*>(this);
    }

    const derived_t& as_derived() const noexcept {
        return *static_cast<const derived_t*>(this);
    }

    auto begin() noexcept {
        if constexpr (DMA) {
            as_derived().ensure_cpu_up_to_date();
            return as_derived().memory_start();
        } else {
            return typename derived_t::iterator{as_derived(), 0};
        }
    }

    auto end() noexcept {
        if constexpr (DMA) {
            as_derived().ensure_cpu_up_to_date();
            return as_derived().memory_end();
        } else {
            return typename derived_t::iterator{as_derived(), etl::size(as_derived())};
        }
    }

    auto cbegin() const noexcept {
        if constexpr (DMA) {
            as_derived().ensure_cpu_up_to_date();
            return as_derived().memory_start();
        } else {
            return typename derived_t::const_iterator{as_derived(), 0};
        }
    }

    auto cend() const noexcept {
        if constexpr (DMA) {
            as_derived().ensure_cpu_up_to_date();
            return as_derived().memory_end();
        } else {
            return typename derived_t::const_iterator{as_derived(), etl::size(as_derived())};
        }
    }

    auto begin() const noexcept {
        if constexpr (DMA) {
            as_derived().ensure_cpu_up_to_date();
            return as_derived().memory_start();
        } else {
            return typename derived_t::const_iterator{as_derived(), 0};
        }
    }

    auto end() const noexcept {
        if constexpr (DMA) {
            as_derived().ensure_cpu_up_to_date();
            return as_derived().memory_end();
        } else {
            return typename derived_t::const_iterator{as_derived(), etl::size(as_derived())};
        }
    }
};

} //end of namespace etl