narust-158 0.3.1

A Rust reimplementation of OpenNARS 1.5.8
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
//! 🎯复刻OpenNARS `nars.entity.Bag`

use super::{BagItemTable, BagNameTable, Distribute, Distributor, NameValue};
use crate::{
    entity::{Item, MergeOrder, ShortFloat},
    global::Float,
    inference::{Budget, BudgetFunctions, BudgetInference},
    parameters::{Parameters, DEFAULT_PARAMETERS},
    util::ToDisplayAndBrief,
};
use serde::{Deserialize, Serialize};

// ! 删除「具体类型」特征:能直接`struct`就直接`struct`

/// 对应OpenNARS的「袋」
/// * 📝【2024-04-26 23:12:15】核心逻辑:通过称作「预算」的机制,经济地分配内部元素
///   * 📌原理:AIKR
/// * 💭【2024-04-26 23:12:47】实际上「袋」并不需要元素基于「预算」
///   * 📌「预算」本质上不属于「元素」而是「元素×袋=预算」的概念
///   * 🚩换句话说,即:元素在袋内才具有的预算,有「预算映射」`(&袋, &元素id) -> Option<&预算>`
///   * 📌另外,「元素索引」作为元素在「袋」中的唯一标识符,有「元素映射」`(&袋, &元素id) -> Option<&元素>`
///     * 📌用于反查,还有「反查映射」`(&袋, &元素) -> Option<&元素id>`
///   * 🚩【2024-04-28 08:36:04】仍然需要:「元素」和「元素」之间,可能仍然需要访问各自的「预算」
///     * 📄在作为「元素」的「概念」中,需要访问「任务」的「预算」——此举不依赖「袋」对象
///     * 🎯减少迁移压力
/// * 🚩【2024-05-01 23:17:26】暂且按照OpenNARS的命名来:
///   * 📌因为直接使用`Item`而非`BagItem`,故相应地改其中的`Item`为`E`
///   * 📝此中之`E`其实亦代表「Entity」(首字母)
/// * 🚩【2024-06-22 15:19:14】目前基于OpenNARS改版,将特征窄化为具体结构,以简化代码
///
/// * ✅【2024-05-04 16:38:16】初步完成设计与测试

/// 复刻 `nars.storage.bag`
///
/// # 📄OpenNARS
/// A Bag is a storage with a constant capacity and maintains an internal
/// priority distribution for retrieval.
///
/// Each entity in a bag must extend Item, which has a BudgetValue and a key.
///
/// A name table is used to merge duplicate items that have the same key.
///
/// The bag space is divided by a threshold, above which is mainly time
/// management, and below, space management.
///
/// Differences:
///
/// 1. level selection vs. item selection
/// 2. decay rate
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Bag<E: Item> {
    /// 🆕分派器
    /// * 🚩不再作为全局变量,而是在构造函数中附带
    /// * 📝OpenNARS中主要用到的操作
    ///   * 创建 `new`
    ///   * 取(随机值) `pick`
    ///   * 下一个(随机值) `next`
    ///
    /// # OpenNARS `Bag.DISTRIBUTOR`
    ///
    /// shared DISTRIBUTOR that produce the probability distribution
    distributor: Distributor,

    /// 元素映射
    /// * 📝OpenNARS中主要用到的操作
    ///   * 创建 `new`
    ///   * 获取尺寸 `size`
    ///   * 检查是否包含(值) `containsValue`
    ///   * 从键获取值 `get`
    ///   * 插入值 `put`
    ///   * 从键移除值 `remove`
    ///   * 判断是否为空 `isEmpty`
    ///
    /// # 📄OpenNARS
    ///
    /// `mapping from key to item`
    item_map: BagNameTable<E>,

    /// 层级映射
    /// * 📝OpenNARS中主要用到的操作
    ///   * 创建 `new`
    ///   * 添加(到末尾) `add`
    ///   * 获取(在指定层级) `get`
    ///   * 获取指定层级是否为空 `get(n).isEmpty`
    ///   * 在指定层级增加 `get(n).add`
    ///   * 获取指定层级第一个 `get(n).getFirst`
    ///   * 移除指定层级第一个 `get(n).removeFirst`
    ///   * 移除指定层级某元素 `get(n).remove`
    /// * 📌【2024-04-27 14:13:36】目前对外层用[`Vec`],内层用[`VecDeque`]
    ///   * 📌并且,仅存储键,避免复制与额外引用
    ///
    /// # 📄OpenNARS
    ///
    /// array of lists of items, for items on different level
    level_map: BagItemTable,

    /// 🆕所有「袋参数」
    /// * 🎯存储「袋」的所有「参数变量」
    ///   * 📌往往在构造后不再修改
    #[serde(flatten)]
    parameters: BagParameters,

    /// 🆕所有「状态变量」
    /// * 🎯存储「袋」在「状态指示」「取出元素」时需要 暂存/缓存 的变量
    /// * 📝【2024-09-02 16:17:03】通过serde的「结构体展平」兼容先前序列反序列化布局
    ///   * 🔗<https://serde.rs/attr-flatten.html>
    #[serde(flatten)]
    status: BagStatus,
}

/// 有关「袋」的参数
/// * 🎯分离出「袋」的「参数变量」
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
struct BagParameters {
    /// 袋容量
    /// * 📌在不同地方有不同的定义
    /// * 📝参数属性:是一个「构造后固定」的属性
    ///
    /// # 📄OpenNARS
    ///
    /// - defined in different bags
    /// - To get the capacity of the concrete subclass
    ///
    /// @return Bag capacity, in number of Items allowed
    capacity: usize,

    /// 遗忘速率
    /// * 📌在不同地方有不同的定义
    /// * 📝参数属性:是一个「构造后固定」的属性
    /// * 📝OpenNARS用于[`Bag::put_back`]的「放回时遗忘」中
    ///
    /// # 📄OpenNARS
    ///
    /// Get the item decay rate, which differs in difference subclass, and can be
    /// changed in run time by the user, so not a constant.
    ///
    /// @return The number of times for a decay factor to be fully applied
    forget_rate: usize,

    /// 模拟`Bag.TOTAL_LEVEL`
    /// *📌总层数
    /// * 🚩【2024-05-04 01:44:29】根据OpenNARS中「常量」的定义,在此将其全局化
    ///   * 📌`static final` ⇒ `const`
    ///
    /// # 📄OpenNARS
    ///
    /// priority levels
    #[serde(default = "default::total_level")]
    total_level: usize,

    /// 模拟`Bag.THRESHOLD`
    /// * 📌触发阈值
    /// * 📝触发の阈值
    ///
    /// # 📄OpenNARS
    ///
    /// firing threshold
    #[serde(default = "default::threshold")]
    threshold: usize,

    /// 模拟`Bag.RELATIVE_THRESHOLD`
    /// 相对阈值
    /// * 🚩由`触发阈值 / 总层数`计算得来
    ///
    /// # 📄OpenNARS
    ///
    /// relative threshold, only calculate once
    #[serde(default = "default::relative_threshold")]
    relative_threshold: Float,

    /// 模拟`Bag.LOAD_FACTOR`
    /// * 📌加载因子
    /// * ❓尚不清楚其含义
    ///
    /// # 📄OpenNARS
    ///
    /// hash table load factor
    #[serde(default = "default::load_factor")]
    load_factor: Float,
}

/// 所有「默认超参数」的函数
mod default {
    use super::BagParameters;
    use crate::{global::Float, parameters::DEFAULT_PARAMETERS};

    /// 📜为缺省字段提供默认值
    /// * 🎯兼容旧版本中无此字段的[`Bag`]
    pub const fn total_level() -> usize {
        DEFAULT_PARAMETERS.bag_level
    }

    /// 📜为缺省字段提供默认值
    /// * 🎯兼容旧版本中无此字段的[`Bag`]
    pub const fn threshold() -> usize {
        DEFAULT_PARAMETERS.bag_threshold
    }

    /// 📜为缺省字段提供默认值
    /// * 🎯兼容旧版本中无此字段的[`Bag`]
    ///
    /// ! ❌【2024-09-02 16:51:01】无法变为常量函数:常量函数中不允许浮点计算
    pub fn relative_threshold() -> Float {
        const TOTAL_LEVEL: usize = total_level();
        const THRESHOLD: usize = threshold();
        BagParameters::calculate_relative_threshold(TOTAL_LEVEL, THRESHOLD)
    }

    /// 📜为缺省字段提供默认值
    /// * 🎯兼容旧版本中无此字段的[`Bag`]
    pub const fn load_factor() -> Float {
        DEFAULT_PARAMETERS.load_factor
    }
}

impl BagParameters {
    /// 根据「总层级」与「触发阈值」计算「相对阈值」
    ///
    /// ! ❌【2024-09-02 16:51:01】无法变为常量函数:常量函数中不允许浮点计算
    fn calculate_relative_threshold(total_level: usize, threshold: usize) -> Float {
        threshold as Float / total_level as Float
    }

    /// 从全局的「超参数」中生成「袋参数」
    /// * 🎯解耦硬编码的「默认超参数」
    fn from_parameters(capacity: usize, forget_rate: usize, parameters: &Parameters) -> Self {
        // 提取所需参数
        let &Parameters {
            bag_level: total_level,
            bag_threshold: threshold,
            load_factor,
            ..
        } = parameters;
        // 计算附加参数
        let relative_threshold = Self::calculate_relative_threshold(total_level, threshold);
        // 初始化参数
        Self {
            capacity,
            forget_rate,
            total_level,
            threshold,
            relative_threshold,
            load_factor,
        }
    }
}

/// 有关「袋」的状态
/// * 🎯分离出「常修改的部分」与「不常修改的部分」
/// * 📌【2024-09-02 15:52:18】基本用于存储基础类型数据
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
struct BagStatus {
    /// 质量
    /// * 📝状态变量:袋内所有物品所在层级的和
    ///
    /// # 📄OpenNARS
    ///
    /// current sum of occupied level
    mass: usize,

    /// 层级索引
    /// * 📝状态变量:当前层级的索引
    ///   * 📄参考:[「概率随机性选取物品」](Self::select_next_level_for_take)
    ///
    /// # 📄OpenNARS
    ///
    /// index to get next level, kept in individual objects
    level_index: usize,

    /// 当前层级
    /// * 📝状态变量:当前选中的层级
    ///   * 📄参考:[「概率随机性选取物品」](Self::select_next_level_for_take)
    ///
    /// # 📄OpenNARS
    ///
    /// current take out level
    current_level: usize,

    /// 当前计数器
    /// * 📝状态变量:当前所选中之链接的计数器
    ///   * 📄参考:[「概率随机性选取物品」](Self::select_next_level_for_take)
    ///
    /// # 📄OpenNARS
    ///
    /// maximum number of items to be taken out at current level
    current_counter: usize,
}

// impl<E: Item> BagConcrete<E> for Bag<E> {
impl<E: Item> Bag<E> {
    /// 结合传入的「超参数」构建
    pub fn from_parameters(capacity: usize, forget_rate: usize, parameters: &Parameters) -> Self {
        Self::with_parameters(BagParameters::from_parameters(
            capacity,
            forget_rate,
            parameters,
        ))
    }

    /// 兼容旧有构造函数
    pub fn new(capacity: usize, forget_rate: usize) -> Self {
        let parameters = BagParameters::from_parameters(capacity, forget_rate, &DEFAULT_PARAMETERS);
        Self::with_parameters(parameters)
    }

    /// 与「袋超参数」一同构建
    fn with_parameters(parameters: BagParameters) -> Self {
        /* 📄OpenNARS源码:
        self.memory = memory;
        capacity = capacity();
        init(); */
        // 构造
        let mut this = Self {
            // 后续都是「内部状态变量」
            distributor: Distributor::new(parameters.total_level),
            // ? ❓【2024-05-04 12:32:58】因为上边这个不支持[`Default`],所以就要写这些模板代码吗?
            // * 💭以及,这个`new`究竟要不要照抄OpenNARS的「先创建全空属性⇒再全部init初始化」特性
            //   * 毕竟Rust没有`null`要担心
            item_map: BagNameTable::default(),
            level_map: BagItemTable::default(),
            status: BagStatus::default(),
            // 参数变量
            // * 🚩【2024-09-02 16:43:31】最后再初始化:内部有字段要在初始化之前用
            parameters,
        };
        this.init();
        this
    }
}

/// 对「以字符串为索引的袋」实现特征
/// * 🚩【2024-05-04 12:01:15】下面这些就是给出自己的属性,即「属性映射」
// impl<E: Item> Bagging<E> for Bag<E> {
impl<E: Item> Bag<E> {
    // * ↑此处`Item`泛型仿OpenNARS`Bag`

    /// 模拟`Bag.capacity`
    /// * 📌一个「袋」的「容量」
    /// * 🚩只读
    ///   * 📄`private final int capacity;`
    /// * 📝OpenNARS中作为「属性」定义,仅仅是为了「缓存数值」并「在子类中分派不同的『大小』作为常数返回值」用
    ///   * 🚩因此无需附带`setter`
    /// * 💭【2024-05-04 01:48:01】实际上可以被定义为「关联常量」
    ///
    /// # 📄OpenNARS
    ///
    /// * 【作为属性】defined in different bags
    /// * 【作为方法】To get the capacity of the concrete subclass
    ///   * @return Bag capacity, in number of Items allowed
    pub fn capacity(&self) -> usize {
        self.parameters.capacity
    }

    /// 模拟`Bag.mass`
    /// * 📌一个「袋」已有元素的层数
    /// * 🚩会随着「增删元素」而变
    ///   * 🚩故需要一个「可变」版本
    ///   * 📝Rust允许`*self.__mass_mut() = XXX`的语法:左值可以是表达式
    ///
    /// # 📄OpenNARS
    ///
    /// current sum of occupied level
    fn mass(&self) -> usize {
        self.status.mass
    }

    /// 模拟`Bag.init`
    /// * 🚩初始化「元素映射」「层级映射」
    ///   * 📄对应[`Self::__name_table`]、[`Self::__item_table`]
    ///
    /// # 📄OpenNARS
    ///
    /// 🈚
    pub fn init(&mut self) {
        /* itemTable = new ArrayList<>(TOTAL_LEVEL);
        for (int i = 0; i < TOTAL_LEVEL; i++) {
            itemTable.add(new LinkedList<E>());
        }
        nameTable = new HashMap<>((int) (capacity / LOAD_FACTOR), LOAD_FACTOR);
        currentLevel = TOTAL_LEVEL - 1;
        levelIndex = capacity % TOTAL_LEVEL; // so that different bags start at different point
        mass = 0;
        currentCounter = 0; */
        self.level_map = BagItemTable::new(self.parameters.total_level);
        for level in 0..self.parameters.total_level {
            self.level_map.add_new(level);
        }
        self.item_map = BagNameTable::new();
        // 状态初始化
        self.status = BagStatus {
            current_level: self.parameters.total_level - 1,
            level_index: self.capacity() % self.parameters.total_level, // 不同的「袋」在分派器中有不同的起点
            mass: 0,
            current_counter: 0,
        }; // * 📌【2024-09-02 15:45:01】此处直接用新结构体覆盖,可由此检查穷尽性
    }

    // ! 🚩`Bag.capacity`已在`self.__capacity`中实现

    /// 模拟`Bag.size`
    /// * 🎯从模拟`Bag.nameTable`派生
    /// * 🚩转发内部`name_table`成员
    ///
    /// # 📄OpenNARS
    ///
    /// The number of items in the bag
    #[inline(always)]
    pub fn size(&self) -> usize {
        self.item_map.size()
    }

    /// 模拟`Bag.averagePriority`
    ///
    /// # 📄OpenNARS
    ///
    /// Get the average priority of Items
    ///
    /// @return The average priority of Items in the bag
    pub fn average_priority(&self) -> Float {
        /* 📄OpenNARS源码:
        if (size() == 0) {
            return 0.01f;
        }
        float f = (float) mass / (size() * TOTAL_LEVEL);
        if (f > 1) {
            return 1.0f;
        }
        return f; */
        if self.size() == 0 {
            return 0.01;
        }
        Float::min(
            // 复刻最后一个条件判断
            (self.mass() as Float) / (self.size() * self.parameters.total_level) as Float,
            1.0,
        )
    }

    /// 🆕迭代内部所有元素
    pub fn iter(&self) -> impl Iterator<Item = &E> {
        self.item_map.iter_items()
    }

    /// 🆕迭代内部所有元素(可变)
    /// * 🎯用于「序列反序列化」「归一化任务共享引用」
    /// * ⚠️慎用
    pub(crate) fn iter_mut(&mut self) -> impl Iterator<Item = &mut E> {
        self.item_map.iter_items_mut()
    }

    /// 模拟`Bag.contains`
    /// * 🎯从模拟`Bag.nameTable.containsValue`派生
    /// * 📜默认使用[`Self::get`]
    ///
    /// # 📄OpenNARS
    ///
    /// Check if the bag contains the item
    ///
    /// @param item The item to be checked
    /// @return Whether the bag contains the item
    #[inline(always)]
    pub fn contains(&self, item: &E) -> bool {
        self.get(item.key()).is_some()
    }

    /// 模拟`Bag.get`
    /// * 🚩转发内部`name_table`成员
    ///
    /// # 📄OpenNARS
    ///
    /// Get an Item by key
    ///
    /// @param key The key of the Item
    /// @return The Item with the given key
    #[inline(always)]
    #[must_use]
    pub fn get(&self, key: &str) -> Option<&E> {
        self.item_map.get(key).map(|(e, _)| e)
    }
    /// [`Self::get`]的可变版本
    /// * 🎯【2024-04-28 09:08:14】备用
    /// * 🚩转发内部`name_table`成员
    #[inline(always)]
    #[must_use]
    pub fn get_mut(&mut self, key: &str) -> Option<&mut E> {
        self.item_map.get_mut(key).map(|(e, _)| e)
    }

    /// 🆕提供「元素id是否对应值」的功能
    /// * 🎯【2024-05-07 22:19:07】在「记忆区」查找时,为规避「直接带Concept [`Option`]」带来的借用问题,采用「只查询是否有」的方式
    pub fn has(&self, key: &str) -> bool {
        self.item_map.has(key)
    }

    /// 模拟`Bag.putIn`
    /// * 🚩过程「放入」
    /// * 🆕不通过「返回布尔值」验证「是否添加成功」,而是通过「返回一个[`Option`]」表示「添加成功与否」
    ///   * 📌此举虽总是「消耗」,但若需要复用「添加失败时的元素」仍可从返回值中拿取
    /// * 🔗链接到的方法
    ///   * [`intoBase`](Self::into_base)
    ///   * [`outOfBase`](Self::out_of_base)
    ///   * [`BudgetValue.merge`](BudgetValue::merge)
    ///
    /// 📄OpenNARS `Bag.putIn`
    ///
    /// Add a new Item into the Bag
    ///
    /// @param newItem The new Item
    /// @return Whether the new Item is added into the Bag
    #[must_use]
    pub fn put_in(&mut self, new_item: E) -> Option<E> {
        /* String newKey = newItem.getKey();
        E oldItem = nameTable.put(newKey, newItem);
        if (oldItem != null) { // merge duplications
            outOfBase(oldItem);
            newItem.merge(oldItem);
        }
        E overflowItem = intoBase(newItem); // put the (new or merged) item into itemTable
        if (overflowItem != null) { // remove overflow
            String overflowKey = overflowItem.getKey();
            nameTable.remove(overflowKey);
            return (overflowItem != newItem);
        } else {
            return true;
        } */
        self.assert_valid();

        // 置入「元素映射」
        let new_key = new_item.key().clone();
        let level = self.calculate_level_for_item(&new_item);
        let old_item = self.item_map.put(&new_key, new_item, level);

        // 若在「元素映射」中重复了:有旧项⇒合并「重复了的新旧项」
        if let Some(old) = old_item {
            // * 在「层级映射」移除旧项 | 🚩【2024-05-04 11:45:02】现在仍需使用「元素」,因为下层调用需要访问元素本身(预算值),并需避免过多的「按键取值」过程
            self.item_out_of_base(&old);
            let (mut old_item, _) = old;

            // * 🚩计算「合并顺序」
            let new_item = self.get(&new_key).unwrap(); // * 🚩🆕重新获取「置入后的新项」(⚠️一定有)
            let merge_order = old_item.merge_order(new_item); // 此处调用函数指针,一定是不可变引用
            let new_item = self.get_mut(&new_key).unwrap(); // * 🚩🆕重新获取「置入后的新项」(⚠️一定有)

            // * 🚩按照计算出的「合并顺序」合并预算值
            use MergeOrder::*;
            match merge_order {
                OldToNew => new_item.merge_from(&old_item),
                NewToOld => old_item.merge_from(new_item),
            }
        }

        // 置入「层级映射」
        // 若在「层级映射」中溢出了:若有「溢出」则在「元素映射」中移除
        // ! 📌【2024-05-04 11:35:45】↓此处`__into_base`仅传入「元素id」是为了规避借用问题(此时`new_item`已失效)
        if let Some(overflow_key) = self.item_into_base(&new_key) {
            // 直接返回「根据『溢出的元素之id』在『元素映射』中移除」的结果
            // * 🚩若与自身相同⇒返回`Some`,添加失败
            // * 🚩若与自身不同⇒返回`None`,添加仍然成功
            let overflow_item = self.item_map.remove_item(&overflow_key);
            self.assert_valid();
            match overflow_key == new_key {
                true => overflow_item,
                false => None, // ! 此时将抛掉溢出的元素
            }
        } else {
            self.assert_valid();
            None
        }
    }

    /// 模拟`Bag.putBack`
    /// * 🚩过程「放回」
    // * 📝【2024-05-04 02:07:06】把「预算函数」的「基建」做好了,这里的事就好办了
    ///
    /// # 📄OpenNARS
    ///
    /// Put an item back into the itemTable
    ///
    /// The only place where the forgetting rate is applied
    ///
    /// @param oldItem The Item to put back
    /// @return Whether the new Item is added into the Bag
    #[must_use]
    pub fn put_back(&mut self, mut old_item: E) -> Option<E> {
        self.assert_valid();
        self.forget(&mut old_item);
        self.put_in(old_item)
    }

    /// 🆕以一定函数修改某个Item的优先级
    /// * 🚩改成泛型函数,以便适用在所有地方
    pub fn forget(&self, item: &mut impl Budget) {
        let new_priority = item.forget(
            self.parameters.forget_rate as Float,
            self.parameters.relative_threshold,
        );
        item.set_priority(ShortFloat::from_float(new_priority));
    }

    /// 模拟`Bag.takeOut`
    /// * 🚩过程「取出」
    /// * 📝实际上需要这些函数作为前置功能:
    ///   * [`_empty_level`](Bag::_empty_level)
    ///   * [`take_out_first`](Bag::take_out_first)
    ///   * [`refresh`](Bag::refresh)
    ///
    /// # 📄OpenNARS
    ///
    /// Choose an Item according to priority distribution and take it out of the
    /// Bag
    ///
    /// @return The selected Item
    #[must_use]
    pub fn take_out(&mut self) -> Option<E> {
        /* 📄OpenNARS源码:
        if (nameTable.isEmpty()) { // empty bag
            return null;
        }
        if (emptyLevel(currentLevel) || (currentCounter == 0)) { // done with the current level
            currentLevel = DISTRIBUTOR.pick(levelIndex);
            levelIndex = DISTRIBUTOR.next(levelIndex);
            while (emptyLevel(currentLevel)) { // look for a non-empty level
                currentLevel = DISTRIBUTOR.pick(levelIndex);
                levelIndex = DISTRIBUTOR.next(levelIndex);
            }
            if (currentLevel < THRESHOLD) { // for dormant levels, take one item
                currentCounter = 1;
            } else { // for active levels, take all current items
                currentCounter = itemTable.get(currentLevel).size();
            }
        }
        E selected = takeOutFirst(currentLevel); // take out the first item in the level
        currentCounter--;
        nameTable.remove(selected.getKey());
        refresh();
        return selected; */
        self.assert_valid();
        if self.item_map.is_empty() {
            return None;
        }
        let level = self.select_next_level_for_take();
        let selected_key = self.take_out_first(level);
        // * 此处需要对内部可能有的「元素id」进行转换
        let selected = selected_key.and_then(|key| self.item_map.remove_item(&key));
        self.assert_valid(); // 在移除元素后检查
        selected
    }

    /// 🆕对整个袋进行「一瞥」
    /// * 🎯在不修改袋结构的情况下,获取下一个要取出的元素
    pub fn peek(&self) -> Option<&String> {
        if self.item_map.is_empty() {
            return None;
        }
        // 只获取下一个层级,不改变当前层级
        let (level, ..) = self.calculate_next_level();
        self.peek_first(level)
    }

    /// 为[`Self::take_out`]选择下一个要被取走的level
    /// * 🚩计算并返回「下一个level值」,并**同时修改自身状态**
    fn select_next_level_for_take(&mut self) -> usize {
        // 直接并行赋值
        (
            self.status.current_level,
            self.status.level_index,
            self.status.current_counter,
        ) = self.calculate_next_level();
        // 新的「当前层级」即为返回值
        self.status.current_level
    }

    /// 🆕根据自身不可变引用,拆分出「计算下一待取层级」的函数
    /// * 📌在计算过程中会修改「当前层级」「层级索引」「当前计数器」等内部状态变量
    ///   * 📝【2024-09-02 15:23:58】目前将这些「内部状态变量」提取出来,以便在不可变上下文中集成
    ///   * 📄不修改自身,只获取不修改的「一瞥」函数
    #[inline]
    fn calculate_next_level(&self) -> (usize, usize, usize) {
        // 获取自身的状态变量
        // * 🎯创建新状态变量,用于后续「计算出新的状态」
        // * ✨可选性赋值:计算出的「新状态变量」可以合并入自身(取出)也可丢弃(一瞥)
        let BagStatus {
            mut current_level,
            mut level_index,
            mut current_counter,
            ..
        } = self.status;
        // 根据这几个状态变量,计算新的状态变量
        // * 🚩此中计算出的新「当前层级」将会作为返回值「下一层级」
        // ! ⚠️此后不访问`self.status`
        if self.empty_level(current_level) || current_counter == 0 {
            current_level = self.distributor.pick(level_index);
            level_index = self.distributor.next(level_index);
            while self.empty_level(current_level) {
                // * 📝这里实际上就是一个do-while
                current_level = self.distributor.pick(level_index);
                level_index = self.distributor.next(level_index);
            }
            current_counter = match current_level < self.parameters.threshold {
                true => 1,
                false => self.level_map.get(current_level).size(),
            };
        }
        current_counter -= 1;
        (current_level, level_index, current_counter)
    }

    /// 模拟`Bag.pickOut`
    /// * 🚩过程「挑出」
    ///
    /// # 📄OpenNARS
    ///
    /// Pick an item by key, then remove it from the bag
    ///
    /// @param key The given key
    /// @return The Item with the key
    #[must_use]
    pub fn pick_out(&mut self, key: &str) -> Option<E> {
        /* 📄OpenNARS源码:
        E picked = nameTable.get(key);
        if (picked != null) {
            outOfBase(picked);
            nameTable.remove(key);
        }
        return picked; */
        let name_value = self.item_map.remove(key)?;
        self.item_out_of_base(&name_value);
        self.assert_valid();
        Some(name_value.0)
    }

    /// 模拟`Bag.emptyLevel`
    ///
    /// # 📄OpenNARS
    ///
    /// Check whether a level is empty
    ///
    /// @param n The level index
    /// @return Whether that level is empty
    pub fn empty_level(&self, level: usize) -> bool {
        /* 📄OpenNARS源码:
        return (itemTable.get(n).isEmpty()); */
        self.level_map.get(level).is_empty()
    }

    /// 模拟`Bag.getLevel`
    /// * 📝Rust中[`usize`]无需考虑负值问题
    /// * 🚩【2024-06-30 17:55:38】现更改计算方法:不能信任物品的「优先级」
    ///   * ⚠️bug:可能物品在袋内变更了优先级,后续拿出时就会mass溢出
    /// * 🆕只在[`Self::item_into_base`]中被调用
    ///
    /// # 📄OpenNARS
    ///
    /// Decide the put-in level according to priority
    ///
    /// @param item The Item to put in
    /// @return The put-in level
    #[doc(alias = "level_from_item")]
    fn calculate_level_for_item(&self, item: &E) -> usize {
        /* 📄OpenNARS源码:
        float fl = item.getPriority() * TOTAL_LEVEL;
        int level = (int) Math.ceil(fl) - 1;
        return (level < 0) ? 0 : level; // cannot be -1 */
        let fl = item.priority().to_float() * self.parameters.total_level as Float;
        let level = (fl.ceil()) as usize; // ! 此处不提前-1,避免溢出
        level.saturating_sub(1) // * 🚩↓相当于如下代码
                                /* if level < 1 {
                                    0
                                } else {
                                    level - 1
                                } */
    }

    /// 模拟`Bag.intoBase`
    /// * 🚩以「元素id」代替「元素自身」在「层级映射」中添加元素
    /// * 🚩若添加成功,将复制「元素id」
    /// * 🚩返回「『溢出』的元素id」
    /// * 🚩【2024-05-01 23:10:46】此处允许【在clippy中被警告】的情形:OpenNARS原装函数
    ///   * ✅【2024-05-04 11:09:39】现在因为「前缀下划线」不再会被警告
    /// * 🚩【2024-05-04 11:13:04】现在仍然使用「元素引用」,因为[`Bag::__get_level`]需要元素的预算值
    /// * 📝【2024-05-04 11:34:43】OpenNARS中只会被[`Bag::put_in`]调用
    /// * 🚩【2024-06-22 16:36:10】改名避嫌
    ///   * ℹ️ clippy: methods called `into_*` usually take `self` by value; consider choosing a less ambiguous name
    ///
    /// # 📄OpenNARS
    ///
    /// Insert an item into the itemTable, and return the overflow
    ///
    /// @param newItem The Item to put in
    /// @return The overflow Item
    fn item_into_base(&mut self, new_key: &str) -> Option<String> {
        /* 📄OpenNARS源码:
        E oldItem = null;
        int inLevel = getLevel(newItem);
        if (size() > capacity) { // the bag is full
            int outLevel = 0;
            while (emptyLevel(outLevel)) {
                outLevel++;
            }
            if (outLevel > inLevel) { // ignore the item and exit
                return newItem;
            } else { // remove an old item in the lowest non-empty level
                oldItem = takeOutFirst(outLevel);
            }
        }
        itemTable.get(inLevel).add(newItem); // FIFO
        mass += (inLevel + 1); // increase total mass
        refresh(); // refresh the window
        return oldItem; */
        let new_item = self.get(new_key).expect("不能没有所要获取的值"); // * 🚩🆕(在调用方处)重新获取「置入后的新项」(⚠️一定有)
        let mut old_item = None;
        let in_level = self.calculate_level_for_item(new_item);

        // 🆕先假设「新元素已被置入」,「先加后减」防止usize溢出
        self.status.mass += in_level + 1;
        if self.size() > self.capacity() {
            // * 📝逻辑:低优先级溢出——从低到高找到「第一个非空层」然后弹出其中第一个(最先的)元素
            // * 🚩【2024-05-04 13:14:02】实际上与Java代码等同;但若直接按源码来做就会越界
            let out_level = (0..self.parameters.total_level)
                .find(|level| !self.empty_level(*level))
                .unwrap_or(self.parameters.total_level);
            if out_level > in_level {
                // 若到了自身所在层⇒弹出自身(相当于「添加失败」)
                self.status.mass -= in_level + 1; // 🆕失败,减去原先相加的数
                return Some(new_key.to_string()); // 提早返回
            } else {
                old_item = self.take_out_first(out_level);
            }
        }
        // 继续增加元素
        self.level_map.get_mut(in_level).add(new_key.to_string());
        // self.refresh(); // ! ❌【2024-05-04 11:16:55】不复刻这个有关「观察者」的方法
        old_item
    }

    /// 🆕对某一层的首个元素进行「一瞥」
    /// * 🎯获取某一层的首个元素
    fn peek_first(&self, level: usize) -> Option<&String> {
        self.level_map.get(level).get_first()
    }

    /// 模拟`Bag.takeOutFirst`
    ///
    /// # 📄OpenNARS
    ///
    /// Take out the first or last E in a level from the itemTable
    ///
    /// @param level The current level
    /// @return The first Item
    fn take_out_first(&mut self, level: usize) -> Option<String> {
        /* 📄OpenNARS源码:
        E selected = itemTable.get(level).getFirst();
        itemTable.get(level).removeFirst();
        mass -= (level + 1);
        refresh();
        return selected; */
        let selected = self.level_map.get(level).get_first().cloned();
        if selected.is_some() {
            // * 🚩仅在「有选择到」时移除 | ✅【2024-05-04 14:31:30】此举修复了「mass溢出」的bug!
            self.level_map.get_mut(level).remove_first();
            self.status.mass -= level + 1;
        }
        selected
    }

    /// 模拟`Bag.outOfBase`
    /// * 🚩【2024-06-22 16:37:07】跟从[`Self::item_into_base`]一同改名
    ///
    /// # 📄OpenNARS
    ///
    /// Remove an item from itemTable, then adjust mass
    ///
    /// @param oldItem The Item to be removed
    fn item_out_of_base(&mut self, (old_item, level): &NameValue<E>) {
        /* 📄OpenNARS源码:
        int level = getLevel(oldItem);
        itemTable.get(level).remove(oldItem);
        mass -= (level + 1);
        refresh(); */
        self.level_map.remove_element(old_item.key());
        self.status.mass -= level + 1;
    }

    fn debug_display(&self) -> String {
        format!(
            "level_map: \n{:?}\n\nitem_map: \n{}\n\nbag: \n{}",
            self.level_map,
            self.item_map.debug_display(),
            self.bag_to_display(),
        )
    }

    /// 总体检查:合法性自检
    /// * 🎯应该仅在调试模式中启用
    fn assert_valid(&self) {
        // 📌仅在「debug断言」时开启
        // * 📝编译时若为否,则会自动内联并丢弃
        if cfg!(debug_assertions) {
            self.assert_count_consistent();
            self.assert_unique_level_map();
        }
    }

    /// 检查其数目一致性
    /// * 🎯检查「物品映射」与「层级映射」元素数目的一致性
    /// * 🚩【2024-07-09 16:40:27】总是内联,以便编译器自动消除死代码
    #[inline(always)]
    fn assert_count_consistent(&self) {
        let l_count = self.level_map.count();
        let n_count = self.size();
        assert_eq!(
            l_count,
            n_count,
            "层级映射与物品映射数目不一致: {l_count} != {n_count}\n{}",
            self.debug_display()
        );
    }

    /// 检查其非重复性
    /// * 🎯检查「层级映射」是否有「添加重复元素」的情形
    /// * 🚩【2024-07-09 16:40:27】总是内联,以便编译器自动消除死代码
    #[inline(always)]
    fn assert_unique_level_map(&self) {
        for (key, _) in self.item_map.iter() {
            debug_assert!(
                1 == self
                    .level_map
                    .iter()
                    .map(|l| l.iter().filter(|k| *k == key).count())
                    .sum::<usize>(),
                "发现重复元素:{key}\nlevel_map: \n{}",
                self.debug_display()
            );
        }
    }

    /// 模拟`Bag.toString`
    /// * 🚩🆕一次显示所有层,避开`showLevel`
    ///
    /// # 📄OpenNARS
    ///
    /// Collect Bag content into a String for display
    ///
    /// @return A String representation of the content
    pub fn bag_to_display(&self) -> String {
        /* 📄OpenNARS源码:
        StringBuffer buf = new StringBuffer(" ");
        for (int i = TOTAL_LEVEL; i >= showLevel; i--) {
            if (!emptyLevel(i - 1)) {
                buf = buf.append("\n --- Level ").append(i).append(":\n ");
                for (int j = 0; j < itemTable.get(i - 1).size(); j++) {
                    buf = buf.append(itemTable.get(i - 1).get(j).toStringBrief()).append("\n ");
                }
            }
        }
        return buf.toString(); */
        let mut buf = String::new();
        // * 🚩倒序遍历所有非空层
        for level in (0..self.parameters.total_level)
            .rev()
            .filter(|&level| !self.empty_level(level))
        {
            buf += "\n --- Level ";
            buf += &level.to_string();
            buf += ":\n ";
            let level_size = self.level_map.get(level).size();
            for i in 0..level_size {
                let key = self.level_map.get(level).get(i);
                if let Some(key) = key {
                    // ! 📌【2024-05-09 01:27:59】应该有
                    if let Some(item) = self.get(key) {
                        buf += &item.to_display_brief();
                        buf += "\n "
                    } else {
                        // ! 异常情况
                        // * 📝【2024-07-09 15:44:51】不应在显示呈现时panic,除非有十分把握
                        buf += "!!!NONE@{key}!!!\n"
                    }
                }
            }
        }
        buf
    }
}

// 显示呈现方法
impl<E: Item> ToDisplayAndBrief for Bag<E> {
    fn to_display(&self) -> String {
        self.bag_to_display()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::global::Float;
    use crate::{
        entity::{BudgetValue, ShortFloat, Token},
        inference::Budget,
        ok,
        util::{AResult, ToDisplayAndBrief},
    };
    use nar_dev_utils::{asserts, list};

    /// [`Item`]的测试用初代实现
    /// * 💭【2024-05-07 20:50:29】实际上并没有用:真正有用的是「任务」「概念」等「实体类」
    type ItemV1 = Token;

    fn new_item(key: impl Into<String>, p: Float, d: Float, q: Float) -> ItemV1 {
        ItemV1::new(key.into(), BudgetValue::from_floats(p, d, q))
    }

    /// 测试用「袋」的类型
    type Item1 = ItemV1;
    type Bag1 = Bag<Item1>;

    /// 测试/单个元素
    /// * 🎯初始化 [`Bag::init`]
    /// * 🎯尺寸 [`Bag::size`]
    /// * 🎯重量 [`Bag::__mass`]
    /// * 🎯获取 [`Bag::get`]
    /// * 🎯获取层级 [`Bag::__get_level`]
    /// * 🎯判空层级 [`Bag::_empty_level`]
    /// * 🎯放入 [`Bag::put_in`]
    /// * 🎯挑出 [`Bag::pick_out`]
    /// * 🎯放回 [`Bag::put_back`]
    /// * 🎯取出 [`Bag::take_out`]
    /// * 🎯一瞥 [`Bag::peek`]
    #[test]
    fn single_item() -> AResult {
        // 构造测试用「袋」
        let mut bag = Bag1::new(1, 1);
        dbg!(&bag);

        // 初始化 // ? 是否应该自带
        bag.init();
        dbg!(&bag);
        asserts! {
            bag.size() == 0, // 空的
            bag.mass() == 0, // 空的
            bag.empty_level(0) => true, // 第0层也是空的
        }

        // 放入元素
        let key1 = "item001";
        let item1 = new_item(key1, 0.0, 0.0, 0.0); // * 🚩固定为「全零预算」
        let overflowed = bag.put_in(dbg!(item1.clone()));
        asserts! {
            overflowed.is_none(), // 没有溢出
            bag.get(key1) == Some(&item1), // 放进「对应id位置」的就是原来的元素
            bag.size() == 1, // 放进了一个
            bag.calculate_level_for_item(&item1) => 0, // 放进的是第0层(优先级为0.0)
            bag.empty_level(0) => false, // 放进的是第0层
            bag.mass() == 1, // 放进第0层,获得(0+1)的重量
        }
        dbg!(&bag);

        // 挑出元素
        let picked = bag.pick_out(key1).unwrap();
        asserts! {
            picked == item1, // 挑出的就是所置入的
            bag.size() == 0, // 取走了
            bag.mass() == 0, // 取走了
            bag.empty_level(0) => true, // 取走的是第0层
        }

        // 放回元素
        let overflowed = bag.put_back(picked);
        asserts! {
            overflowed => None, // 没有溢出
            bag.size() == 1, // 放回了
            bag.empty_level(0) => false, // 放入的是第0层
            bag.mass() == 1, // 放进第0层,获得(0+1)的重量
        }

        // 一瞥元素
        let peeked = bag.peek().unwrap().clone();

        // 取出元素
        let mut taken = bag.take_out().unwrap();
        asserts! {
            taken == item1, // 取出的就是放回了的
            peeked == *taken.key(), // 所取出之元素的key就是一瞥出来的key
            bag.size() == 0, // 取走了
            bag.mass() == 0, // 取走了
            bag.empty_level(0) => true, // 取走的是第0层
        }

        // 修改预算值:优先级"0 => 1",耐久度"0 => 1"
        // ! 📝如果没有耐久度
        taken.budget_mut().set_priority(ShortFloat::ONE);
        taken.budget_mut().set_durability(ShortFloat::ONE);
        asserts! {
            // 最终增长到 1.0
            taken.budget_mut().priority() == ShortFloat::ONE,
            taken.budget_mut().durability() == ShortFloat::ONE,
        }

        // 放回元素,其中会有「遗忘」的操作
        let overflowed = bag.put_back(taken);
        asserts! {
            overflowed => None, // 没有溢出
            bag.size() == 1, // 放回了
            bag.empty_level(0) => true, // 放入的不再是第0层
            bag.empty_level(bag.parameters.total_level-1) => false, // 放入的是最高层
            bag.mass() == bag.parameters.total_level, // 放进第最高层,获得 层数 的重量
        }

        // 最后完成
        ok!()
    }

    /// 测试/多个元素
    /// * 🎯初始化 [`Bag::init`]
    /// * 🎯尺寸 [`Bag::size`]
    /// * 🎯获取 [`Bag::get`]
    /// * 🎯获取层级 [`Bag::__get_level`]
    /// * 🎯判空层级 [`Bag::_empty_level`]
    /// * 🎯放入 [`Bag::put_in`]
    /// * 🎯挑出 [`Bag::pick_out`]
    /// * 🎯放回 [`Bag::put_back`]
    /// * 🎯取出 [`Bag::take_out`]
    /// * 🎯一瞥 [`Bag::peek`]
    #[test]
    fn multi_item() -> AResult {
        // 构造测试用「袋」并初始化
        let mut bag = Bag1::new(
            DEFAULT_PARAMETERS.concept_bag_size,
            DEFAULT_PARAMETERS.concept_forgetting_cycle,
        );
        bag.init();
        dbg!(&bag);
        asserts! {
            bag.size() == 0, // 空的
            bag.empty_level(0) => true, // 第0层也是空的
        }

        /// 测试规模(放入0~10 共**(N+1)**个元素)
        const N: usize = 10;

        // 生成元素
        let key_f = |i| format!("item{:03}", i);
        let priority = |i| i as Float / N as Float;
        // * 📝变换关系:0~1 → [0, 层数] → [0, 层数)
        // * 📝对应关系 @ [0, 层数] → [0, 层数)
        //   * [0, 1] => 0
        //   * (1, 2] => 1
        //   * [层数-1, 层数] => 层数-1
        // * 📌层级计算公式:
        //   * 层级百分比:`i / N`
        //   * 层级:`ceil(百分比 * 层数) - 1`
        let total_level = bag.parameters.total_level;
        let expected_level = |i| {
            let level_percent = priority(i) as Float * total_level as Float;
            (level_percent.ceil() as usize).saturating_sub(1)
        };
        let items = list![
            {
                let key = key_f(i);
                let priority = priority(i);
                let durability = 0.5;
                let quality = 0.5;
                let item = new_item(key.clone(), priority, durability, quality);
                (key, item)
            }
            for i in (0..=N)
        ];

        // 放入多个元素
        for (i, (key, item)) in items.iter().enumerate() {
            let overflowed = bag.put_in(item.clone());
            asserts! {
                overflowed.is_none(), // 没有溢出
                bag.get(key) == Some(item), // 放进「对应id位置」的就是原来的元素
                bag.size() == i + 1, // 放进了(i+1)个
                bag.calculate_level_for_item(item) => expected_level(i), // 放进了指定层
                bag.empty_level(expected_level(i)) => false, // 放进的是指定层
            }
        }
        println!("初次放入后:{bag:#?}");

        // 挑出元素
        let mut picked_items = vec![];
        for (i, (key, item)) in items.iter().enumerate() {
            let picked = bag.pick_out(key).unwrap(); // 一定能挑出

            // 计算预期层数
            asserts! {
                picked == *item, // 挑出的就是所置入的
                bag.size() == N - i, // 取走了
                bag.empty_level(expected_level(i)) => true, // 取走的是指定层
            }
            picked_items.push(picked);
        }

        // 放回元素
        for (i, picked) in picked_items.into_iter().enumerate() {
            let overflowed = bag.put_back(picked); // 此时预算值也改变了:会衰减
            asserts! {
                overflowed => None, // 没有溢出
                bag.size() == i + 1, // 放回了
                // bag._empty_level(0) => false, // 放入的是第0层
            }
        }
        println!("第一次放回后:{bag:#?}");

        // 取出&一瞥 元素
        let mut taken_items = vec![];
        for i in 0..=N {
            let peeked = bag.peek().unwrap().clone();
            let taken = bag.take_out().unwrap(); // 一定拿得出来
            asserts! {
                peeked == *taken.key() // 一瞥出来的元素,应该和取出来的元素一致
                bag.size() == N - i, // 取走了
                // bag._empty_level(0) => true, // 取走的是第0层
            }
            // 添加 & 展示 | 📌此处预算值已根据[`BudgetValue::forget`]衰减
            taken_items.push(dbg!(taken));
        }

        // 放回元素
        for (i, taken) in taken_items.into_iter().enumerate() {
            let _ = bag.put_back(taken);
            asserts! {
                bag.size() == i + 1, // 放回了
                // bag._empty_level(0) => true, // 放入的不再是第0层
                // bag._empty_level(Bag1::__TOTAL_LEVEL-1) => false, // 放入的是最高层
            }
        }

        // 最后完成
        println!("第二次放回后:{bag:#?}");
        ok!()
    }

    /// 测试/长期
    /// * 🎯放入→多次「取出→放回→取出→放回→……」的结果
    #[test]
    fn long_term() -> AResult {
        // 测试规模(重复「取出→放回→」的次数)
        const N: usize = 100;

        // 构造测试用「袋」并初始化
        let mut bag = Bag1::new(10, N);
        bag.init();
        dbg!(&bag);
        asserts! {
            bag.size() == 0, // 空的
            bag.mass() == 0, // 空的
        }

        // 生成元素
        let key = "item";
        // * 🚩固定的初始预算值
        let budget_initial = BudgetValue::new(ShortFloat::ONE, ShortFloat::HALF, ShortFloat::ONE);
        let item = Item1::new(key, budget_initial);

        // 放入元素
        let overflowed = bag.put_in(dbg!(item.clone()));
        asserts! {
            overflowed.is_none(), // 没有溢出
            bag.get(key) == Some(&item), // 放进「对应id位置」的就是原来的元素
            bag.size() == 1, // 放进了一个
            bag.mass() >= 1, // 放进了,获得重量
        }
        dbg!(&bag);

        // 多次取出放回 | // * 📝根据[`BudgetFunctions::forget`],实际上只有「优先级」会变化
        println!("budget trending from {budget_initial}:");
        for _ in 0..N {
            let taken = bag.take_out().unwrap(); // 一定拿得出来

            // 检查、展示
            asserts! {
                bag.size() == 0, // 取出了
                bag.mass() == 0, // 失去所有重量
            };
            println!("\t{}", taken.budget());

            //放回元素
            let overflowed = bag.put_back(taken);
            assert_eq!(
                overflowed,
                None // 没有溢出
            )
        }
        println!("{}", bag.to_display_long());

        // 最终完成
        ok!()
    }

    /// 测试/物品在袋内优先级变化
    /// * ⚠️测试「袋内优先级发生变化,是否能正确被 挑出/拿出」
    #[test]
    fn modified_level_in_bag() -> AResult {
        // 构造测试用「袋」
        let mut bag = Bag1::new(1, 1);
        bag.init();

        // 放入元素
        let key = "item001";
        let item = new_item(key, 0.0, 0.0, 0.0); // * 🚩固定为「全零预算」
        let overflowed = bag.put_in(dbg!(item.clone()));
        asserts! {
            overflowed.is_none(), // 没有溢出
            bag.get(key) == Some(&item), // 放进「对应id位置」的就是原来的元素
            bag.size() == 1, // 放进了一个
            bag.calculate_level_for_item(&item) => 0, // 放进的是第0层(优先级为0.0)
            bag.empty_level(0) => false, // 放进的是第0层
            bag.mass() == 1, // 放进第0层,获得(0+1)的重量
        }
        dbg!(&bag);

        // ! 在袋内修改优先级
        let item_mut = bag.get_mut(key).expect("此时袋内必须有物品");
        item_mut.set_priority(ShortFloat::ONE);

        // 挑出元素
        let picked = bag.pick_out(key).unwrap();
        asserts! {
            bag.size() == 0, // 取走了
            bag.mass() == 0, // 取走了
            bag.empty_level(0) => true, // 取走的是第0层
        }

        // 放回元素
        let overflowed = bag.put_back(picked);
        asserts! {
            overflowed => None, // 没有溢出
            bag.size() == 1, // 放回了
            bag.empty_level(0) => false, // 放入的是第0层
            bag.mass() == 1, // 放进第0层,获得(0+1)的重量
        }

        // ! 在袋内修改优先级
        let item_mut = bag.get_mut(key).expect("此时袋内必须有物品");
        item_mut.set_priority(ShortFloat::HALF);

        // 取出元素
        let taken = bag.take_out().unwrap();
        asserts! {
            taken.priority() == ShortFloat::HALF,
            bag.size() == 0, // 取走了
            bag.mass() == 0, // 取走了
            bag.empty_level(0) => true, // 取走的是第0层
        }

        // 最后完成
        ok!()
    }
}