Capacity

产品支持情况

• Ascend 950PR/Ascend 950DT：支持

• Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持

• Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持

• Atlas 200I/500 A2 推理产品：不支持

• Atlas 推理系列产品AI Core：不支持

• Atlas 推理系列产品Vector Core：不支持

• Atlas 训练系列产品：不支持

功能说明

需要包含的头文件为：#include "tensor_api/tensor.h"。

Capacity用于计算Layout所需的实际内存容量。

与Size（有效元素个数）不同，Capacity包含了因非连续步长导致的无效数据区域。对于连续排列（stride紧凑），Capacity与Size相等；对于有间隔的排列，Capacity通常大于Size。

函数原型

C++

template <size_t... Is, typename Shape, typename Stride>
__aicore__ inline constexpr auto Capacity(const Layout<Shape, Stride>& layout)

参数说明

表1 模板参数说明

参数名	类型	描述
Shape	输入	组成Layout的shape的类型，即元组（tuple）类型。
Stride	输入	组成Layout的stride的类型，即元组（tuple）类型。
Is...	size_t	索引序列，指定子维度范围，仅对选定维度计算容量。

表2 参数说明

参数名	类型	描述
layout	输入	用于描述张量的布局。

返回值说明

返回Layout实际所占面积大小，包括有效数据和脏数据。

约束说明

Is...必须为有效范围内的索引。

调用示例

C++

using namespace AscendC::Te;

// 示例1：紧凑排列，Capacity = Size
auto layout1 = MakeLayout(MakeShape(10, 20), MakeStride(20, 1));
auto cap1 = Capacity(layout1);
// dim0: 10 * 20 = 200; dim1: 20 * 1 = 20; max = 200
// Size = 10 * 20 = 200

// 示例2：非连续排列，Capacity > Size
auto layout2 = MakeLayout(MakeShape(10, 20), MakeStride(1, 100));
auto cap2 = Capacity(layout2);
// dim0: 10 * 1 = 10; dim1: 20 * 100 = 2000; max = 2000
// Size = 10 * 20 = 200

// 示例3：指定子维度
auto layout3 = MakeLayout(MakeShape(10, 20, 30), MakeStride(1, 10, 200));
auto cap3All = Capacity(layout3);       // max(10*1, 20*10, 30*200) = max(10, 200, 6000) = 6000
auto cap3_0_1 = Capacity<0, 1>(layout3); // max(10*1, 20*10) = max(10, 200) = 200