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
//! # 瓷砖集模块
//!
//! 本模块实现了WFC(Wave Function Collapse)系统的瓷砖集功能,
//! 是对原C++ TileSet.h的Rust重写版本。
//!
//! ## 模块概述
//!
//! 瓷砖集是WFC算法的核心组件之一,负责:
//!
//! - **瓷砖管理**:存储和管理所有可用的瓷砖
//! - **约束判断**:判断瓷砖在特定邻居约束下的可能性
//! - **瓷砖构建**:初始化和配置瓷砖集合
//!
//! ## 设计架构
//!
//! ### 分离关注点设计
//!
//! 与原C++的单一类设计不同,Rust版本采用了分离关注点的架构:
//!
//! - [`TileSetVirtual`] trait:仅包含原C++的两个虚函数
//! - [`TileSet`] struct:包含所有固定方法和数据存储
//!
//! 这种设计的优势:
//!
//! 1. **清晰的职责划分**:虚函数逻辑与数据管理分离
//! 2. **更好的组合性**:可以独立实现和测试两部分
//! 3. **避免继承复杂性**:使用组合替代继承
//!
//! ### 与原C++的对比
//!
//! | 方面 | C++ | Rust |
//! |------|-----|------|
//! | 多态机制 | 虚函数继承 | Trait + 组合 |
//! | 内存管理 | 手动管理 | 自动管理 |
//! | 类型安全 | 运行时检查 | 编译时检查 |
//! | 错误处理 | 异常/返回码 | Result类型 |
//! | 泛型支持 | 模板 | 泛型 + trait约束 |
//!
//! ## 使用模式
//!
//! ### 基本用法
//!
//! ```rust
//! use rlwfc::{TileSet, Tile};
//!
//! // 创建瓷砖集
//! let mut tile_set = TileSet::new();
//!
//! // ⚠️ 重要:边数据必须按 neighbors() 返回顺序排列
//! let tile_edges = vec![
//! "北边数据", // 索引 0 - 对应 neighbors()[0] (北方向)
//! "西边数据", // 索引 1 - 对应 neighbors()[1] (西方向)
//! "南边数据", // 索引 2 - 对应 neighbors()[2] (南方向)
//! "东边数据", // 索引 3 - 对应 neighbors()[3] (东方向)
//! ];
//! let tile_id = tile_set.add_tile(tile_edges, 10);
//!
//! // 获取瓷砖
//! if let Some(tile) = tile_set.get_tile(tile_id) {
//! println!("Tile weight: {}", tile.weight);
//! }
//! ```
//!
//! ### ⚠️ **关键设计约束:瓷砖边数据顺序**
//!
//! 瓷砖的边数据顺序必须与网格系统的 `neighbors()` 返回顺序**严格一致**:
//!
//! #### 顺序对应关系
//!
//! ```text
//! 网格边创建顺序:东 → 南 → 西 → 北
//! neighbors() 返回:[北, 西, 南, 东] (petgraph 逆序特性)
//! 瓷砖边数据索引:[0, 1, 2, 3]
//! 方向到索引映射:北=0, 西=1, 南=2, 东=3
//! ```
//!
//! #### 为什么这很重要?
//!
//! 1. **直接索引对应**:`judge_possibility()` 中可以直接用索引访问对应方向的边数据
//! 2. **高效兼容性检查**:无需额外的方向映射转换
//! 3. **统一约定**:网格系统和瓷砖系统使用相同的索引语义
//! 4. **零成本抽象**:运行时无额外开销
//!
//! #### 正确的瓷砖创建模式
//!
//! ```rust
//! use rlwfc::TileSet;
//!
//! let mut tile_set = TileSet::new();
//!
//! // ✅ 正确:按 neighbors() 顺序排列边数据
//! tile_set.add_tile(vec![
//! "grass", // 北边 (索引 0)
//! "water", // 西边 (索引 1)
//! "grass", // 南边 (索引 2)
//! "water", // 东边 (索引 3)
//! ], 10);
//!
//! // ❌ 错误:随意排列会破坏方向对应关系
//! tile_set.add_tile(vec![
//! "water", // 这样的顺序无法与 neighbors() 正确对应
//! "grass",
//! "water",
//! "grass",
//! ], 10);
//! ```
//!
//! #### 在 judge_possibility() 中的应用
//!
//! ```rust
//! use rlwfc::TileId;
//!
//! fn judge_possibility(
//! neighbor_possibilities: &[Vec<TileId>],
//! candidate: TileId
//! ) -> bool {
//! // 示例实现
//! !neighbor_possibilities.is_empty() && candidate < 100
//! }
//! ```
//!
//! ### 实现虚函数trait
//!
//! ```rust
//! use rlwfc::{TileSetVirtual, TileSet, TileId, Tile, GridError};
//!
//! struct MyTileSet {
//! tiles: TileSet<String>,
//! }
//!
//! impl TileSetVirtual<String> for MyTileSet {
//! fn build_tile_set(&mut self) -> Result<(), GridError> {
//! // 清空现有瓷砖
//! self.tiles.clear();
//!
//! // 添加具体的瓷砖
//! self.tiles.add_tile(vec!["A".to_string(), "B".to_string(), "C".to_string(), "D".to_string()], 10);
//! self.tiles.add_tile(vec!["B".to_string(), "A".to_string(), "D".to_string(), "C".to_string()], 15);
//! Ok(())
//! }
//!
//! fn judge_possibility(
//! &self,
//! neighbor_possibilities: &[Vec<TileId>],
//! candidate: TileId
//! ) -> bool {
//! // 实现具体的约束判断逻辑
//! if let Some(_tile) = self.tiles.get_tile(candidate) {
//! // 检查候选瓷砖是否与邻居兼容
//! // 这里应该实现具体的兼容性检查逻辑
//! !neighbor_possibilities.is_empty()
//! } else {
//! false
//! }
//! }
//!
//! fn get_tile(&self, tile_id: TileId) -> Option<&Tile<String>> {
//! self.tiles.get_tile(tile_id)
//! }
//!
//! fn get_tile_count(&self) -> usize {
//! self.tiles.get_tile_count()
//! }
//!
//! fn get_all_tile_ids(&self) -> Vec<TileId> {
//! self.tiles.get_all_tile_ids()
//! }
//! }
//! ```
//!
//! ## 泛型设计
//!
//! 瓷砖系统支持任意类型的边数据:
//!
//! ```rust
//! use rlwfc::TileSet;
//!
//! // 字符串边数据
//! let mut string_tiles = TileSet::<String>::new();
//!
//! // 数字边数据
//! let mut number_tiles = TileSet::<i32>::new();
//!
//! // 自定义结构体边数据
//! #[derive(Clone, PartialEq, Debug)]
//! struct CustomEdge { id: u32, color: String }
//! let mut custom_tiles = TileSet::<CustomEdge>::new();
//! ```
//!
//! ## 性能考虑
//!
//! - **零成本抽象**:trait分发在编译时确定
//! - **内存效率**:紧凑的数据布局,最小化内存占用
//! - **缓存友好**:瓷砖数据连续存储,提高访问效率
//!
//! ## 扩展性
//!
//! 系统设计支持多种扩展:
//!
//! - **不同约束规则**:通过实现`TileSetVirtual`支持各种约束逻辑
//! - **多种边数据类型**:泛型设计支持任意边数据
//! - **性能优化**:可以在具体实现中添加缓存、索引等优化
/**
* @file tile_set.rs
* @author amazcuter (amazcuter@outlook.com)
* @brief WFC系统瓷砖集 - Rust重写版本
* 对应原C++ TileSet.h的功能,使用trait替代虚函数
* @version 1.0
* @date 2025-01-25
*
* @copyright Copyright (c) 2025
*/
use crate*;
// =============================================================================
// 虚函数特性 - 仅包含原C++的两个虚函数
// =============================================================================
/// 瓷砖集虚函数特性 - 仅包含C++的两个虚函数
///
/// 这个trait专门提取了原C++代码中的两个纯虚函数,实现了与原C++设计的完全对应:
///
/// - `virtual void buildTileSet() = 0;`
/// - `virtual bool judgePossibility(...) = 0;`
///
/// ## 设计理念
///
/// ### 职责分离
///
/// 将虚函数逻辑从数据管理中分离出来,带来以下好处:
///
/// 1. **清晰的接口**:只包含需要自定义实现的方法
/// 2. **类型安全**:编译时确保所有必要方法都被实现
/// 3. **测试友好**:可以独立模拟和测试虚函数逻辑
///
/// ### 与原C++的一致性
///
/// | C++虚函数 | Rust trait方法 | 功能 |
/// |-----------|----------------|------|
/// | `buildTileSet()` | [`build_tile_set()`] | 构建瓷砖集 |
/// | `judgePossibility(...)` | [`judge_possibility(...)`] | 判断瓷砖可能性 |
///
/// ## 泛型参数
///
/// `EdgeData` 类型参数表示瓷砖边的数据类型,需要满足:
///
/// - `Clone`:支持复制操作
/// - `PartialEq`:支持相等性比较
/// - `Debug`:支持调试输出
///
/// ## 实现示例
///
/// ```rust,no_run
/// use rlwfc::{TileSetVirtual, TileSet, TileId, Tile, GridError};
///
/// struct SimpleTileSet {
/// tiles: TileSet<&'static str>,
/// }
///
/// impl TileSetVirtual<&'static str> for SimpleTileSet {
/// fn build_tile_set(&mut self) -> Result<(), GridError> {
/// // 清空现有瓷砖
/// self.tiles.clear();
///
/// // 添加具体的瓷砖
/// self.tiles.add_tile(vec!["A", "B", "C", "D"], 10);
/// self.tiles.add_tile(vec!["B", "A", "D", "C"], 15);
/// Ok(())
/// }
///
/// fn judge_possibility(
/// &self,
/// neighbor_possibilities: &[Vec<TileId>],
/// candidate: TileId
/// ) -> bool {
/// // 实现具体的约束判断逻辑
/// if let Some(_tile) = self.tiles.get_tile(candidate) {
/// // 检查候选瓷砖是否与邻居兼容
/// // 这里应该实现具体的兼容性检查逻辑
/// !neighbor_possibilities.is_empty()
/// } else {
/// false
/// }
/// }
///
/// fn get_tile(&self, tile_id: TileId) -> Option<&Tile<&'static str>> {
/// self.tiles.get_tile(tile_id)
/// }
///
/// fn get_tile_count(&self) -> usize {
/// self.tiles.get_tile_count()
/// }
///
/// fn get_all_tile_ids(&self) -> Vec<TileId> {
/// self.tiles.get_all_tile_ids()
/// }
/// }
/// ```
///
/// [`build_tile_set()`]: TileSetVirtual::build_tile_set
/// [`judge_possibility(...)`]: TileSetVirtual::judge_possibility
// =============================================================================
// 瓷砖集具体实现 - 包含所有固定方法和数据存储
// =============================================================================
/// 瓷砖集具体实现 - 包含所有固定方法和数据存储
// =============================================================================
// 测试模块
// =============================================================================