utils.hpp File Reference

Detailed Description

Utilities exposed to users.

#include "aie.hpp"
#include "vector.hpp"
#include <cstdio>
#include <cmath>
#include <limits>
#include <utility>

Classes
struct	aie::circular_index< Max >
struct	aie::LoopOptions
	A structure containing options related to loop iteration peeling. More...

Namespaces
namespace	aie
	Base namespace for AIE operations and types.
namespace	aie::utils

Macros
#define	__AIE_API_UTILS__HPP__
#define	AIE_API_CXX_VERSION   202002L

Typedefs
using	aie::utils::AIE_RegFile = detail::utils::AIE_RegFile

Functions
template<unsigned Reg = (unsigned)-1, AIE_RegFile RegFile = AIE_RegFile::Default, typename T>
auto	aie::utils::locate_in_register (const T &val)
template<unsigned Reg = (unsigned)-1, AIE_RegFile RegFile = AIE_RegFile::Default, typename T>
auto	aie::utils::locate_in_register (T &&val)
	Binds a variable to a specified register.
template<unsigned StartIdx = 0, unsigned N, AIE_RegFile RegFile = AIE_RegFile::Default, typename T>
void	aie::utils::locate_in_register (T(&arr)[N])
	Binds each variable in an array to sequential registers, starting from the specified register.
template<unsigned MinIters, LoopOptions Opts = LoopOptions{}, typename Fn>
void	aie::pipelined_loop (unsigned count, Fn &&fn)
	Invokes a function object a given number of times.
template<unsigned MinIters, LoopOptions OptsFn1 = LoopOptions{}, LoopOptions OptsFn2 = LoopOptions{}, typename Fn1, typename Fn2>
void	aie::pipelined_loops (unsigned count, Fn1 &&fn1, Fn2 &&fn2)
	Invokes two function objects a given number of times.
template<unsigned N>
void	aie::print (const aie::mask< N > &m, bool nl=false, const char *prefix=nullptr)
	Displays the contents of a mask.
template<typename C> requires (Vector<C> || Accum<C>)
void	aie::print (const C &c, bool nl=false, const char *prefix=nullptr)
	Displays the contents of a vector or an accumulator.
template<typename T, unsigned Elems> requires (!detail::is_floating_point_v<T>)
void	aie::print_fixed (const aie::vector< T, Elems > &v, int scale, bool nl=false, const char *prefix=nullptr)
	Displays the contents of a vector integers represented as real numbers in fixed point.
template<typename Matrix> requires (Vector<Matrix> || Accum<Matrix>)
void	aie::print_matrix (const Matrix &m, unsigned cols, const char *prefix=nullptr)
	Displays the contents of a vector or accumulator, arranged in a matrix layout.
template<typename T, T Start, T End, T Step = 1, typename Fn>
void	aie::unroll_for (Fn &&fn)
	Invokes a function object as many times as specified by a linear index sequence.
template<typename T, T StartY, T EndY, T StepY, T StartX, T EndX, T StepX, typename Fn>
void	aie::unroll_for_2d (Fn &&fn)
	Invokes a function object as many times as defined by a 2D index sequence.
template<unsigned Times, typename Fn>
void	aie::unroll_times (Fn &&fn)
	Invokes a function object a given number of times.
template<unsigned TimesY, unsigned TimesX, typename Fn>
void	aie::unroll_times_2d (Fn &&fn)
	Invokes a function object as many times as defined by a 2D index sequence.

---

Class Documentation

aie::circular_index

struct aie::circular_index

template<unsigned Max>
struct aie::circular_index< Max >

aie::LoopOptions

struct aie::LoopOptions

A structure containing options related to loop iteration peeling.

To be used with aie::pipelined_loop

Class Members
unsigned	peel_back = 0	The number of iterations to peel at the back of the loop.
unsigned	peel_front = 0	The number of iterations to peel at the front of the loop.
int	preamble_offset = 0	Adjust the preamble.

Macro Definition Documentation

__AIE_API_UTILS__HPP__

#define __AIE_API_UTILS__HPP__

AIE_API_CXX_VERSION

#define AIE_API_CXX_VERSION   202002L