| AI Engine API User Guide (AIE-API) 2025.2

Loading...
Searching...
No Matches
Namespaces | Macros | Functions
io_buffer.hpp File Reference
`#include <adf.h>`
`#include "../aie.hpp"`
`#include "../iterator.hpp"`

## Namespaces
namespace | aie
| Base namespace for AIE operations and types.

## Macros
#define | __AIE_API_AIE_ADF_IO_BUFFER_HPP__

## Functions
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin (adf::io_buffer< T, Dir, Config > &port)
| Returns a foward iterator over given io buffer.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin (const adf::io_buffer< T, Dir, Config > &port)
| Returns a foward const iterator over given io buffer.
template<aie_dm_resource Resource, typename T>
constexpr auto | aie::begin (T *base, size_t n)
| Returns an iterator for the array described by the given address and size.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_circular (adf::io_buffer< T, Dir, Config > &port)
| Returns a foward circular iterator over given io buffer.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const foward circular iterator over given io buffer.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_random_circular (adf::io_buffer< T, Dir, Config > &port)
| Returns a random iterator over given io buffer.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_random_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a random const iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_restrict_vector (adf::io_buffer< T, Dir, Config > &port)
| Returns a restrict vector iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_restrict_vector (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const restrict vector iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_vector (adf::io_buffer< T, Dir, Config > &port)
| Returns a vector iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_vector (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const vector iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_vector_circular (adf::io_buffer< T, Dir, Config > &port)
| Returns a vector circular iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_vector_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const vector circular iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_vector_random_circular (adf::io_buffer< T, Dir, Config > &port)
| Returns a vector random circular iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::begin_vector_random_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const vector random circular iterator over given io buffer.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::cbegin (const adf::io_buffer< T, Dir, Config > &port)
| Returns a foward const iterator over given io buffer.
template<aie_dm_resource Resource, typename T>
constexpr auto | aie::cbegin (const T *base, size_t n)
| Returns an iterator for the constant array described by the given address and size.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::cbegin_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const foward iterator over given io buffer.
template<aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::cbegin_random_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a random const iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::cbegin_restrict_vector (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const restrict vector iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::cbegin_vector (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const vector iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::cbegin_vector_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const vector circular iterator over given io buffer.
template<unsigned Elems, aie_dm_resource Resource = aie_dm_resource::none, typename T, typename Dir, typename Config>
constexpr auto | aie::cbegin_vector_random_circular (const adf::io_buffer< T, Dir, Config > &port)
| Returns a const vector random circular iterator over given io buffer.
template<aie_dm_resource Resource = aie_dm_resource::none, aie::tbs_mode Mode = aie::tbs_mode::default_mode, IOBuffer T, typename TensorDescriptor>
constexpr auto | aie::make_tensor_buffer_stream (const T &port, const TensorDescriptor &tensor_desc)
template<aie_dm_resource Resource = aie_dm_resource::none, aie::tbs_mode Mode = aie::tbs_mode::default_mode, IOBuffer T, typename TensorDescriptor>
constexpr auto | aie::make_tensor_buffer_stream (T &port, const TensorDescriptor &tensor_desc)

## Macro Definition Documentation

## ◆ __AIE_API_AIE_ADF_IO_BUFFER_HPP__

#define __AIE_API_AIE_ADF_IO_BUFFER_HPP__