在 API 中处理复杂的嵌套类型

Question

所以我们假设有一个与图像处理相关的项目。我们有一个算法可以计算两个图像之间的“分数”（不管它是什么），所以：

double score(Image i1, Image i2)

如果我们有多个帧（图像），我们要为所有帧（图像匹配）计算它：

std::vector<std::pair<std::pair<int, int>, double>> score(std::vector<Image> images); // [1]

（int 对表示图像向量中的图像索引，因为我们将所有匹配到所有）

不幸的是，我们从许多设备中获取图像，其中每个设备都可以有多个流（然后每个流中有多个连续的帧），这使得这个级别变得复杂：

std::vector<std::vector<std::vector<std::pair<std::pair<int, int>, double>>>>
     ^devices    ^streams    ^frames     ^score   ^image indices

您将如何处理必须返回如此复杂类型的函数？

只是将它包装在 typedef 中并正确命名？或者，也许您只会让用户使用更简单的 API 版本，即使用一个向量 [1] 并进一步自行包装？或者这种情况有什么花哨的模式吗？

Answer 1

在不了解数据的情况下，一种选择是创建结构或类来包装各个部分：

namespace your_company {
struct index {
    std::pair<int, int> indexes;
};
struct frame {
    std::pair<index, double> scores;
};
struct stream {
    std::vector<frame> frames;
};
struct device {
    std::vector<stream> streams;
};
}

如果需要，您甚至可以向结构添加更多信息。如：

struct device {
    std::vector<stream> streams;
    std::string name;
};

那么你的函数将返回一个device。用户代码可能如下所示：

your_company::device d = your_function();
d.streams[0].frames[0].scores[0].pair[0].....

Answer 2

一般来说，您通过给事物起正确的名称来处理复杂性。

当我在[1] 中看到您的 API 时，我看到了一个图形，其中图像是图形的节点，您将边作为邻接列表返回。邻接信息也可以以对称邻接矩阵的形式存储。为您的问题使用适当的术语可能使您可以访问大量工具，例如像 Boost.Graph 这样的库。它可能是您编写自己的可重用组件的起点。您甚至可能会发现人们处理了您试图解决的问题，但使用更抽象的术语。

这只是一种选择，当您考虑正确命名事物时，就会发生奇妙的事情。

关于复杂性的第二次跳跃，我认为可能由调用者决定他们想要输入算法的块的大小，因为这似乎人为地限制了函数的用例.如果你认为情况并非如此，你还是应该给事物起正确的名字。您可以为此使用结构和类，这可能是一个很差的选择：

using AdjacencyList = std::vector<std::pair<std::pair<int, int>, double>;
// Info that might also be represented as a matrix or symmetric matrix.

class SimilarityData
{
    public:
        const AdjacencyList &
        getAdjacencyList(
            int device,
            int stream,
            int frame ) const;
};