Question

我花了一些时间学习如何在C ++中使用模板。我从来没用过它们之前和我并不总是确定在不同的情况下可以做什么或什么不能实现。

作为练习，我正在包装一些我用于活动的Blas和Lapack函数，我正在研究?GELS的包装（评估一组线性方程组的解）。

 A x + b = 0

?GELS函数（仅对于实数值）存在两个名称：SGELS，用于单精度向量和 DGELS表示双精度。

我对接口的想法就是这样一个函数solve：

 const std::size_t rows = /* number of rows for A */;
 const std::size_t cols = /* number of cols for A */;
 std::array< double, rows * cols > A = { /* values */ };
 std::array< double, ??? > b = { /* values */ };  // ??? it can be either
                                                  // rows or cols. It depends on user
                                                  // problem, in general
                                                  // max( dim(x), dim(b) ) =
                                                  // max( cols, rows )     
 solve< double, rows, cols >(A, b);
 // the solution x is stored in b, thus b 
 // must be "large" enough to accomodate x

根据用户要求，问题可能是过度确定或未确定，这意味着：

如果它是超定的dim(b) > dim(x)（解决方案是伪逆）
如果未确定dim(b) < dim(x)（解决方案是LSQ最小化）
或正常情况dim(b) = dim(x)（解决方案与A相反）

（不考虑单一案例）。

由于?GELS将结果存储在输入向量b中，std::array shouold 有足够的空间来容纳解决方案，如代码注释（max(rows, cols)）中所述。

我想（编译时）确定采用哪种解决方案（这是一个参数改变在?GELS电话中。我有两个功能（我为了这个问题而简化），处理精度并已知道b的维度和rows / cols的数量：

namespace wrap {

template <std::size_t rows, std::size_t cols, std::size_t dimb>
void solve(std::array<float, rows * cols> & A, std::array<float, dimb> & b) {
  SGELS(/* Called in the right way */);
}

template <std::size_t rows, std::size_t cols, std::size_t dimb>
void solve(std::array<double, rows * cols> & A, std::array<double, dimb> & b) {
  DGELS(/* Called in the right way */);
}

}; /* namespace wrap */

是内部包装器的一部分。用户功能，确定所需的大小在b向量中通过模板：

#include <type_traits>

/** This struct makes the max between rows and cols */
template < std::size_t rows, std::size_t cols >
struct biggest_dim {
  static std::size_t const value = std::conditional< rows >= cols, std::integral_constant< std::size_t, rows >,
                                                     std::integral_constant< std::size_t, cols > >::type::value;
};

/** A type for the b array is selected using "biggest_dim" */
template < typename REAL_T, std::size_t rows, std::size_t cols >
using b_array_t = std::array< REAL_T, biggest_dim< rows, cols >::value >;

/** Here we have the function that allows only the call with b of
 *  the correct size to continue */
template < typename REAL_T, std::size_t rows, std::size_t cols >
void solve(std::array< REAL_T, cols * rows > & A, b_array_t< REAL_T, cols, rows > & b) {
  static_assert(std::is_floating_point< REAL_T >::value, "Only float/double accepted");
  wrap::solve< rows, cols, biggest_dim< rows, cols >::value >(A, b);
}

通过这种方式实际上可行。但我想更进一步，我真的不知道如何做到这一点。如果用户尝试使用大小太小的solve来调用b，则编译器会引发极难读取的错误。

我正在尝试插入一个static_assert，帮助用户理解他的错误。但是我想到的任何方向需要使用具有相同签名的两个函数（它就像模板重载？）我找不到SFINAE策略（他们实际上根本没有编译）。

您是否认为可以针对错误b维的情况提出静态断言，而无需在编译时更改用户界面？我希望这个问题足够清楚。

@Caninonos ：对我来说，用户界面就是用户调用求解器的方式，即：

 solve< type, number of rows, number of cols > (matrix A, vector b)

这是我锻炼的一个约束，以提高我的技能。这意味着，我不知道实际上是否有可能实现解决方案。 b的类型必须与函数调用匹配，如果我添加另一个模板参数并更改用户界面，违反我的约束，则很容易。

最小的完整和有效的例子

这是一个最小的完整和有效的例子。根据要求，我删除了对线性代数概念的任何引用。这是一个数字问题。案例是：

N1 = 2, N2 =2。由于N3 = max(N1, N2) = 2一切正常
N1 = 2, N2 =1。由于N3 = max(N1, N2) = N1 = 2一切正常
N1 = 1, N2 =2。由于N3 = max(N1, N2) = N2 = 2一切正常
N1 = 1, N2 =2。由于N3 = N1 = 1 < N2它正确引发了编译错误。我希望用静态断言来拦截编译错误，该断言解释了N3的维度错误的事实。至于现在，错误很难阅读和理解。

你可以view and test it online here

Answer 1

首先进行一些改进，简化设计并帮助实现可重复性：

不需要biggest_dim。 std::max是constexpr sice C ++ 14。你应该改用它。
不需要b_array_t。您只需撰写std::array< REAL_T, std::max(N1, N2)>

现在你的问题。 C ++ 17中的一个好方法是：

template < typename REAL_T, std::size_t N1, std::size_t N2, std::size_t N3>
void solve(std::array< REAL_T, N1 * N2 > & A, std::array< REAL_T, N3> & b) {

    if constexpr (N3 == std::max(N1, N2))
        wrap::internal< N1, N2, N3 >(A, b);
    else
        static_assert(N3 == std::max(N1, N2), "invalid 3rd dimmension");

        // don't write static_assert(false)
        // this would make the program ill-formed (*)
}

或者，正如@ max66

指出的那样

template < typename REAL_T, std::size_t N1, std::size_t N2, std::size_t N3>
void solve(std::array< REAL_T, N1 * N2 > & A, std::array< REAL_T, N3> & b) {

    static_assert(N3 == std::max(N1, N2), "invalid 3rd dimmension");

    if constexpr (N3 == std::max(N1, N2))
        wrap::internal< N1, N2, N3 >(A, b);

}

Tadaa !! 简单，优雅，漂亮的错误讯息。

constexpr if version和static_assert之间的区别I.e。：

void solve(...)
{
   static_assert(...);
   wrap::internal(...);
}

只有static_assert，即使在wrap::internal失败，编译器也会尝试实例化static_assert，从而污染错误输出。使用constexpr，如果对wrap::internal的调用不是条件的一部分，则条件失败，因此错误输出是干净的。

（*）我之所以不写static_asert(false, "error msg)的原因是因为这会导致程序格式错误，无需诊断。见constexpr if and static_assert

如果您愿意，还可以通过在不可扣除的模板之后移动模板参数来制作float / double免赔额：

template < std::size_t N1, std::size_t N2, std::size_t N3,  typename REAL_T>
void solve(std::array< REAL_T, N1 * N2 > & A, std::array< REAL_T, N3> & b) {

所以电话会变成：

solve< n1_3, n2_3>(A_3, b_3);

Answer 2

为什么不尝试将tag dispatch与某些static_assert组合在一起？以下是实现您想要解决的问题的一种方法，我希望如此。我的意思是，所有三个正确的案例都适当地通过正确的blas调用，处理了不同的类型和维度不匹配，并且还处理了有关float和double s的违规行为以用户友好的方式，感谢static_assert。

编辑。我不确定您的C++版本要求，但以下是C++11友好。

#include <algorithm>
#include <iostream>
#include <type_traits>

template <class value_t, int nrows, int ncols> struct Matrix {};
template <class value_t, int rows> struct Vector {};

template <class value_t> struct blas;

template <> struct blas<float> {
  static void overdet(...) { std::cout << __PRETTY_FUNCTION__ << std::endl; }
  static void underdet(...) { std::cout << __PRETTY_FUNCTION__ << std::endl; }
  static void normal(...) { std::cout << __PRETTY_FUNCTION__ << std::endl; }
};

template <> struct blas<double> {
  static void overdet(...) { std::cout << __PRETTY_FUNCTION__ << std::endl; }
  static void underdet(...) { std::cout << __PRETTY_FUNCTION__ << std::endl; }
  static void normal(...) { std::cout << __PRETTY_FUNCTION__ << std::endl; }
};

class overdet {};
class underdet {};
class normal {};

template <class T1, class T2, int nrows, int ncols, int dim>
void solve(const Matrix<T1, nrows, ncols> &lhs, Vector<T2, dim> &rhs) {
  static_assert(std::is_same<T1, T2>::value,
                "lhs and rhs must have the same value types");
  static_assert(dim >= nrows && dim >= ncols,
                "rhs does not have enough space");
  static_assert(std::is_same<T1, float>::value ||
                std::is_same<T1, double>::value,
                "Only float or double are accepted");
  solve_impl(lhs, rhs,
             typename std::conditional<(nrows < ncols), underdet,
             typename std::conditional<(nrows > ncols), overdet,
                                                        normal>::type>::type{});
}

template <class value_t, int nrows, int ncols, int dim>
void solve_impl(const Matrix<value_t, nrows, ncols> &lhs,
                Vector<value_t, dim> &rhs, underdet) {
  /* get the pointers and dimension information from lhs and rhs */
  blas<value_t>::underdet(
      /* trans, m, n, nrhs, A, lda, B, ldb, work, lwork, info */);
}

template <class value_t, int nrows, int ncols, int dim>
void solve_impl(const Matrix<value_t, nrows, ncols> &lhs,
                Vector<value_t, dim> &rhs, overdet) {
  /* get the pointers and dimension information from lhs and rhs */
  blas<value_t>::overdet(
      /* trans, m, n, nrhs, A, lda, B, ldb, work, lwork, info */);
}

template <class value_t, int nrows, int ncols, int dim>
void solve_impl(const Matrix<value_t, nrows, ncols> &lhs,
                Vector<value_t, dim> &rhs, normal) {
  /* get the pointers and dimension information from lhs and rhs */
  blas<value_t>::normal(
      /* trans, m, n, nrhs, A, lda, B, ldb, work, lwork, info */);
}

int main() {
  /* valid types */
  Matrix<float, 2, 4> A1;
  Matrix<float, 4, 4> A2;
  Matrix<float, 5, 4> A3;
  Vector<float, 4> b1;
  Vector<float, 5> b2;
  solve(A1, b1);
  solve(A2, b1);
  solve(A3, b2);

  Matrix<int, 4, 4> A4;
  Vector<int, 4> b3;
  // solve(A4, b3); // static_assert for float & double

  Matrix<float, 4, 4> A5;
  Vector<int, 4> b4;
  // solve(A5, b4); // static_assert for different types

  // solve(A3, b1); // static_assert for dimension problem

  return 0;
}

Answer 3

你必须考虑为什么接口提供这个（错综复杂的）一堆参数。作者有几个想法。首先，您可以在一个函数中解决A x + b == 0和A^T x + b == 0形式的问题。其次，给定的A和b实际上可以指向矩阵中的内存大于alg所需的内存。这可以通过LDA和LDB参数看到。

这是使子事变得复杂的子地址。如果你想要一个简单但可能有用的API，你可以选择忽略那个部分：

using ::std::size_t;
using ::std::array;

template<typename T, size_t rows, size_t cols>
using matrix = array<T, rows * cols>;

enum class TransposeMode : bool {
  None = false, Transposed = true
};

// See https://stackoverflow.com/questions/14637356/
template<typename T> struct always_false_t : std::false_type {};
template<typename T> constexpr bool always_false_v = always_false_t<T>::value;

template < typename T, size_t rowsA, size_t colsA, size_t rowsB, size_t colsB
    , TransposeMode mode = TransposeMode::None >
void solve(matrix<T, rowsA, colsA>& A, matrix<T, rowsB, colsB>& B)
{
  // Since the algorithm works in place, b needs to be able to store
  // both input and output
  static_assert(rowsB >= rowsA && rowsB >= colsA, "b is too small");
  // LDA = rowsA, LDB = rowsB
  if constexpr (::std::is_same_v<T, float>) {
    // SGELS(mode == TransposeMode::None ? 'N' : 'T', ....);
  } else if constexpr (::std::is_same_v<T, double>) {
    // DGELS(mode == TransposeMode::None ? 'N' : 'T', ....);
  } else {
    static_assert(always_false_v<T>, "Unknown type");
  }
}

现在，使用LDA和LDB解决可能的子地址问题。我建议你制作数据类型的那一部分，而不是模板签名的直接部分。您希望拥有自己的矩阵类型，可以在矩阵中引用存储。也许是这样的：

// Since we store elements in a column-major order, we can always 
// pretend that our matrix has less columns than it actually has
// less rows than allocated. We can not equally pretend less rows
// otherwise the addressing into the array is off.
// Thus, we'd only four total parameters:
// offset = columnSkipped * actualRows + rowSkipped), actualRows, rows, cols
// We store the offset implicitly by adjusting our begin pointer
template<typename T, size_t rows, size_t cols, size_t actualRows>
class matrix_view { // Name derived from string_view :)
  static_assert(actualRows >= rows);
  T* start;
  matrix_view(T* start) : start(start) {}
  template<typename U, size_t r, size_t c, size_t ac>
  friend class matrix_view;
public:
  template<typename U>
  matrix_view(matrix<U, rows, cols>& ref)
  : start(ref.data()) { }

  template<size_t rowSkipped, size_t colSkipped, size_t newRows, size_t newCols>
  auto submat() {
    static_assert(colSkipped + newCols <= cols, "can only shrink");
    static_assert(rowSkipped + newRows <= rows, "can only shrink");
    auto newStart = start + colSkipped * actualRows + rowSkipped;
    using newType = matrix_view<T, newRows, newCols, actualRows>
    return newType{ newStart };
  }
  T* data() {
    return start;
  }
};

现在，您需要使您的界面适应这种新数据类型，这基本上只是引入了一些新参数。支票基本保持不变。

// Using this instead of just type-defing allows us to use deducation guides
// Replaces: using matrix = std::array from above
template<typename T, size_t rows, size_t cols>
class matrix {
public:
    std::array<T, rows * cols> storage;
    auto data() { return storage.data(); }
    auto data() const { return storage.data(); }
};

extern void dgels(char TRANS
  , integer M, integer N , integer NRHS
  , double* A, integer LDA
  , double* B, integer LDB); // Mock, missing a few parameters at the end
// Replaces the solve method from above
template < typename T, size_t rowsA, size_t colsA, size_t actualRowsA
    , size_t rowsB, size_t colsB, size_t actualRowsB
    , TransposeMode mode = TransposeMode::None >
void solve(matrix_view<T, rowsA, colsA, actualRowsA> A, matrix_view<T, rowsB, colsB, actualRowsB> B)
{
    static_assert(rowsB >= rowsA && rowsB >= colsA, "b is too small");
    char transMode = mode == TransposeMode::None ? 'N' : 'T';
    // LDA = rowsA, LDB = rowsB
    if constexpr (::std::is_same_v<T, float>) {
      fgels(transMode, rowsA, colsA, colsB, A.data(), actualRowsA, B.data(), actualRowsB);
    } else if constexpr (::std::is_same_v<T, double>) {
      dgels(transMode, rowsA, colsA, colsB, A.data(), actualRowsA, B.data(), actualRowsB);
    // DGELS(, ....);
    } else {
    static_assert(always_false_v<T>, "Unknown type");
    }
}

使用示例：

int main() {
  matrix<float, 5, 5> A;
  matrix<float, 4, 1> b;

  auto viewA = matrix_view{A}.submat<1, 1, 4, 4>();
  auto viewb = matrix_view{b};
  solve(viewA, viewb);
  // solve(viewA, viewb.submat<1, 0, 2, 1>()); // Error: b is too small
  // solve(matrix_view{A}, viewb.submat<0, 0, 5, 1>()); // Error: can only shrink (b is 4x1 and can not be viewed as 5x1)
}

模板函数重载和SFINAE实现

最小的完整和有效的例子

3 个答案: