Vitis HLS 学习笔记--BLAS库之WideType

1. WideType 数据类型

2. WideType 类模板参数

2.1 SFINAE技术

3. WideType 类中的函数

3.1 operator[](unsigned int p_Idx)

3.2 operator==(const WideType& p_w) const

3.3 getValAddr()

3.4 operator const t_TypeInt()

4. 总结

1. WideType 数据类型

在 Vitis HLS工具中，BLAS（基础线性代数子程序）库提供了一系列的函数，用于执行各种线性代数运算，比如向量加法、矩阵乘法等。

在这些函数中，WideType 数据类型起着重要的作用。

2. WideType 类模板参数

template <typename T, unsigned int t_Width, unsigned int t_DataWidth = sizeof(T) * 8, typename Enable = void>
class WideType {
...
}

第一个参数：typename T，表示WideType类将处理的基本数据类型。

第二个参数：unsigned int t_Width，用于指定WideType实例中m_Val数组的长度。这个参数决定了WideType对象能夠存储多少个T类型的元素。t_Width在编译时需要被明确指定，从而允许WideType对象在内部存储固定数量的元素。

第三个参数：unsigned int t_DataWidth，默认值是sizeof(T) * 8，即T类型数据的大小（以字节为单位）乘以8，转换为位(bit)。t_DataWidth参数用于指定单个T类型数据的宽度（以位为单位）。

第四个参数：typename Enable = void，可选的模板参数。使用了SFINAE（Substitution Failure Is Not An Error）技术来启用或禁用某些模板特化。这种技术利用了模板替换失败并不是错误的特性，通过设置默认类型为void，可以在特定条件下启用默认模板，或者根据特化来启用不同的模板实现。

2.1 SFINAE技术

SFINAE称为Substitution Failure Is Not An Error，允许在模板类型推导过程中，如果某个替换（substitution）失败了，并不会立即导致编译错误，而是让编译器尝试其他的模板重载或特化。

对于t_Width为1的情况，WideType类有一个特殊化版本。

template <typename T, unsigned int t_DataWidth>
class WideType<T, 1, t_DataWidth, typename std::enable_if<std::is_same<ap_uint<t_DataWidth>, T>::value>::type> {
...
}

std::enable_if是一个类型特征，它根据一个编译期常量表达式的值来启用或禁用某个类型。如果std::enable_if的第一个参数为true，那么std::enable_if有一个名为type的成员类型，否则type成员不存在。

std::is_same<ap_uint<t_DataWidth>, T>::value是一个编译期常量表达式，它检查两个类型是否相同。如果T确实是ap_uint<t_DataWidth>，那么std::is_same的value为true，否则为false。

这个特化版本的WideType只有在T类型与ap_uint<t_DataWidth>类型完全相同时才会被编译器考虑。这通过std::enable_if的机制实现，它在T类型不匹配时，由于typename std::enable_if<...>::type不能解析为一个有效的类型，这种情况下的特化就会被SFINAE规则排除掉，编译器会继续寻找其他的模板匹配或特化。

这种做法，本质上是增强了模板的适用性。

3. WideType 类中的函数

WideType 数据类型在提供的代码中是一个模板类，其源代码请参考链接：

BLAS - WideTypehttps://github.com/Xilinx/Vitis_Libraries/blob/2022.1/blas/L1/include/hw/xf_blas/helpers/utils/types.hppWideType 数据类型被设计用来表示宽位数据类型，这个类的定义和实现包含了多个模板参数和一些特殊的成员函数：

getVal(unsigned int i)，返回指定索引i处的元素引用。
operator[](unsigned int p_Idx)，重载下标运算符，返回指定索引p_Idx处的元素引用。
operator[](unsigned int p_Idx) const，常量版本的下标运算符重载。
getValAddr()，返回指向m_Val数组的指针。
WideType()，默认构造函数，用于初始化m_Val数组。
WideType(const WideType& wt)，拷贝构造函数，用于从另一个WideType对象进行初始化。
constructor(const WideType& wt)，构造函数的辅助函数，用于从另一个WideType对象进行初始化。
operator const t_TypeInt()，类型转换运算符，将WideType对象转换为t_TypeInt类型。
operator==(const WideType& p_w) const，相等运算符重载，用于比较两个WideType对象是否相等。
shift(T p_ValIn)，将数组元素向左移位，并在第一个位置插入给定的元素值，返回移出的最后一个元素值。
shift()，将数组元素向左移位，并返回移出的最后一个元素值。
unshift()，将数组元素向右移位，并返回移出的第一个元素值。
unshift(const T p_val)，将数组元素向右移位，并在最后一个位置插入给定的元素值，返回移出的第一个元素值。
static const WideType zero()，返回一个全零的WideType对象。
static unsigned int per4k()，返回静态常量t_per4k的值。
print(std::ostream& os)，将m_Val数组中的元素打印到给定的输出流。
friend std::ostream& operator<<(std::ostream& os, WideType& p_Val)，重载流插入运算符，用于将WideType对象输出到输出流中。

下面重点介绍几个方法：

3.1 operator[](unsigned int p_Idx)

用途：重载下标运算符，返回指定索引p_Idx处的元素引用。

T& operator[](unsigned int p_Idx) {
#pragma HLS INLINE
#ifndef __SYNTHESIS__
    assert(p_Idx < t_Width);
#endif
    return (m_Val[p_Idx]);}

T&：函数的返回类型，表示返回的是 T 类型的引用。
operator[]：运算符重载的语法，表示重载数组访问运算符 []。
(unsigned int p_Idx)：函数的参数列表，接受一个名为 p_Idx 的无符号整数参数。

该函数重载了数组访问运算符 []，它接受一个无符号整数参数，并返回一个引用类型的 T 对象，允许像使用数组一样通过索引访问对象中的元素。

3.2 operator==(const WideType& p_w) const

用途：相等运算符重载，用于比较两个WideType对象是否相等。

bool operator==(const WideType& p_w) const {
    bool l_com = true;
    for (int i = 0; i < t_Width; ++i) {
        l_com = l_com && (m_Val[i] == p_w[i]);
    }
    return l_com;}

bool 函数的返回类型布尔变量，初始返回为 true。
l_com = l_com && (m_Val[i] == p_w[i]); 在循环内部，比较当前对象的第 i 个元素 m_Val[i] 和参数对象 p_w 的第 i 个元素是否相等。将比较结果与 l_com 进行逻辑与运算，将结果保存在 l_com 中。如果有任何一个元素不相等，l_com 将变为 false。
如果所有元素都相等，返回 true；否则返回 false。

这段代码实现了一个自定义类型 WideType 对象的等于运算符重载。它通过逐个比较对象的元素，判断两个对象是否相等，并返回比较结果。可以使用 == 运算符来比较两个 WideType 对象是否相等。

3.3 getValAddr()

用途：返回指向m_Val数组的指针。

T* getValAddr() { 
#pragma HLS INLINE
    return (&m_Val[0]);}

3.4 operator const t_TypeInt()

用途：类型转换运算符，WideType->t_TypeInt类型。

operator const t_TypeInt() {
    t_TypeInt l_fVal;
    for (int i = 0; i < t_Width; ++i) {
    #pragma HLS UNROLL
        T l_v = m_Val[i];
        ap_uint<t_DataWidth> l_val = *reinterpret_cast<ap_uint<t_DataWidth>*>(&l_v);
        l_fVal.range(t_DataWidth * (1 + i) - 1, t_DataWidth * i) = l_val;
    }
    return l_fVal;
}

用法举例：

xf::blas::WideType<int, 2> wt; wt[0]=1; wt[1]=3;

xf::blas::WideType<int, 2>::t_TypeInt val = wt;

std::cout << std::hex << val << std::endl; //输出0x300000001