UE4 C++：TSet容器

目录

概述

创建

添加

Add：

Emplace：代替Add，避免插入集合时创建临时文件

Append：进行合并来插入另一个集合中的所有元素

迭代

查询

Num：查询集合中保存的元素数量

Contains：查询是否包含特定元素

FSetElementId：结构体可查找集合中某个键的索引。然后，就可使用该索引与 运算符[] 查找元素

移除

Remove 函数可按索引移除元素

Empty 或 Reset 函数可将集合中的所有元素移除

排序

运算符

Slack

DefaultKeyFuncs

---

概述

• TSet是一种快速容器类，（通常）用于在排序不重要的情况下存储唯一元素。
• TSet 类似于 TMap 和 TMultiMap，但有一个重要区别：TSet 是通过对元素求值的可覆盖函数，使用数据值本身作为键，而不是将数据值与独立的键相关联。
• TSet 可以非常快速地添加、查找和删除元素（恒定时间）。默认情况下，TSet 不支持重复的键，但使用模板参数可激活此行为。
• TSet 也是值类型，支持常规复制、赋值和析构函数操作，以及其元素较强的所有权。TSet 被销毁时，其元素也将被销毁。键类型也必须是值类型。
• TSet 会直接使用 运算符== 比较元素，使用 GetTypeHash 对其进行散列，然后使用标准的堆分配器

创建

TSet<FString> FruitSet; //尚未分配内存

添加

Add：

• 如果尝试添加重复键，会替代了旧的条目

FruitSet.Add(TEXT("Banana"));
FruitSet.Add(TEXT("Grapefruit"));
FruitSet.Add(TEXT("Pineapple"));
// FruitSet == [ "Banana", "Grapefruit", "Pineapple" ]

FruitSet.Add(TEXT("Pear"));
FruitSet.Add(TEXT("Banana"));
// FruitSet == [ "Banana", "Grapefruit", "Pineapple", "Pear" ]
// Note:Only one banana entry.

此处的元素按插入顺序排列，但不保证这些元素在内存中实际保留此排序。如果是新集合，可能会保留插入排序，但插入和删除的次数越多，新元素不出现在末尾的可能性越大。

Emplace：代替Add，避免插入集合时创建临时文件

FruitSet.Emplace(TEXT("Orange"));
// FruitSet == [ "Banana", "Grapefruit", "Pineapple", "Pear", "Orange" ]

Append：进行合并来插入另一个集合中的所有元素

• 集合中的重复键将会替代目标集合中相应的键

TSet<FString> FruitSet2;
FruitSet2.Emplace(TEXT("Kiwi"));
FruitSet2.Emplace(TEXT("Melon"));
FruitSet2.Emplace(TEXT("Mango"));
FruitSet2.Emplace(TEXT("Orange"));
FruitSet.Append(FruitSet2);
// FruitSet == [ "Banana", "Grapefruit", "Pineapple", "Pear", "Orange", "Kiwi", "Melon", "Mango" ]

迭代

范围for

for (auto& Elem :FruitSet)
{
    FPlatformMisc::LocalPrint( *FString::Printf(TEXT(" \"%s\"\n"), *Elem ));
}
// 依次输出 "Banana" "Grapefruit" "Pineapple" "Pear" "Orange" "Kiwi" "Melon" "Mango"

迭代器

• CreateIterator 返回拥有读写访问权限的迭代器，
• reateConstIterator 返回拥有只读访问权限的迭代器

for (auto It = FruitSet.CreateConstIterator(); It; ++It)
{
    FPlatformMisc::LocalPrint( *FString::Printf(TEXT("(%s)\n"), *It ) );
}

查询

Num：查询集合中保存的元素数量

int32 Count = FruitSet.Num(); // Count == 8

Contains：查询是否包含特定元素

bool bHasBanana = FruitSet.Contains(TEXT("Banana")); // bHasBanana == true
bool bHasLemon = FruitSet.Contains(TEXT("Lemon"));   // bHasLemon == false

FSetElementId：结构体可查找集合中某个键的索引。然后，就可使用该索引与 运算符[] 查找元素

在非常量集合上调用 operator[] 将返回非常量引用，而在常量集合上调用将返回常量引用

FSetElementId BananaIndex = FruitSet.Index(TEXT("Banana"));
// BananaIndex is a value between 0 and (FruitSet.Num() - 1)
FPlatformMisc::LocalPrint( *FString::Printf( TEXT(" \"%s\"\n"), *FruitSet[BananaIndex] ));
// Prints "Banana"

FSetElementId LemonIndex = FruitSet.Index(TEXT("Lemon"));
// LemonIndex is INDEX_NONE (-1)
FPlatformMisc::LocalPrint( *FString::Printf(TEXT(" \"%s\"\n"), *FruitSet[LemonIndex] ));
// Assert!

Find：返回指向元素数值的指针

• 如果映射不包含该键，则返回null。
• 对常量集合调用Find，返回的指针也将为常量

FString* PtrBanana = FruitSet.Find(TEXT("Banana")); // *PtrBanana == "Banana"
FString* PtrLemon = FruitSet.Find(TEXT("Lemon"));   //  PtrLemon == nullptr

Array：会返回一个 TArray，其中填充了 TSet 中每个元素的一份副本

• 被传递的数组在填入前会被清空，因此元素的生成数量将始终等于集合中的元素数量

TArray<FString> FruitArray = FruitSet.Array();
// FruitArray == [ "Banana","Grapefruit","Pineapple","Pear","Orange","Kiwi","Melon","Mango" ] (order may vary)

移除

Remove 函数可按索引移除元素

FruitSet.Remove(0);
// FruitSet == [ "Grapefruit","Pineapple","Pear","Orange","Kiwi","Melon","Mango" ]

int32 RemovedamountPineapple = FruitSet.Remove(TEXT("Pineapple"));
// RemovedamountPineapple == 1
// FruitSet == [ "Grapefruit","Pear","Orange","Kiwi","Melon","Mango" ]
int32 RemovedamountLemon = FruitSet.Remove(TEXT("Lemon"));
// RemovedamountLemon == 0

• 仅建议在通过元素迭代时使用：Remove函数会返回已删除元素的数量。如果给定的键未包含在集合中，则会返回0。
• 如果 TSet 支持重复的键，Remove 将移除所有匹配元素。
• 移除元素将在数据结构中留下空

Empty 或 Reset 函数可将集合中的所有元素移除

TSet<FString> FruitSetcopy = FruitSet;
// FruitSetcopy == [ "Grapefruit","Pear","Orange","Kiwi","Melon","Mango" ]

FruitSetcopy.Empty();
// FruitSetcopy == []

• Empty 可采用参数指示集合中保留的slack量，而 Reset 则是尽可能多地留出slack量

排序

TSet 可以排序。排序后，迭代集合会以排序的顺序显示元素，但下次修改集合时，排序可能会发生变化。由于排序不稳定，可能按任何顺序显示集合中支持重复键的等效元素。

• Sort 函数指定排序顺序的二进制谓词

FruitSet.sort([](const FString& A, const FString& B) {
    return A > B; // sort by reverse-alphabetical order
});
// FruitSet == [ "Pear", "Orange", "Melon", "Mango", "Kiwi", "Grapefruit" ] (order is temporarily guaranteed)

FruitSet.sort([](const FString& A, const FString& B) {
    return A.Len() < B.Len(); // sort strings by length, shortest to longest
});
// FruitSet == [ "Pear", "Kiwi", "Melon", "Mango", "Orange", "Grapefruit" ] (order is temporarily guaranteed)

运算符

TSet<FString> NewSet = FruitSet;
NewSet.Add(TEXT("Apple"));
NewSet.Remove(TEXT("Pear"));
// FruitSet == [ "Pear", "Kiwi", "Melon", "Mango", "Orange", "Grapefruit" ]
// NewSet == [ "Kiwi", "Melon", "Mango", "Orange", "Grapefruit", "Apple" ]

Slack

DefaultKeyFuncs

参考链接:

【UE4 C++ 基础知识】<7> 容器——TSet - 砥才人 - 博客园 (cnblogs.com)

虚幻引擎中的Set容器 | 虚幻引擎5.0文档 (unrealengine.com)