tetl-docs/assume__aligned_8hpp_source.html

// SPDX-License-Identifier: BSL-1.0


#ifndef TETL_MEMORY_ASSUME_ALIGNED_HPP

#define TETL_MEMORY_ASSUME_ALIGNED_HPP


#include <etl/_config/all.hpp>


#include <etl/_bit/has_single_bit.hpp>

#include <etl/_cstddef/size_t.hpp>

#include <etl/_type_traits/is_constant_evaluated.hpp>


namespace etl {


template <etl::size_t N, typename T>


[[nodiscard]] constexpr auto assume_aligned(T* ptr) -> T*

{

    static_assert(etl::has_single_bit(N));

    static_assert(alignof(T) <= N);


    if (not is_constant_evaluated()) {

#if __has_builtin(__builtin_assume_aligned)

        return static_cast<T*>(__builtin_assume_aligned(ptr, N));

#endif

    }


    return ptr;

}


} // namespace etl


#endif // TETL_MEMORY_ASSUME_ALIGNED_HPP

all.hpp

etl::has_single_bit
constexpr auto has_single_bit(UInt x) noexcept -> bool
Checks if x is an integral power of two.
Definition has_single_bit.hpp:21

etl::assume_aligned
constexpr auto assume_aligned(T *ptr) -> T *
Informs the implementation that the object ptr points to is aligned to at least N....
Definition assume_aligned.hpp:28

has_single_bit.hpp

is_constant_evaluated.hpp

etl
Definition adjacent_find.hpp:8

etl::is_constant_evaluated
constexpr auto is_constant_evaluated() noexcept -> bool
Detects whether the function call occurs within a constant-evaluated context. Returns true if the eva...
Definition is_constant_evaluated.hpp:16

size_t.hpp