docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
38
docs/api/containers/hashmap/insert.md
Normal file
38
docs/api/containers/hashmap/insert.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# HashMap::Insert
|
||||
|
||||
```cpp
|
||||
bool Insert(const Key& key, const Value& value);
|
||||
bool Insert(const Key& key, Value&& value);
|
||||
bool Insert(Pair&& pair);
|
||||
```
|
||||
|
||||
插入键值对。如果键已存在,则更新其值并返回 `false`;否则插入新元素并返回 `true`。
|
||||
|
||||
**参数:**
|
||||
- `key` - 要插入的键
|
||||
- `value` - 要插入的值(const 版本为拷贝,&& 版本为移动)
|
||||
- `pair` - 包含键值对的 `Pair` 结构(右值)
|
||||
|
||||
**返回:** 如果插入成功(键不存在)返回 `true`,如果键已存在(更新值)返回 `false`。
|
||||
|
||||
**复杂度:** O(1) 平均,最坏 O(n)(包括可能的 rehash)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
XCEngine::Containers::HashMap<int, std::string> map;
|
||||
|
||||
bool inserted1 = map.Insert(1, "one"); // 返回 true
|
||||
bool inserted2 = map.Insert(1, "ONE"); // 返回 false,更新现有值
|
||||
|
||||
bool inserted3 = map.Insert(2, std::string("two")); // 移动语义版本
|
||||
|
||||
XCEngine::Containers::HashMap<int, std::string>::Pair p{3, "three"};
|
||||
bool inserted4 = map.Insert(std::move(p)); // Pair 移动版本
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [HashMap 总览](hashmap.md) - 返回类总览
|
||||
- [operator[]](./operator-subscript.md) - 下标访问(总是插入)
|
||||
- [Erase](erase.md) - 删除键对应的元素
|
||||
Reference in New Issue
Block a user