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
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
//! Normalization engine
//!
//! Implements the core HGVS variant normalization algorithm including
//! 3'/5' shifting and boundary detection.
//!
//! # Coordinate Systems
//!
//! This module uses multiple coordinate systems:
//!
//! | Context | Basis | Type/Notes |
//! |---------|-------|------------|
//! | HGVS variant positions | 1-based | `u64` for genomic, `i64` for CDS/Tx |
//! | Array indexing | 0-based | `usize` for sequence slicing |
//! | Boundaries struct | 1-based | `(start, end)` inclusive |
//! | Shuffle input/output | 0-based | Uses array indices |
//! | Relative positions | 1-based | Positions within fetched window |
//!
//! Key conversions:
//! - `hgvs_pos_to_index(pos)` converts 1-based HGVS position to 0-based index
//! - `index_to_hgvs_pos(idx)` converts 0-based index to 1-based HGVS position
//! - `pos.saturating_sub(1)` manually converts 1-based to 0-based
//! - `idx + 1` manually converts 0-based to 1-based
//!
//! For type-safe coordinate handling, see [`crate::coords`].
pub mod boundary;
pub mod config;
pub(crate) mod merge;
mod overlap;
pub mod rules;
pub mod shuffle;
pub mod validate;
use crate::coords::{hgvs_pos_to_index, index_to_hgvs_pos};
use crate::error::FerroError;
use crate::hgvs::edit::{Base, InsertedSequence, NaEdit, Sequence};
use crate::hgvs::interval::Interval;
use crate::hgvs::location::{CdsPos, GenomePos, RnaPos, TxPos};
use crate::hgvs::parser::position::{OFFSET_UNKNOWN_NEGATIVE, OFFSET_UNKNOWN_POSITIVE};
use crate::hgvs::uncertainty::Mu;
use crate::hgvs::variant::{
AllelePhase, AlleleVariant, CdsVariant, GenomeVariant, HgvsVariant, LocEdit, MtVariant,
RnaVariant, TxVariant,
};
use crate::hgvs::HgvsVariant as HV;
use crate::reference::transcript::Strand;
use crate::reference::ReferenceProvider;
use boundary::Boundaries;
pub use config::{NormalizeConfig, ShuffleDirection};
use rules::{
canonicalize_conversion_to_delins, canonicalize_edit, needs_normalization, should_canonicalize,
DelinsSubedit,
};
use shuffle::shuffle;
/// Check if a CDS position has an unknown (?) offset sentinel value
fn has_unknown_offset_cds(pos: &CdsPos) -> bool {
matches!(
pos.offset,
Some(OFFSET_UNKNOWN_POSITIVE) | Some(OFFSET_UNKNOWN_NEGATIVE)
)
}
/// Check if a TxPos has an unknown (?) offset sentinel value
fn has_unknown_offset_tx(pos: &TxPos) -> bool {
matches!(
pos.offset,
Some(OFFSET_UNKNOWN_POSITIVE) | Some(OFFSET_UNKNOWN_NEGATIVE)
)
}
/// Warning generated during normalization.
///
/// This enum is open-ended: each variant owns the fields its code needs.
/// Future warning codes add new variants without touching existing emit sites.
#[derive(Debug, Clone)]
pub enum NormalizationWarning {
/// Reference sequence mismatch. Stated ref bases in the HGVS expression
/// do not match the actual reference sequence. Code: `REFSEQ_MISMATCH`.
RefSeqMismatch {
/// Human-readable description
message: String,
/// What the input claimed as reference
stated_ref: String,
/// What the actual reference sequence has
actual_ref: String,
/// Position info
position: String,
/// Whether the mismatch was auto-corrected
corrected: bool,
},
/// Two or more cis-allele edits share identical reference bounds.
/// The HGVS spec does not define a canonical form for this case;
/// ferro preserves the input verbatim and emits this warning.
/// Code: `OVERLAP_CONFLICTING_EDITS`.
OverlapConflict {
/// Human-readable description
message: String,
/// Accession of the reference sequence
accession: String,
/// Coordinate system: "g" | "c" | "n" | "r" | "m"
coordinate_system: String,
/// Canonical span text, e.g. "100" or "100_103"
location: String,
/// Edit kinds, e.g. ["sub", "sub"] or ["del", "inv"]
edit_kinds: Vec<String>,
},
}
impl NormalizationWarning {
/// The warning's user-facing code string.
pub fn code(&self) -> &'static str {
match self {
Self::RefSeqMismatch { .. } => "REFSEQ_MISMATCH",
Self::OverlapConflict { .. } => "OVERLAP_CONFLICTING_EDITS",
}
}
/// Human-readable message for the warning.
pub fn message(&self) -> &str {
match self {
Self::RefSeqMismatch { message, .. } => message,
Self::OverlapConflict { message, .. } => message,
}
}
}
/// Result of normalization with optional warnings
#[derive(Debug, Clone)]
pub struct NormalizeResultWithWarnings {
/// The normalized variant
pub result: HgvsVariant,
/// Warnings generated during normalization
pub warnings: Vec<NormalizationWarning>,
}
impl NormalizeResultWithWarnings {
/// Create a new result without warnings
pub fn new(result: HgvsVariant) -> Self {
Self {
result,
warnings: vec![],
}
}
/// Create a result with warnings
pub fn with_warnings(result: HgvsVariant, warnings: Vec<NormalizationWarning>) -> Self {
Self { result, warnings }
}
/// Add a warning to the result
pub fn add_warning(&mut self, warning: NormalizationWarning) {
self.warnings.push(warning);
}
/// Check if there are any warnings
pub fn has_warnings(&self) -> bool {
!self.warnings.is_empty()
}
/// Check if there's a reference mismatch warning
pub fn has_ref_mismatch(&self) -> bool {
self.warnings
.iter()
.any(|w| matches!(w, NormalizationWarning::RefSeqMismatch { .. }))
}
}
/// Main normalizer struct
pub struct Normalizer<P: ReferenceProvider> {
provider: P,
config: NormalizeConfig,
}
impl<P: ReferenceProvider> Normalizer<P> {
/// Create a new normalizer with the given reference provider
pub fn new(provider: P) -> Self {
Self {
provider,
config: NormalizeConfig::default(),
}
}
/// Create a normalizer with custom configuration
pub fn with_config(provider: P, config: NormalizeConfig) -> Self {
Self { provider, config }
}
/// Get the configuration
pub fn config(&self) -> &NormalizeConfig {
&self.config
}
/// Normalize a variant
///
/// In strict mode (default), rejects variants with reference mismatches.
/// Use `normalize_with_warnings` for lenient mode that corrects mismatches.
pub fn normalize(&self, variant: &HgvsVariant) -> Result<HgvsVariant, FerroError> {
let result = self.normalize_with_warnings(variant)?;
// In strict mode, reject if there were reference mismatches.
if self.config.should_reject_ref_mismatch() {
if let Some(err) = result.warnings.iter().find_map(|w| match w {
NormalizationWarning::RefSeqMismatch {
position,
stated_ref,
actual_ref,
..
} => Some(FerroError::ReferenceMismatch {
location: position.clone(),
expected: stated_ref.clone(),
found: actual_ref.clone(),
}),
_ => None,
}) {
return Err(err);
}
}
Ok(result.result)
}
/// Normalize a variant with detailed warnings
///
/// Returns the normalized variant along with any warnings generated during
/// normalization (e.g., reference sequence mismatches that were auto-corrected).
/// Use this method when you want to track what corrections were made.
pub fn normalize_with_warnings(
&self,
variant: &HgvsVariant,
) -> Result<NormalizeResultWithWarnings, FerroError> {
let (result, warnings) = match variant {
HV::Genome(v) => self.normalize_genome(v)?,
HV::Cds(v) => self.normalize_cds(v)?,
HV::Tx(v) => self.normalize_tx(v)?,
HV::Protein(v) => self.normalize_protein(v)?,
HV::Rna(v) => self.normalize_rna(v)?,
HV::Mt(v) => self.normalize_mt(v)?,
HV::Allele(a) => self.normalize_allele(a)?,
// Circular variants normalize like genomic variants
HV::Circular(v) => (
HV::Circular(crate::hgvs::variant::CircularVariant {
accession: v.accession.clone(),
gene_symbol: v.gene_symbol.clone(),
loc_edit: v.loc_edit.clone(),
}),
vec![],
),
// RNA fusions pass through unchanged (no normalization needed for fusions)
HV::RnaFusion(v) => (HV::RnaFusion(v.clone()), vec![]),
// Null and unknown allele markers pass through unchanged
HV::NullAllele => (HV::NullAllele, vec![]),
HV::UnknownAllele => (HV::UnknownAllele, vec![]),
};
Ok(NormalizeResultWithWarnings::with_warnings(result, warnings))
}
/// Normalize an allele (compound) variant
///
/// Normalizes each variant in the allele individually, with overlap prevention.
/// After normalization, checks if variants would overlap and constrains shifting
/// to prevent collisions.
fn normalize_allele(
&self,
allele: &crate::hgvs::variant::AlleleVariant,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
// Merge first, then normalize each result through the full per-variant
// pipeline. Pre-normalizing each bracket entry would shift it
// independently of its siblings, which can collapse adjacent edits
// onto the same 3'-end position (e.g. `[260delA;261delA]` →
// `[264del;264del]`) and defeat the strict-adjacency merge. Issue #180.
//
// Order:
// 1. merge raw bracket entries by positional adjacency
// 2. cis-only: decompose merged delins into [..., inv, ...] (#160)
// 3. run the full per-variant pipeline on every result — this is
// what applies the HGVS 3' rule to the merged anchor (#161, #180)
// 4. detect post-shift overlaps and emit warnings
let mut all_warnings = Vec::new();
let original_len = allele.variants.len();
let merged_raw =
merge::merge_consecutive_edits(allele.variants.clone(), allele.phase, &self.provider);
// Issue #160: any merged delins (or pre-existing delins that survived
// merge unchanged) may decompose into [..., inv, ...] when an inv-
// eligible sub-span is present. Run the split per merged variant; the
// helper is a no-op for non-Delins variants and for Delins without an
// inv sub-span. Only applies in cis phase — trans alleles aren't
// collapsible in the first place.
let merged_split: Vec<HgvsVariant> =
if allele.phase == crate::hgvs::variant::AllelePhase::Cis {
merged_raw
.into_iter()
.flat_map(|v| self.split_inv_for_variant(v))
.collect()
} else {
merged_raw
};
// Per-variant pipeline on every merged result. This is the single
// canonical place where the 3' rule, ins→dup canonicalization, ref
// validation, etc. apply — a merged variant is semantically a new
// variant and goes through the same pipeline as any direct input.
let mut normalized: Vec<HgvsVariant> = Vec::with_capacity(merged_split.len());
for v in merged_split {
let r = self.normalize_with_warnings(&v)?;
all_warnings.extend(r.warnings);
normalized.push(r.result);
}
// Overlap detection runs post-shift so collisions caused by the
// 3' shift surface alongside input-time ones. Overlap *prevention*
// is structural — the merge-first ordering above plus the strict
// `prev.end + 1 == next.start` adjacency check in
// `merge_consecutive_edits` make it impossible for the normalizer
// to emit overlapping ranges from non-overlapping inputs.
all_warnings.extend(crate::normalize::overlap::detect_overlap_conflicts(
&normalized,
allele.phase,
));
// HGVS requires consecutive edits in cis to render as a single edit.
// Only unwrap when a merge actually collapsed multiple sub-variants —
// pre-existing singleton alleles must round-trip with the Allele
// wrapper intact for programmatic callers (Display already renders
// singletons in bare form regardless).
let result = if allele.phase == crate::hgvs::variant::AllelePhase::Cis
&& original_len > 1
&& normalized.len() == 1
{
normalized.pop().unwrap()
} else {
HgvsVariant::Allele(crate::hgvs::variant::AlleleVariant::new(
normalized,
allele.phase,
))
};
Ok((result, all_warnings))
}
/// Normalize a genomic variant
fn normalize_genome(
&self,
variant: &GenomeVariant,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
// Can't normalize variants with unknown edits or positions
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return Ok((HV::Genome(variant.clone()), vec![])),
};
// SVD-WG009: rewrite `con` to `delins` before any further work.
// Pure-syntax; no reference data needed.
if let Some(new_edit) = canonicalize_conversion_to_delins(edit) {
let new_variant = GenomeVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| new_edit.clone()),
),
};
return Ok((HV::Genome(new_variant), vec![]));
}
// Only normalize indels
if !needs_normalization(edit) {
return Ok((HV::Genome(variant.clone()), vec![]));
}
// Get sequence from provider - can't normalize with unknown positions
let accession = variant.accession.transcript_accession();
let start = match variant.loc_edit.location.start.inner() {
Some(pos) => pos.base,
None => {
return Ok((
HV::Genome(self.canonicalize_genome_variant(variant)),
vec![],
))
}
};
let end = match variant.loc_edit.location.end.inner() {
Some(pos) => pos.base,
None => {
return Ok((
HV::Genome(self.canonicalize_genome_variant(variant)),
vec![],
))
}
};
// Try to get transcript/sequence, fall back to minimal notation if not found
let window_start = start.saturating_sub(self.config.window_size);
let seq_result = self.provider.get_sequence(
&accession,
window_start,
end.saturating_add(self.config.window_size),
);
let ref_seq = match seq_result {
Ok(s) => s,
// Can't do full normalization without sequence, but apply minimal notation
Err(_) => {
return Ok((
HV::Genome(self.canonicalize_genome_variant(variant)),
vec![],
))
}
};
// Adjust coordinates to be relative to the window
let rel_start = start - window_start;
let rel_end = end - window_start;
// Perform normalization
let (new_rel_start, new_rel_end, new_edit, warnings) = self.normalize_na_edit(
ref_seq.as_bytes(),
edit,
rel_start,
rel_end,
&Boundaries::new(1, ref_seq.len() as u64),
false, // genomic context: codon-frame gate does not apply
)?;
// Adjust back to genomic coordinates
let new_start = new_rel_start + window_start;
let new_end = new_rel_end + window_start;
// Reconstruct variant with new position (using adjusted coordinates)
let new_variant = GenomeVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::new(
Interval::new(GenomePos::new(new_start), GenomePos::new(new_end)),
new_edit,
),
};
// Issue #160: a normalized Delins may decompose into [..., inv, ...]
// when an inv-eligible sub-span is present. Returns the variant
// unchanged for non-Delins or no-decomposition cases.
let split = self.apply_inv_split(HV::Genome(new_variant));
Ok((wrap_allele_if_split(split), warnings))
}
/// Normalize a CDS variant
fn normalize_cds(
&self,
variant: &CdsVariant,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
// Can't normalize variants with unknown edits or positions
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return Ok((HV::Cds(variant.clone()), vec![])),
};
// SVD-WG009: rewrite `con` to `delins`.
if let Some(new_edit) = canonicalize_conversion_to_delins(edit) {
let new_variant = CdsVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| new_edit.clone()),
),
};
return Ok((HV::Cds(new_variant), vec![]));
}
// Only normalize indels
if !needs_normalization(edit) {
return Ok((HV::Cds(variant.clone()), vec![]));
}
// Check for intronic variants or unknown positions - can't normalize those
let start_pos = match variant.loc_edit.location.start.inner() {
Some(pos) => pos,
None => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
};
let end_pos = match variant.loc_edit.location.end.inner() {
Some(pos) => pos,
None => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
};
// Can't normalize variants with unknown (?) offsets - return unchanged
if has_unknown_offset_cds(start_pos) || has_unknown_offset_cds(end_pos) {
return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![]));
}
// Try to get transcript first - we need it for intronic normalization too
let accession = variant.accession.transcript_accession();
let transcript = match self.provider.get_transcript(&accession) {
Ok(t) => t,
// Can't do full normalization without transcript, but apply minimal notation
Err(_) => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
};
// Handle intronic variants specially
if start_pos.is_intronic() || end_pos.is_intronic() {
// Check if both positions are intronic and in the same intron
if start_pos.is_intronic() && end_pos.is_intronic() {
return self.normalize_intronic_cds(variant, &transcript, start_pos, end_pos, edit);
}
// Variant spans exon-intron boundary - normalize in genomic space
return self.normalize_boundary_spanning_cds(
variant,
&transcript,
start_pos,
end_pos,
edit,
);
}
// Convert CDS to transcript coordinates for normalization
let cds_start = match transcript.cds_start {
Some(s) => s,
None => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
};
// Calculate transcript positions - return unchanged if position is out of range
let tx_start = match self.cds_to_tx_pos(start_pos, cds_start, transcript.cds_end) {
Ok(v) => v,
Err(_) => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
};
let tx_end = match self.cds_to_tx_pos(end_pos, cds_start, transcript.cds_end) {
Ok(v) => v,
Err(_) => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
};
// Get boundaries (stay within exon unless configured otherwise)
let boundaries = if self.config.cross_boundaries {
Boundaries::new(1, transcript.sequence_length())
} else {
match boundary::get_cds_boundaries(&transcript, tx_start, &self.config) {
Ok(b) => b,
Err(_) => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
}
};
// Perform normalization on transcript sequence (CDS context).
// Coordinate-only transcripts (no cached bases) fall back to the
// canonicalize-only path, matching the other early-return branches.
let seq = match transcript.sequence.as_deref() {
Some(s) => s.as_bytes(),
None => return Ok((HV::Cds(self.canonicalize_cds_variant(variant)), vec![])),
};
let (new_tx_start, new_tx_end, new_edit, warnings) =
self.normalize_na_edit(seq, edit, tx_start, tx_end, &boundaries, true)?;
// Convert back to CDS coordinates
let new_start = self.tx_to_cds_pos(new_tx_start, cds_start, transcript.cds_end)?;
let new_end = self.tx_to_cds_pos(new_tx_end, cds_start, transcript.cds_end)?;
let new_variant = CdsVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::new(Interval::new(new_start, new_end), new_edit),
};
// Issue #160 inv sub-span split (CDS-proper positions only).
let split = self.apply_inv_split(HV::Cds(new_variant));
Ok((wrap_allele_if_split(split), warnings))
}
/// Normalize a transcript variant
fn normalize_tx(
&self,
variant: &TxVariant,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
// Can't normalize variants with unknown edits or positions
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return Ok((HV::Tx(variant.clone()), vec![])),
};
// SVD-WG009: rewrite `con` to `delins`.
if let Some(new_edit) = canonicalize_conversion_to_delins(edit) {
let new_variant = TxVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| new_edit.clone()),
),
};
return Ok((HV::Tx(new_variant), vec![]));
}
// Only normalize indels
if !needs_normalization(edit) {
return Ok((HV::Tx(variant.clone()), vec![]));
}
// Check for intronic variants or unknown positions
let start_pos = match variant.loc_edit.location.start.inner() {
Some(pos) => pos,
None => return Ok((HV::Tx(self.canonicalize_tx_variant(variant)), vec![])),
};
let end_pos = match variant.loc_edit.location.end.inner() {
Some(pos) => pos,
None => return Ok((HV::Tx(self.canonicalize_tx_variant(variant)), vec![])),
};
// Can't normalize variants with unknown (?) offsets - return unchanged
if has_unknown_offset_tx(start_pos) || has_unknown_offset_tx(end_pos) {
return Ok((HV::Tx(self.canonicalize_tx_variant(variant)), vec![]));
}
// Try to get transcript first - we need it for intronic normalization too
let accession = variant.accession.transcript_accession();
let transcript = match self.provider.get_transcript(&accession) {
Ok(t) => t,
// Can't do full normalization without transcript, but apply minimal notation
Err(_) => return Ok((HV::Tx(self.canonicalize_tx_variant(variant)), vec![])),
};
if start_pos.is_intronic() || end_pos.is_intronic() {
// Route intronic tx variants to the intronic normalization path
if start_pos.is_intronic() && end_pos.is_intronic() {
return self.normalize_intronic_tx(variant, &transcript, start_pos, end_pos, edit);
}
// Variant spans exon-intron boundary - not yet supported for n. coords
return Err(FerroError::IntronicVariant {
variant: format!("{}", variant),
});
}
// Only normalize positive positions (within transcript)
// Negative positions are outside the transcript sequence
if start_pos.base < 1 || end_pos.base < 1 {
return Ok((HV::Tx(self.canonicalize_tx_variant(variant)), vec![]));
}
let tx_start = start_pos.base as u64;
let tx_end = end_pos.base as u64;
// Get boundaries
let boundaries = Boundaries::new(1, transcript.sequence_length());
// Perform normalization (n. non-coding tx context).
// Coordinate-only transcripts (no cached bases) fall back to the
// canonicalize-only path.
let seq = match transcript.sequence.as_deref() {
Some(s) => s.as_bytes(),
None => return Ok((HV::Tx(self.canonicalize_tx_variant(variant)), vec![])),
};
let (new_start, new_end, new_edit, warnings) =
self.normalize_na_edit(seq, edit, tx_start, tx_end, &boundaries, false)?;
let new_variant = TxVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::new(
Interval::new(TxPos::new(new_start as i64), TxPos::new(new_end as i64)),
new_edit,
),
};
// Issue #160 inv sub-span split.
let split = self.apply_inv_split(HV::Tx(new_variant));
Ok((wrap_allele_if_split(split), warnings))
}
/// Normalize a protein variant
///
/// Protein normalization differs from nucleic acid normalization - there's no
/// 3'/5' shifting. Instead, we perform formatting standardization:
///
/// 1. **Reference validation**: Check that position amino acids match the
/// reference protein sequence (if protein data is available).
///
/// 2. **Redundant sequence removal**: Remove explicit sequences in deletions
/// when they match the amino acids at the deletion position.
/// Example: `p.Val600delVal` → `p.Val600del`
///
/// 3. **1-letter to 3-letter conversion**: (handled by parser/display)
fn normalize_protein(
&self,
variant: &crate::hgvs::variant::ProteinVariant,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
use crate::hgvs::edit::ProteinEdit;
use crate::hgvs::variant::{LocEdit, ProteinVariant};
// Validate reference amino acids if provider has protein data
if self.provider.has_protein_data() {
self.validate_protein_reference(variant)?;
}
// Get the current edit
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return Ok((HV::Protein(variant.clone()), vec![])),
};
// Apply normalization based on edit type
let normalized_edit = match edit {
ProteinEdit::Deletion { sequence, count } => {
// Check for redundant sequence that matches the position
if let Some(seq) = sequence {
if self.is_redundant_protein_deletion_sequence(&variant.loc_edit.location, seq)
{
// Remove redundant sequence
ProteinEdit::Deletion {
sequence: None,
count: *count,
}
} else {
edit.clone()
}
} else {
edit.clone()
}
}
// Other edits pass through unchanged
_ => edit.clone(),
};
// Only create a new variant if the edit changed
if &normalized_edit != edit {
let new_variant = ProteinVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| normalized_edit),
),
};
Ok((HV::Protein(new_variant), vec![]))
} else {
Ok((HV::Protein(variant.clone()), vec![]))
}
}
/// Validate that the amino acids in a protein variant match the reference
///
/// Returns an error if there's a mismatch between the variant's stated
/// amino acid(s) and the actual reference protein sequence.
fn validate_protein_reference(
&self,
variant: &crate::hgvs::variant::ProteinVariant,
) -> Result<(), FerroError> {
use crate::hgvs::edit::ProteinEdit;
let accession = variant.accession.transcript_accession();
// Get start and end positions
let start_pos = match variant.loc_edit.location.start.inner() {
Some(pos) => pos,
None => return Ok(()), // Can't validate uncertain positions
};
let end_pos = match variant.loc_edit.location.end.inner() {
Some(pos) => pos,
None => return Ok(()),
};
// Get the edit to know what amino acids to validate
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return Ok(()),
};
// Only validate edits that specify reference amino acids
match edit {
ProteinEdit::Substitution { .. } => {
// For substitutions, the reference AA comes from the position (start_pos.aa),
// not from the edit (which may be Xaa placeholder)
self.validate_protein_position(&accession, start_pos.number, &start_pos.aa)?;
}
ProteinEdit::Deletion { .. } => {
// Validate start position (from the interval's start AA)
self.validate_protein_position(&accession, start_pos.number, &start_pos.aa)?;
// Validate end position if different
if end_pos.number != start_pos.number {
self.validate_protein_position(&accession, end_pos.number, &end_pos.aa)?;
}
}
ProteinEdit::Duplication => {
// Validate start and end positions
self.validate_protein_position(&accession, start_pos.number, &start_pos.aa)?;
if end_pos.number != start_pos.number {
self.validate_protein_position(&accession, end_pos.number, &end_pos.aa)?;
}
}
ProteinEdit::Insertion { .. } => {
// Validate flanking positions
self.validate_protein_position(&accession, start_pos.number, &start_pos.aa)?;
self.validate_protein_position(&accession, end_pos.number, &end_pos.aa)?;
}
ProteinEdit::Delins { .. } => {
// Validate start and end
self.validate_protein_position(&accession, start_pos.number, &start_pos.aa)?;
if end_pos.number != start_pos.number {
self.validate_protein_position(&accession, end_pos.number, &end_pos.aa)?;
}
}
ProteinEdit::Frameshift { .. } => {
// Validate the frameshift position
self.validate_protein_position(&accession, start_pos.number, &start_pos.aa)?;
}
ProteinEdit::Extension { .. } => {
// Extension typically at Ter position - validate
self.validate_protein_position(&accession, start_pos.number, &start_pos.aa)?;
}
_ => {
// Identity, Unknown, etc. - no validation needed
}
}
Ok(())
}
/// Validate a single protein position against reference
fn validate_protein_position(
&self,
accession: &str,
position: u64,
expected_aa: &crate::hgvs::location::AminoAcid,
) -> Result<(), FerroError> {
// Position is 1-based in HGVS, convert to 0-based for sequence access
// get_protein_sequence uses half-open interval [start, end)
let start = hgvs_pos_to_index(position) as u64;
let end = position; // exclusive end
// Try to get the reference amino acid
match self.provider.get_protein_sequence(accession, start, end) {
Ok(ref_seq) => {
if ref_seq.len() != 1 {
return Ok(()); // Unexpected, skip validation
}
let ref_aa_char = ref_seq.chars().next().unwrap();
let expected_char = expected_aa.to_one_letter();
if ref_aa_char != expected_char {
return Err(FerroError::AminoAcidMismatch {
accession: accession.to_string(),
position,
expected: expected_aa.to_string(),
found: ref_aa_char.to_string(),
});
}
}
Err(_) => {
// Protein sequence not available, skip validation
}
}
Ok(())
}
/// Check if the deletion sequence is redundant (matches the position amino acids)
///
/// A deletion sequence is redundant if it exactly matches the amino acids
/// specified in the interval. For example:
/// - `p.Val600delVal` - sequence [Val] matches position 600's Val → redundant
/// - `p.Lys23_Leu24delLysLeu` - sequence [Lys, Leu] matches positions 23-24 → redundant
fn is_redundant_protein_deletion_sequence(
&self,
interval: &crate::hgvs::interval::ProtInterval,
sequence: &crate::hgvs::edit::AminoAcidSeq,
) -> bool {
// Get the start and end positions
let start_pos = match interval.start.inner() {
Some(pos) => pos,
None => return false,
};
let end_pos = match interval.end.inner() {
Some(pos) => pos,
None => return false,
};
// Calculate expected sequence length from interval
let interval_len = if end_pos.number >= start_pos.number {
(end_pos.number - start_pos.number + 1) as usize
} else {
return false;
};
// Check if sequence length matches
if sequence.len() != interval_len {
return false;
}
// For a point deletion (single AA), check if the sequence matches the position AA
if interval_len == 1 {
return sequence.0.len() == 1 && sequence.0[0] == start_pos.aa;
}
// For a range deletion, check first and last AAs
// The sequence should be [start_aa, ..., end_aa]
if let (Some(first), Some(last)) = (sequence.0.first(), sequence.0.last()) {
return *first == start_pos.aa && *last == end_pos.aa;
}
false
}
/// Normalize an RNA variant
///
/// RNA variants (r.) are similar to transcript variants (n.) and undergo
/// the same 3'/5' shifting normalization for indels. The main difference
/// is that RNA uses lowercase nucleotides in HGVS notation.
fn normalize_rna(
&self,
variant: &crate::hgvs::variant::RnaVariant,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
use crate::hgvs::interval::RnaInterval;
use crate::hgvs::variant::{LocEdit, RnaVariant};
// Can't normalize variants with unknown edits or positions
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return Ok((HV::Rna(variant.clone()), vec![])),
};
// SVD-WG009: rewrite `con` to `delins`.
if let Some(new_edit) = canonicalize_conversion_to_delins(edit) {
let new_variant = RnaVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| new_edit.clone()),
),
};
return Ok((HV::Rna(new_variant), vec![]));
}
// Only normalize indels
if !needs_normalization(edit) {
return Ok((HV::Rna(variant.clone()), vec![]));
}
// Check for intronic variants or unknown positions
let start_pos = match variant.loc_edit.location.start.inner() {
Some(pos) => pos,
None => return Ok((HV::Rna(variant.clone()), vec![])),
};
let end_pos = match variant.loc_edit.location.end.inner() {
Some(pos) => pos,
None => return Ok((HV::Rna(variant.clone()), vec![])),
};
if start_pos.is_intronic() || end_pos.is_intronic() {
return Err(FerroError::IntronicVariant {
variant: format!("{}", variant),
});
}
// Try to get transcript (RNA uses the same accession as mRNA transcripts)
let accession = variant.accession.transcript_accession();
let transcript = match self.provider.get_transcript(&accession) {
Ok(t) => t,
Err(_) => return Ok((HV::Rna(variant.clone()), vec![])),
};
// Convert RNA positions to transcript-1 positions, deciding per
// endpoint. UTR (`r.*N`/`r.-N`) and non-positive bases need a CDS
// to translate; non-UTR positive bases map 1:1 to transcript-1
// indices and work without a CDS (mock providers used in tests
// often omit cds_start/end). Choosing per endpoint keeps mixed
// intervals like `r.50_*1del` from rerouting the positive end
// through `rna_to_tx_pos` — issue #163 follow-up.
let cds_info = transcript.cds_start.zip(transcript.cds_end);
let map_in = |pos: &crate::hgvs::location::RnaPos| -> Option<u64> {
if pos.utr3 || pos.base < 1 {
let (cds_start, cds_end) = cds_info?;
self.rna_to_tx_pos(pos, cds_start, Some(cds_end)).ok()
} else {
Some(pos.base as u64)
}
};
let tx_start = match map_in(start_pos) {
Some(v) => v,
None => return Ok((HV::Rna(variant.clone()), vec![])),
};
let tx_end = match map_in(end_pos) {
Some(v) => v,
None => return Ok((HV::Rna(variant.clone()), vec![])),
};
// Get boundaries (entire transcript span; r. has no exon-level
// junction restriction beyond the transcript ends).
let boundaries = Boundaries::new(1, transcript.sequence_length());
// Perform normalization (RNA context: codon-frame gate does not apply;
// r. is not in the spec's accepted reference types for repeats).
// Coordinate-only transcripts fall back to the canonicalize-only path.
let seq = match transcript.sequence.as_deref() {
Some(s) => s.as_bytes(),
None => return Ok((HV::Rna(variant.clone()), vec![])),
};
let (new_tx_start, new_tx_end, new_edit, warnings) =
self.normalize_na_edit(seq, edit, tx_start, tx_end, &boundaries, false)?;
// Convert each normalized tx position back independently, restoring
// UTR notation when the position falls outside the CDS. This catches
// both the original issue #163 case (UTR input shuffling within the
// UTR) and a positive-base input that shifts past `cds_end` during
// normalization. Without `cds_info` we keep the simple base-1 mapping.
use crate::hgvs::location::RnaPos;
let map_out = |pos: u64| -> Result<RnaPos, FerroError> {
if let Some((cds_start, cds_end)) = cds_info {
if pos < cds_start || pos > cds_end {
return self.tx_to_rna_pos(pos, cds_start, Some(cds_end));
}
}
Ok(RnaPos::new(pos as i64))
};
let new_start = map_out(new_tx_start)?;
let new_end = map_out(new_tx_end)?;
let new_variant = RnaVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::new(RnaInterval::new(new_start, new_end), new_edit),
};
// Issue #160 inv sub-span split (T/U-equivalent comparison).
let split = self.apply_inv_split(HV::Rna(new_variant));
Ok((wrap_allele_if_split(split), warnings))
}
/// Convert an RNA position to a transcript-1 position.
///
/// Mirrors `cds_to_tx_pos`. `r.*N` maps to `cds_end + N`, `r.-N` to
/// `cds_start + N` (HGVS skips the `0` gap).
fn rna_to_tx_pos(
&self,
pos: &crate::hgvs::location::RnaPos,
cds_start: u64,
cds_end: Option<u64>,
) -> Result<u64, FerroError> {
if pos.utr3 {
let end = cds_end.ok_or_else(|| FerroError::ConversionError {
msg: "No CDS end".to_string(),
})?;
let base = u64::try_from(pos.base).map_err(|_| FerroError::ConversionError {
msg: format!("Negative base {} in 3' UTR position", pos.base),
})?;
Ok(end + base)
} else if pos.base < 0 {
let tx_pos = cds_start as i64 + pos.base;
u64::try_from(tx_pos).map_err(|_| FerroError::ConversionError {
msg: format!(
"RNA position r.{} maps before transcript start (cds_start={})",
pos.base, cds_start
),
})
} else if pos.base == 0 {
Ok(cds_start.saturating_sub(1))
} else {
Ok(cds_start + pos.base as u64 - 1)
}
}
/// Convert a transcript-1 position back to an RNA position, restoring
/// the appropriate region (`r.*N` for 3'UTR, `r.-N` for 5'UTR).
fn tx_to_rna_pos(
&self,
pos: u64,
cds_start: u64,
cds_end: Option<u64>,
) -> Result<crate::hgvs::location::RnaPos, FerroError> {
use crate::hgvs::location::RnaPos;
let end = cds_end.ok_or_else(|| FerroError::ConversionError {
msg: "No CDS end".to_string(),
})?;
if pos < cds_start {
Ok(RnaPos {
base: pos as i64 - cds_start as i64,
offset: None,
utr3: false,
})
} else if pos > end {
Ok(RnaPos {
base: (pos - end) as i64,
offset: None,
utr3: true,
})
} else {
Ok(RnaPos {
base: (pos - cds_start + 1) as i64,
offset: None,
utr3: false,
})
}
}
/// Normalize a mitochondrial variant
fn normalize_mt(
&self,
variant: &crate::hgvs::variant::MtVariant,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
// MT variants are similar to genomic. We canonicalize `con` -> `delins`
// (SVD-WG009) up front, then route through apply_inv_split so any
// delins whose ref/alt span contains an inv-eligible sub-span
// decomposes the same way it does for g. (issue #160). Full
// window-based normalization and the per-edit canonicalization that
// runs inside normalize_na_edit for g./c./n./r. is not yet wired up
// for m. (would also need circular genome handling) — that gap is
// pre-existing and out of scope here.
if let Some(edit) = variant.loc_edit.edit.inner() {
if let Some(new_edit) = canonicalize_conversion_to_delins(edit) {
let new_variant = MtVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| new_edit.clone()),
),
};
let split = self.apply_inv_split(HV::Mt(new_variant));
return Ok((wrap_allele_if_split(split), vec![]));
}
}
let split = self.apply_inv_split(HV::Mt(variant.clone()));
Ok((wrap_allele_if_split(split), vec![]))
}
/// Normalize an intronic CDS variant
///
/// This converts the intronic position to genomic coordinates, normalizes
/// in genomic space, and converts back to CDS intronic notation.
fn normalize_intronic_cds(
&self,
variant: &CdsVariant,
transcript: &crate::reference::transcript::Transcript,
start_pos: &CdsPos,
end_pos: &CdsPos,
edit: &NaEdit,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
use crate::convert::CoordinateMapper;
// Check if we have genomic data available
if !self.provider.has_genomic_data() {
return Err(FerroError::IntronicVariant {
variant: format!("{}", variant),
});
}
// Get the chromosome for this transcript
let chromosome =
transcript
.chromosome
.as_ref()
.ok_or_else(|| FerroError::ConversionError {
msg: "Transcript has no chromosome mapping for intronic normalization"
.to_string(),
})?;
// Create coordinate mapper
let mapper = CoordinateMapper::new(transcript);
// Convert CDS intronic positions to genomic
let g_start = mapper.cds_to_genomic_with_intron(start_pos)?;
let g_end = mapper.cds_to_genomic_with_intron(end_pos)?;
// On minus strand, genomic coords may be reversed relative to coding order.
// Track whether we swap so we can restore coding order after normalization.
let swapped = g_start > g_end;
let (g_start, g_end) = if swapped {
(g_end, g_start)
} else {
(g_start, g_end)
};
// Get a window of genomic sequence around the variant for normalization
// Use the same window size as for exonic normalization
let window = self.config.window_size;
let seq_start = g_start.saturating_sub(window);
let seq_end = g_end.saturating_add(window);
// Fetch genomic sequence
let genomic_seq = self
.provider
.get_genomic_sequence(chromosome, seq_start, seq_end)?;
// Calculate the variant position relative to the fetched sequence
let rel_start = (g_start - seq_start) + 1; // 1-based
let rel_end = (g_end - seq_start) + 1;
// Define boundaries within the intron
// For intronic variants, we can shift within the intron but not into exons
// Find the intron boundaries
// Use exon-aware CDS-to-tx mapping to account for cdot's gap positions
let tx_pos = mapper.cds_to_tx(start_pos)?;
let tx_start = u64::try_from(tx_pos.base).map_err(|_| FerroError::ConversionError {
msg: format!(
"Negative transcript position {} during intronic normalization",
tx_pos.base
),
})?;
let intron = transcript
.find_intron_at_tx_boundary(tx_start, start_pos.offset.unwrap_or(0))
.ok_or_else(|| FerroError::ConversionError {
msg: "Could not find intron for normalization".to_string(),
})?;
// Get intron boundaries in genomic coordinates
let (intron_g_start, intron_g_end) = match (intron.genomic_start, intron.genomic_end) {
(Some(s), Some(e)) => (s, e),
_ => {
return Err(FerroError::ConversionError {
msg: "Intron has no genomic coordinates".to_string(),
})
}
};
// Calculate relative intron boundaries
let intron_rel_start = intron_g_start.saturating_sub(seq_start) + 1;
let intron_rel_end = intron_g_end.saturating_sub(seq_start) + 1;
let boundaries = Boundaries::new(intron_rel_start, intron_rel_end);
// On minus-strand transcripts the genomic-strand sequence is the
// reverse complement of the transcript view, but the variant's
// edit alt is in transcript view. Running `normalize_na_edit` on
// the genomic-strand bytes therefore defeats every rule that
// compares the alt against the local reference window. Flip the
// sequence and the relative positions / boundaries to transcript
// view here, run normalization, then map the result positions
// back to the genomic frame. (Issue #98.)
let (work_seq, work_rel_start, work_rel_end, work_boundaries) = flip_intronic_for_strand(
transcript.strand,
&genomic_seq,
rel_start,
rel_end,
&boundaries,
);
// Perform normalization in transcript-view space (CDS intronic context).
let seq_bytes = work_seq.as_bytes();
let (work_new_rel_start, work_new_rel_end, new_edit, warnings) = self.normalize_na_edit(
seq_bytes,
edit,
work_rel_start,
work_rel_end,
&work_boundaries,
true,
)?;
// Map the result positions back to the genomic-strand frame
let (new_rel_start, new_rel_end) = unflip_intronic_positions(
transcript.strand,
work_seq.len() as u64,
work_new_rel_start,
work_new_rel_end,
);
// Convert the normalized genomic position back to absolute genomic
let new_g_start = seq_start + new_rel_start - 1;
let new_g_end = seq_start + new_rel_end - 1;
// Convert back to CDS intronic notation
let new_start = mapper.genomic_to_cds_intronic(new_g_start)?;
let new_end = mapper.genomic_to_cds_intronic(new_g_end)?;
// Restore coding order if positions were swapped for genomic processing
let (new_start, new_end) = if swapped {
(new_end, new_start)
} else {
(new_start, new_end)
};
let new_variant = CdsVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::new(Interval::new(new_start, new_end), new_edit),
};
Ok((HV::Cds(new_variant), warnings))
}
/// Normalize an intronic transcript (n.) variant
///
/// This mirrors `normalize_intronic_cds()` but works with TxPos instead of CdsPos.
/// Converts to genomic coordinates, normalizes in genomic space, and converts back.
fn normalize_intronic_tx(
&self,
variant: &TxVariant,
transcript: &crate::reference::transcript::Transcript,
start_pos: &TxPos,
end_pos: &TxPos,
edit: &NaEdit,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
use crate::convert::CoordinateMapper;
// Check if we have genomic data available
if !self.provider.has_genomic_data() {
return Err(FerroError::IntronicVariant {
variant: format!("{}", variant),
});
}
// Get the chromosome for this transcript
let chromosome =
transcript
.chromosome
.as_ref()
.ok_or_else(|| FerroError::ConversionError {
msg: "Transcript has no chromosome mapping for intronic normalization"
.to_string(),
})?;
// Create coordinate mapper
let mapper = CoordinateMapper::new(transcript);
// Convert tx intronic positions to genomic
let g_start = mapper.tx_to_genomic_with_intron(start_pos)?;
let g_end = mapper.tx_to_genomic_with_intron(end_pos)?;
// On minus strand, genomic coords may be reversed relative to coding order.
// Track whether we swap so we can restore coding order after normalization.
let swapped = g_start > g_end;
let (g_start, g_end) = if swapped {
(g_end, g_start)
} else {
(g_start, g_end)
};
// Get a window of genomic sequence around the variant
let window = self.config.window_size;
let seq_start = g_start.saturating_sub(window);
let seq_end = g_end.saturating_add(window);
// Fetch genomic sequence
let genomic_seq = self
.provider
.get_genomic_sequence(chromosome, seq_start, seq_end)?;
// Calculate the variant position relative to the fetched sequence
let rel_start = (g_start - seq_start) + 1; // 1-based
let rel_end = (g_end - seq_start) + 1;
// Find the intron boundaries for normalization limits
let tx_start = u64::try_from(start_pos.base).map_err(|_| FerroError::ConversionError {
msg: format!(
"Negative transcript position {} during intronic normalization",
start_pos.base
),
})?;
let intron = transcript
.find_intron_at_tx_boundary(tx_start, start_pos.offset.unwrap_or(0))
.ok_or_else(|| FerroError::ConversionError {
msg: "Could not find intron for normalization".to_string(),
})?;
// Get intron boundaries in genomic coordinates
let (intron_g_start, intron_g_end) = match (intron.genomic_start, intron.genomic_end) {
(Some(s), Some(e)) => (s, e),
_ => {
return Err(FerroError::ConversionError {
msg: "Intron has no genomic coordinates".to_string(),
})
}
};
// Calculate relative intron boundaries
let intron_rel_start = intron_g_start.saturating_sub(seq_start) + 1;
let intron_rel_end = intron_g_end.saturating_sub(seq_start) + 1;
let boundaries = Boundaries::new(intron_rel_start, intron_rel_end);
// See `normalize_intronic_cds`: same orientation fix for #98.
let (work_seq, work_rel_start, work_rel_end, work_boundaries) = flip_intronic_for_strand(
transcript.strand,
&genomic_seq,
rel_start,
rel_end,
&boundaries,
);
// Perform normalization in transcript-view space (n. non-coding intronic context).
let seq_bytes = work_seq.as_bytes();
let (work_new_rel_start, work_new_rel_end, new_edit, warnings) = self.normalize_na_edit(
seq_bytes,
edit,
work_rel_start,
work_rel_end,
&work_boundaries,
false,
)?;
// Map the result positions back to the genomic-strand frame
let (new_rel_start, new_rel_end) = unflip_intronic_positions(
transcript.strand,
work_seq.len() as u64,
work_new_rel_start,
work_new_rel_end,
);
// Convert the normalized genomic position back to absolute genomic
let new_g_start = seq_start + new_rel_start - 1;
let new_g_end = seq_start + new_rel_end - 1;
// Convert back to transcript intronic notation
let new_start = mapper.genomic_to_tx_with_intron(new_g_start)?;
let new_end = mapper.genomic_to_tx_with_intron(new_g_end)?;
// Restore coding order if positions were swapped for genomic processing
let (new_start, new_end) = if swapped {
(new_end, new_start)
} else {
(new_start, new_end)
};
let new_variant = TxVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::new(Interval::new(new_start, new_end), new_edit),
};
Ok((HV::Tx(new_variant), warnings))
}
/// Normalize a CDS variant that spans an exon-intron boundary
///
/// This handles cases like:
/// - c.914_918+3del (exonic start, intronic end)
/// - c.194-64_233del (intronic start, exonic end)
///
/// Strategy: Convert to genomic coordinates, normalize there, convert back.
fn normalize_boundary_spanning_cds(
&self,
variant: &CdsVariant,
transcript: &crate::reference::transcript::Transcript,
start_pos: &CdsPos,
end_pos: &CdsPos,
edit: &NaEdit,
) -> Result<(HgvsVariant, Vec<NormalizationWarning>), FerroError> {
use crate::convert::CoordinateMapper;
// Require genomic data for boundary spanning normalization
if !self.provider.has_genomic_data() {
return Err(FerroError::ExonIntronBoundary {
exon: 0,
variant: format!("{}", variant),
});
}
let chromosome =
transcript
.chromosome
.as_ref()
.ok_or_else(|| FerroError::ConversionError {
msg: "Transcript has no chromosome for boundary normalization".to_string(),
})?;
let mapper = CoordinateMapper::new(transcript);
// Convert both positions to genomic
// For exonic positions, use standard conversion
// For intronic positions, use intronic conversion
let g_start = self.cds_pos_to_genomic(&mapper, start_pos)?;
let g_end = self.cds_pos_to_genomic(&mapper, end_pos)?;
// On minus strand, genomic coords may be reversed relative to coding order.
// Track whether we swap so we can restore coding order after normalization.
let swapped = g_start > g_end;
let (g_start, g_end) = if swapped {
(g_end, g_start)
} else {
(g_start, g_end)
};
// Fetch genomic sequence with window for normalization
let window = self.config.window_size;
let seq_start = g_start.saturating_sub(window);
let seq_end = g_end.saturating_add(window);
let genomic_seq = self
.provider
.get_genomic_sequence(chromosome, seq_start, seq_end)?;
// Calculate relative positions (1-based)
let rel_start = (g_start - seq_start) + 1;
let rel_end = (g_end - seq_start) + 1;
// Determine normalization boundaries
// For boundary-spanning variants, use the union of exon and intron boundaries
let boundaries =
self.get_boundary_spanning_limits(transcript, &mapper, start_pos, end_pos, seq_start)?;
// On minus-strand transcripts the genomic-strand window is the
// reverse complement of the transcript view, but the variant's edit
// alt is in transcript view. Running `normalize_na_edit` on raw
// genomic bytes therefore canonicalizes against the wrong alphabet
// (and the codon-frame repeat gate inspects ref context here too).
// Mirror the intronic flow: flip into transcript view before
// normalization, then unflip the result positions back to the
// genomic frame. (CDS boundary-spanning context.)
let (work_seq, work_rel_start, work_rel_end, work_boundaries) = flip_intronic_for_strand(
transcript.strand,
&genomic_seq,
rel_start,
rel_end,
&boundaries,
);
let seq_bytes = work_seq.as_bytes();
let (work_new_rel_start, work_new_rel_end, new_edit, warnings) = self.normalize_na_edit(
seq_bytes,
edit,
work_rel_start,
work_rel_end,
&work_boundaries,
true,
)?;
let (new_rel_start, new_rel_end) = unflip_intronic_positions(
transcript.strand,
work_seq.len() as u64,
work_new_rel_start,
work_new_rel_end,
);
// Convert back to absolute genomic
let new_g_start = seq_start + new_rel_start - 1;
let new_g_end = seq_start + new_rel_end - 1;
// Convert genomic back to CDS
// The result might be:
// - Still boundary-spanning
// - Fully exonic (if shifted into exon)
// - Fully intronic (if shifted into intron)
let new_start = mapper.genomic_to_cds_intronic(new_g_start)?;
let new_end = mapper.genomic_to_cds_intronic(new_g_end)?;
// Restore coding order if positions were swapped for genomic processing
let (new_start, new_end) = if swapped {
(new_end, new_start)
} else {
(new_start, new_end)
};
let new_variant = CdsVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::new(Interval::new(new_start, new_end), new_edit),
};
Ok((HV::Cds(new_variant), warnings))
}
/// Convert a CDS position (exonic or intronic) to genomic coordinate
fn cds_pos_to_genomic(
&self,
mapper: &crate::convert::CoordinateMapper,
pos: &CdsPos,
) -> Result<u64, FerroError> {
if pos.is_intronic() {
mapper.cds_to_genomic_with_intron(pos)
} else {
mapper
.cds_to_genomic(pos)?
.ok_or_else(|| FerroError::ConversionError {
msg: format!("CDS position {} not in exons", pos.base),
})
}
}
/// Calculate normalization boundaries for boundary-spanning variants
///
/// Returns the genomic region within which we can shift the variant,
/// which is the union of the exon and intron containing the variant ends.
fn get_boundary_spanning_limits(
&self,
transcript: &crate::reference::transcript::Transcript,
mapper: &crate::convert::CoordinateMapper,
start_pos: &CdsPos,
end_pos: &CdsPos,
seq_start: u64,
) -> Result<Boundaries, FerroError> {
// Find the genomic extent of the region we can shift within
// This is the union of:
// - The exon containing the exonic position
// - The intron containing the intronic position
// Identify which position is exonic and which is intronic
let (exonic_pos, intronic_pos) = if start_pos.is_intronic() {
(end_pos, start_pos)
} else {
(start_pos, end_pos)
};
// Get exon boundaries in genomic coords
let tx_pos = mapper.cds_to_tx(exonic_pos)?;
let tx_pos_base = u64::try_from(tx_pos.base).map_err(|_| FerroError::ConversionError {
msg: format!(
"Negative transcript position {} during boundary normalization",
tx_pos.base
),
})?;
let exon = transcript
.exon_at(tx_pos_base)
.ok_or_else(|| FerroError::ConversionError {
msg: "Could not find exon for boundary normalization".to_string(),
})?;
// Get intron boundaries in genomic coords
let tx_boundary = mapper.cds_to_tx(intronic_pos)?;
let tx_boundary_base =
u64::try_from(tx_boundary.base).map_err(|_| FerroError::ConversionError {
msg: format!(
"Negative transcript position {} during boundary normalization",
tx_boundary.base
),
})?;
let offset = intronic_pos.offset.unwrap_or(0);
let intron = transcript
.find_intron_at_tx_boundary(tx_boundary_base, offset)
.ok_or_else(|| FerroError::ConversionError {
msg: "Could not find intron for boundary normalization".to_string(),
})?;
// Get genomic coordinates from exon and intron
let (exon_g_start, exon_g_end): (u64, u64) = match (exon.genomic_start, exon.genomic_end) {
(Some(s), Some(e)) => (s, e),
_ => {
return Err(FerroError::ConversionError {
msg: "Exon has no genomic coordinates".to_string(),
})
}
};
let (intron_g_start, intron_g_end): (u64, u64) =
match (intron.genomic_start, intron.genomic_end) {
(Some(s), Some(e)) => (s, e),
_ => {
return Err(FerroError::ConversionError {
msg: "Intron has no genomic coordinates".to_string(),
})
}
};
// Union of exon and intron genomic coordinates
let combined_start = exon_g_start.min(intron_g_start);
let combined_end = exon_g_end.max(intron_g_end);
// Convert to relative positions (1-based within our fetched sequence)
let rel_start = combined_start.saturating_sub(seq_start) + 1;
let rel_end = combined_end.saturating_sub(seq_start) + 1;
Ok(Boundaries::new(rel_start, rel_end))
}
/// Core normalization for nucleic acid edits
///
/// Returns (new_start, new_end, new_edit, warnings)
fn normalize_na_edit(
&self,
ref_seq: &[u8],
edit: &NaEdit,
start: u64,
end: u64,
boundaries: &Boundaries,
is_coding: bool,
) -> Result<(u64, u64, NaEdit, Vec<NormalizationWarning>), FerroError> {
let mut warnings = Vec::new();
// Validate reference allele before normalization
let validation = validate::validate_reference(edit, ref_seq, start, end);
if !validation.valid {
warnings.push(NormalizationWarning::RefSeqMismatch {
message: validation.warning.unwrap_or_default(),
stated_ref: validation.stated_ref.unwrap_or_default(),
actual_ref: validation.actual_ref.unwrap_or_default(),
position: format!("{}-{}", start, end),
corrected: true,
});
}
// Substitution with ref == alt is identity (e.g. c.100A>A → c.100=).
// This is the SNV companion to the same-base delins → identity rule;
// the rewrite is purely syntactic on the edit's stated bases, so it
// applies across coordinate systems and runs before shuffling.
if let NaEdit::Substitution {
reference,
alternative,
} = edit
{
if reference == alternative {
return Ok((start, end, NaEdit::position_identity(), warnings));
}
}
// Get the alternate sequence for the edit
let alt_seq = match edit {
NaEdit::Deletion { .. } => vec![],
NaEdit::Insertion { sequence } => {
// Only shuffle if we have a literal sequence
if let Some(bases) = sequence.bases() {
bases.iter().map(|b| b.to_u8()).collect()
} else {
// Cannot shuffle non-literal insertions (counts, ranges, etc.)
return Ok((start, end, edit.clone(), warnings.clone()));
}
}
NaEdit::Duplication { sequence, .. } => {
if let Some(seq) = sequence {
seq.bases().iter().map(|b| b.to_u8()).collect()
} else {
// Get duplicated sequence from reference
// start is 1-based, convert to 0-based index for array access
let s = hgvs_pos_to_index(start);
let e = end as usize;
if e <= ref_seq.len() {
ref_seq[s..e].to_vec()
} else {
vec![]
}
}
}
NaEdit::Delins { sequence, .. } => {
use crate::hgvs::edit::InsertedSequence;
// HGVS spec (issue #81 A3): a delins with an empty inserted
// sequence is semantically a deletion and must be rendered as
// `del`. Rewrite up-front so the result picks up del 3'-shift
// and validation in the Deletion arm.
if matches!(sequence, InsertedSequence::Empty) {
let del = NaEdit::Deletion {
sequence: None,
length: None,
};
return self
.normalize_na_edit(ref_seq, &del, start, end, boundaries, is_coding);
}
// HGVS spec: delins should NOT be 3' shifted like del/dup/ins,
// but the edit-type priority (sub > del > inv > dup > ins) means
// we may need to rewrite it as a higher-priority form: identity
// (insert == ref), substitution (1->1 ref!=alt), or duplication.
if let InsertedSequence::Literal(seq) = sequence {
use crate::hgvs::edit::{Base, Sequence};
use rules::DelinsCanonical;
let seq_bytes: Vec<u8> = seq.bases().iter().map(|b| *b as u8).collect();
let start_idx = hgvs_pos_to_index(start);
let end_idx = end as usize;
// Reconstruct an InsertedSequence from a Vec<u8> produced by
// shared-affix trimming. The bytes round-trip through `Base`
// because they originated from a typed `Sequence` (the input
// `seq` above), so `from_char` cannot fail; expect-on-None
// makes the invariant explicit if a future refactor breaks
// the pipeline.
let bytes_to_inserted_seq = |bytes: &[u8]| -> InsertedSequence {
let bases: Vec<Base> = bytes
.iter()
.map(|b| {
Base::from_char(*b as char).expect(
"trimmed delins byte must be a valid IUPAC base \
because the input sequence was already a typed Sequence",
)
})
.collect();
InsertedSequence::Literal(Sequence::new(bases))
};
match rules::canonicalize_delins(ref_seq, start_idx, end_idx, &seq_bytes) {
DelinsCanonical::Identity => {
// c.10delinsG where ref[10]=G -> c.10=
return Ok((start, end, NaEdit::position_identity(), warnings.clone()));
}
DelinsCanonical::Substitution {
position,
reference,
alternative,
} => {
// g.1000delinsA where ref[1000]=G -> g.1000G>A.
// After shared-affix trimming `position` is a
// 0-indexed offset into ref_seq, not necessarily
// the input `start`.
let pos = index_to_hgvs_pos(position);
return Ok((
pos,
pos,
NaEdit::Substitution {
reference,
alternative,
},
warnings.clone(),
));
}
DelinsCanonical::Deletion { start: s0, end: e0 } => {
// c.2_5delinsAT (ref ACGT) -> c.3_4del. Range fields
// are the trimmed half-open 0-indexed interval.
return Ok((
index_to_hgvs_pos(s0),
e0 as u64,
NaEdit::Deletion {
sequence: None,
length: None,
},
warnings.clone(),
));
}
DelinsCanonical::Insertion {
after_index,
sequence: ins_bytes,
} => {
// c.2_4delinsACGT (ref ACT) -> c.3_4insG. `after_index`
// is the 0-indexed position of the base AFTER the
// insertion, which is also the 1-based HGVS position
// of the base BEFORE — so HGVS X = after_index,
// Y = after_index + 1.
return Ok((
after_index as u64,
(after_index + 1) as u64,
NaEdit::Insertion {
sequence: bytes_to_inserted_seq(&ins_bytes),
},
warnings.clone(),
));
}
DelinsCanonical::Inversion { start: s0, end: e0 } => {
// A2 (#81): g.100_102delinsTAG where ref=CTA -> g.100_102inv.
// Position interval is already shortened. e0 is the
// exclusive 0-based end; the HGVS 1-based inclusive
// end takes the same numeric value.
return Ok((
index_to_hgvs_pos(s0),
e0 as u64,
NaEdit::Inversion {
sequence: None,
length: None,
},
warnings.clone(),
));
}
DelinsCanonical::Duplication { start: s0, end: e0 } => {
// c.5delinsGG where ref[5]=G -> c.5dup. Duplication
// is detected before trimming, so the range matches
// the input.
return Ok((
index_to_hgvs_pos(s0),
e0 as u64,
NaEdit::Duplication {
sequence: None,
length: None,
uncertain_extent: None,
},
warnings.clone(),
));
}
DelinsCanonical::KeepAsDelins {
start: s0,
end: e0,
sequence: trimmed_bytes,
} => {
// Either no trimming was possible (range == input)
// or trimming reduced the delins to a smaller delins
// that still doesn't fit a higher-priority form.
return Ok((
index_to_hgvs_pos(s0),
e0 as u64,
NaEdit::Delins {
sequence: bytes_to_inserted_seq(&trimmed_bytes),
deleted: None,
deleted_length: None,
},
warnings.clone(),
));
}
}
}
// Non-literal insert (Count, Range, etc.): cannot trim or
// classify without the actual bases; return unchanged.
return Ok((start, end, edit.clone(), warnings.clone()));
}
NaEdit::Inversion { .. } => {
// Apply the complementary-outer-bases shortening rule. After
// shortening, the inversion's interval may no longer match the
// input's explicit `sequence`/`length` (if any), so emit
// minimal notation.
let start_idx = hgvs_pos_to_index(start); // Convert 1-based to 0-based
let end_idx = end as usize; // end is exclusive (0-based)
if let Some((new_s, new_e)) = rules::shorten_inversion(ref_seq, start_idx, end_idx)
{
return Ok((
index_to_hgvs_pos(new_s),
new_e as u64,
NaEdit::Inversion {
sequence: None,
length: None,
},
warnings,
));
} else {
// Inversion reduced to identity. Use the canonical
// position-only Identity (matches the Delins identity arm
// above), so both inversion-collapse paths emit the same
// shape.
return Ok((start, end, NaEdit::position_identity(), warnings));
}
}
NaEdit::Repeat {
sequence,
count,
additional_counts,
trailing,
} => {
use crate::hgvs::edit::RepeatCount;
// Only normalize exact counts with a sequence
let Some(seq) = sequence else {
return Ok((start, end, edit.clone(), warnings.clone()));
};
let RepeatCount::Exact(specified_count) = count else {
return Ok((start, end, edit.clone(), warnings.clone()));
};
// Skip if there are additional counts (genotype notation)
if !additional_counts.is_empty() || trailing.is_some() {
return Ok((start, end, edit.clone(), warnings.clone()));
}
// Get the repeat unit as bytes
let repeat_unit: Vec<u8> = seq.bases().iter().map(|b| b.to_u8()).collect();
let pos_idx = hgvs_pos_to_index(start); // Convert 1-based to 0-based
// Normalize the repeat
match rules::normalize_repeat(
ref_seq,
pos_idx,
&repeat_unit,
*specified_count,
is_coding,
) {
rules::RepeatNormResult::Deletion {
start: del_start,
end: del_end,
} => {
// Minimal notation - no explicit length
let del_edit = NaEdit::Deletion {
sequence: None,
length: None,
};
return Ok((del_start, del_end, del_edit, warnings));
}
rules::RepeatNormResult::Duplication {
start: dup_start,
end: dup_end,
sequence: _dup_seq,
} => {
// Minimal notation - no explicit sequence or length
let dup_edit = NaEdit::Duplication {
sequence: None,
length: None,
uncertain_extent: None,
};
return Ok((dup_start, dup_end, dup_edit, warnings));
}
rules::RepeatNormResult::Insertion {
start: ins_start,
end: ins_end,
sequence: ins_seq,
} => {
// Codon-frame gate routed an expansion to ins literal form
// (e.g., c.1741_1742insTATATATA per spec).
use crate::hgvs::edit::{Base, InsertedSequence, Sequence};
let bases: Vec<Base> = ins_seq
.iter()
.filter_map(|&b| Base::from_char(b as char))
.collect();
if bases.len() == ins_seq.len() {
let ins_edit = NaEdit::Insertion {
sequence: InsertedSequence::Literal(Sequence::new(bases)),
};
return Ok((ins_start, ins_end, ins_edit, warnings));
}
// Defensive fallback: rule layer returned a base byte
// that doesn't fit the Base alphabet (e.g. N). Don't
// emit a truncated insertion — keep the original edit
// and positions so downstream invariants hold.
return Ok((start, end, edit.clone(), warnings));
}
rules::RepeatNormResult::Repeat {
start: rep_start,
end: rep_end,
sequence: rep_seq,
count: rep_count,
} => {
use crate::hgvs::edit::{Base, RepeatCount, Sequence};
let bases: Vec<Base> = rep_seq
.iter()
.filter_map(|&b| Base::from_char(b as char))
.collect();
if bases.len() == rep_seq.len() {
let rep_edit = NaEdit::Repeat {
sequence: Some(Sequence::new(bases)),
count: RepeatCount::Exact(rep_count),
additional_counts: vec![],
trailing: None,
};
return Ok((rep_start, rep_end, rep_edit, warnings));
}
// Defensive fallback: rule layer returned a repeat
// unit byte that doesn't fit the Base alphabet (e.g.
// a gap or non-IUPAC byte from the reference). Don't
// emit a truncated repeat sequence — keep the
// original edit and positions.
return Ok((start, end, edit.clone(), warnings));
}
rules::RepeatNormResult::Unchanged => {
return Ok((start, end, edit.clone(), warnings.clone()));
}
}
}
_ => return Ok((start, end, edit.clone(), warnings.clone())), // Other edits don't need shuffling
};
// Perform shuffle
// For insertions, the HGVS interval X_Y (where Y = X+1) represents flanking positions.
// We need to adjust the end coordinate so shuffle checks the correct reference position.
// For c.445_446insA: start=634, end=635 (1-based tx coords)
// We want shuffle to check ref_seq[634-1] = ref_seq[633] for first flanking
// and ref_seq[635-1] = ref_seq[634] for second flanking (the position to check for 3' shift)
//
// For insertions, we need to adjust the start passed to shuffle so that the alt_idx
// calculation starts at 0 (not 1). The shuffle's alt_idx formula is:
// alt_idx = (new_end - start) % alt_seq.len()
// For insertions, new_end starts at shuffle_end (which is end - 1 for insertions).
// If we pass start_idx directly, alt_idx = (end-1) - start_idx = 1 (wrong, should be 0).
// By passing start_idx + 1, we get alt_idx = (end-1) - (start_idx+1) = 0 (correct).
let shuffle_end = match edit {
NaEdit::Insertion { .. } => end.saturating_sub(1), // Use second flanking position
_ => end,
};
let start_idx = hgvs_pos_to_index(start); // Convert 1-based to 0-based
let shuffle_start = match edit {
NaEdit::Insertion { .. } => start_idx as u64 + 1, // Adjust so alt_idx starts at 0
_ => start_idx as u64,
};
let result = shuffle(
ref_seq,
&alt_seq,
shuffle_start,
shuffle_end, // Adjusted for insertions
boundaries,
self.config.shuffle_direction,
);
// Convert back to 1-based HGVS positions
// For insertions, we adjusted the start for shuffle, now adjust back
let shuffle_result_start = match edit {
NaEdit::Insertion { .. } => result.start.saturating_sub(1), // Adjust back
_ => result.start,
};
let new_start = index_to_hgvs_pos(shuffle_result_start as usize);
// For insertions, we adjusted the end for shuffle, now restore the HGVS X_(X+1) format
let new_end = match edit {
NaEdit::Insertion { .. } => index_to_hgvs_pos(result.end as usize), // Restore second flanking position
_ => result.end,
};
// Determine the canonical form for the edit
// HGVS rules:
// - Deletions ALWAYS stay as deletions (just shift 3')
// - Insertions become duplications if single-base matches adjacent
// - Multi-base insertions/dups in homopolymer become repeat notation
let (final_start, final_end, new_edit) = match edit {
NaEdit::Insertion { sequence } => {
use crate::hgvs::edit::{InsertedSequence, RepeatCount, Sequence};
if let InsertedSequence::Literal(seq) = sequence {
let seq_bytes: Vec<u8> = seq.bases().iter().map(|b| *b as u8).collect();
// Check for repeat notation first (multi-base homopolymer insertion)
// Use the ORIGINAL position (start), not shuffled position (result.start)
// because repeat notation refers to the reference tract position
if seq_bytes.len() > 1 {
let original_pos_idx = hgvs_pos_to_index(start) as u64; // 0-based original position
if let Some((_first, count, rep_start, rep_end, unit_bytes)) =
rules::insertion_to_repeat(
ref_seq,
original_pos_idx,
&seq_bytes,
is_coding,
)
{
use crate::hgvs::edit::Base;
let bases: Vec<Base> = unit_bytes
.iter()
.filter_map(|&b| Base::from_char(b as char))
.collect();
if bases.len() == unit_bytes.len() {
let repeat_seq = Sequence::new(bases);
let repeat_edit = NaEdit::Repeat {
sequence: Some(repeat_seq),
count: RepeatCount::Exact(count),
additional_counts: vec![],
trailing: None,
};
return Ok((rep_start, rep_end, repeat_edit, warnings));
}
}
}
// Resolve insertion → duplication canonicalization. Three candidate
// dup positions compete; we pick by the rules below in order.
//
// (a) Tract-aligned dup via `insertion_to_duplication` (uses the
// ORIGINAL insertion point and finds the maximal tandem run
// under any cyclic rotation of the alt). When the tract has
// `ref_count >= 2` we prefer this regardless of how far
// shuffle walked: the multi-copy tract has a meaningful phase
// that the spec-canonical form preserves (issue #132).
//
// (b) Post-shuffle simple dup via `insertion_is_duplication`. When
// shuffle walked past a single-copy tract via partial-match
// extension (e.g. TGATC abutting TGAAG — first three bases
// match but the fourth does not), the post-shuffle position is
// more 3' than (a)'s tract-aligned position and is the canonical
// answer per the 3' rule (issue #180).
//
// (c) Single-copy tract fallback (`insertion_to_duplication` with
// `ref_count == 1`). Hit when shuffle stalled before completing
// one alt rotation (so (b) doesn't find a dup at the post-
// shuffle position) but the alt does match an adjacent ref unit
// at the ORIGINAL position. Example: ins AACA abutting AACA.
//
// If none match, fall through to ins (possibly rotated).
let original_pos_idx = hgvs_pos_to_index(start) as u64;
let ins_to_dup =
rules::insertion_to_duplication(ref_seq, original_pos_idx, &seq_bytes);
// Codon-frame gate (repeated.md): in c., if the alt is
// >=2 copies of a non-codon-aligned unit, the spec
// mandates ins<literal>, not dup. The smallest-unit
// length is rotation-invariant, so we can compute it
// once from `seq_bytes` and apply the same gate at
// every dup-emission site below. In practice the gate
// never fires when `ins_to_dup` is `Some` (that helper
// only returns for single-unit alts, where
// `smallest_unit.len() == seq_bytes.len()`), but we
// guard the (a) fast path and (c) single-copy fallback
// anyway so the spec rule is explicit at each site and
// survives future changes to `insertion_to_duplication`.
let smallest_unit = rules::smallest_repeat_unit(&seq_bytes);
let codon_blocks_dup = is_coding
&& smallest_unit.len() < seq_bytes.len()
&& !smallest_unit.len().is_multiple_of(3);
if !codon_blocks_dup {
if let Some(rules::InsToDupResult {
start: dup_start,
end: dup_end,
ref_count,
..
}) = ins_to_dup.as_ref()
{
if *ref_count >= 2 {
return Ok((
*dup_start,
*dup_end,
NaEdit::Duplication {
sequence: None,
length: None,
uncertain_extent: None,
},
warnings,
));
}
}
}
// Check for simple duplication (single-base or matching adjacent)
// When shifting an insertion through a repeat region, the effective sequence
// rotates. For example, shifting "GGC" by 1 position gives "GCG".
let shift_amount =
(result.start as usize).saturating_sub(shuffle_start as usize);
let rotation = shift_amount % seq_bytes.len();
let rotated_seq: Vec<u8> = if rotation > 0 {
seq_bytes[rotation..]
.iter()
.chain(seq_bytes[..rotation].iter())
.copied()
.collect()
} else {
seq_bytes.clone()
};
if !codon_blocks_dup
&& rules::insertion_is_duplication(ref_seq, result.start, &rotated_seq)
{
// For duplication, use minimal notation without explicit sequence
// Position: for c.X_(X+1)ins that duplicates preceding sequence,
// the result is c.(X-len+1)_Xdup
let dup_len = rotated_seq.len() as u64;
let (dup_start, dup_end) = if dup_len == 1 {
(new_start, new_start) // Single position for single-base dup
} else {
// Multi-base dup: the duplicated region is BEFORE the insertion point
(new_start - dup_len + 1, new_start)
};
(
dup_start,
dup_end,
NaEdit::Duplication {
sequence: None, // Minimal notation - no explicit sequence
length: None,
uncertain_extent: None,
},
)
} else if let Some(rules::InsToDupResult {
start: dup_start,
end: dup_end,
..
}) = ins_to_dup.as_ref().filter(|_| !codon_blocks_dup)
{
// (c) Single-copy tract fallback. Reached when (a) declined
// because `ref_count < 2` and (b) declined because the post-
// shuffle rotated alt doesn't match adjacent reference. The
// alt is a (possibly rotated) tandem unit abutting a single-
// copy ref tract at the original insertion point — emit the
// dup over that tract.
(
*dup_start,
*dup_end,
NaEdit::Duplication {
sequence: None,
length: None,
uncertain_extent: None,
},
)
} else {
// Output the rotated sequence for shifted insertions
if rotation > 0 {
use crate::hgvs::edit::{Base, InsertedSequence, Sequence};
let rotated_bases: Vec<Base> = rotated_seq
.iter()
.filter_map(|&b| Base::from_char(b as char))
.collect();
// Mirror the gated-ins guard used by the
// RepeatNormResult::Insertion / GatedInsertion
// branches: if any byte fell outside the Base
// alphabet, refuse to emit a truncated `ins`
// and fall back to the original edit so
// downstream invariants hold.
if rotated_bases.len() == rotated_seq.len() {
let new_sequence =
InsertedSequence::Literal(Sequence::new(rotated_bases));
(
new_start,
new_end,
NaEdit::Insertion {
sequence: new_sequence,
},
)
} else {
(new_start, new_end, edit.clone())
}
} else {
(new_start, new_end, edit.clone())
}
}
} else {
(new_start, new_end, edit.clone())
}
}
NaEdit::Duplication { .. } => {
use crate::hgvs::edit::{Base, RepeatCount, Sequence};
// Check if duplication should become repeat notation
// Use the shuffled positions (result.start, result.end) which are 0-based
// This applies to both single-base dups in homopolymers and multi-base tandem dups
if let Some(dup_result) =
rules::duplication_to_repeat(ref_seq, result.start, result.end, is_coding)
{
match dup_result {
rules::DupToRepeatResult::Homopolymer {
base,
count,
start: rep_start,
end: rep_end,
} => {
if let Some(base_enum) = Base::from_char(base as char) {
let repeat_seq = Sequence::new(vec![base_enum]);
let repeat_edit = NaEdit::Repeat {
sequence: Some(repeat_seq),
count: RepeatCount::Exact(count),
additional_counts: vec![],
trailing: None,
};
return Ok((rep_start, rep_end, repeat_edit, warnings));
}
}
rules::DupToRepeatResult::TandemRepeat {
unit,
count,
start: rep_start,
end: rep_end,
} => {
let bases: Vec<Base> = unit
.iter()
.filter_map(|&b| Base::from_char(b as char))
.collect();
if bases.len() == unit.len() {
let repeat_seq = Sequence::new(bases);
let repeat_edit = NaEdit::Repeat {
sequence: Some(repeat_seq),
count: RepeatCount::Exact(count),
additional_counts: vec![],
trailing: None,
};
return Ok((rep_start, rep_end, repeat_edit, warnings));
}
}
rules::DupToRepeatResult::GatedInsertion {
start: ins_start,
end: ins_end,
sequence: ins_seq,
} => {
// Codon-frame gate routed a multi-copy dup to ins
// literal form per HGVS spec.
use crate::hgvs::edit::InsertedSequence;
let bases: Vec<Base> = ins_seq
.iter()
.filter_map(|&b| Base::from_char(b as char))
.collect();
if bases.len() == ins_seq.len() {
let ins_edit = NaEdit::Insertion {
sequence: InsertedSequence::Literal(Sequence::new(bases)),
};
return Ok((ins_start, ins_end, ins_edit, warnings));
}
// Defensive fallback: rule layer returned a base
// byte that doesn't fit the Base alphabet (e.g.
// N). Fall through to the generic dup minimal-
// notation path below rather than emitting a
// truncated insertion.
}
}
}
// Keep as duplication but strip explicit sequence (minimal notation)
(
new_start,
new_end,
NaEdit::Duplication {
sequence: None,
length: None,
uncertain_extent: None,
},
)
}
// Deletions: post-shift, check for B2 canonical-form rule
// (deletion of >=2 tandem-repeat units → unit[N-k]); otherwise
// strip explicit length for minimal `del` notation. The
// collect-into-Option short-circuits if any byte in the unit isn't
// a valid `Base` (e.g. `N`), in which case we fall through to del.
//
// B2 is defined for a *post-3'-shift* deletion (the shuffle phase-
// alignment lemma justifies emitting `unit[N-k]` without rotation).
// Under FivePrime shuffle, applying it would re-anchor the
// 5'-normalized deletion to the canonical tract position, defeating
// the user's choice of direction — so gate it on ThreePrime.
NaEdit::Deletion { .. } => {
use crate::hgvs::edit::{Base, RepeatCount, Sequence};
if self.config.shuffle_direction == ShuffleDirection::ThreePrime {
if let Some(rep) = rules::deletion_to_repeat(
ref_seq,
result.start as usize,
result.end as usize,
is_coding,
) {
let bases: Option<Vec<Base>> = rep
.unit
.iter()
.map(|&b| Base::from_char(b as char))
.collect();
if let Some(bases) = bases {
let repeat_edit = NaEdit::Repeat {
sequence: Some(Sequence::new(bases)),
count: RepeatCount::Exact(rep.count),
additional_counts: vec![],
trailing: None,
};
return Ok((rep.start, rep.end, repeat_edit, warnings));
}
}
}
(
new_start,
new_end,
NaEdit::Deletion {
sequence: None,
length: None,
},
)
}
// All other edit types stay unchanged
_ => (new_start, new_end, edit.clone()),
};
Ok((final_start, final_end, new_edit, warnings))
}
/// Convert CDS position to transcript position
fn cds_to_tx_pos(
&self,
pos: &CdsPos,
cds_start: u64,
cds_end: Option<u64>,
) -> Result<u64, FerroError> {
if pos.utr3 {
let end = cds_end.ok_or_else(|| FerroError::ConversionError {
msg: "No CDS end".to_string(),
})?;
let base = u64::try_from(pos.base).map_err(|_| FerroError::ConversionError {
msg: format!("Negative base {} in 3' UTR position", pos.base),
})?;
Ok(end + base)
} else if pos.base < 0 {
// 5'UTR: HGVS numbering skips c.0 (c.-1 is the base immediately
// upstream of c.1), so c.-N maps to tx position cds_start - N.
// Issue #97 — the previous formula `cds_start + base - 1`
// double-counted the gap and emitted the wrong tx position.
let tx_pos = cds_start as i64 + pos.base;
u64::try_from(tx_pos).map_err(|_| FerroError::ConversionError {
msg: format!(
"CDS position c.{} maps before transcript start (cds_start={})",
pos.base, cds_start
),
})
} else if pos.base == 0 {
// c.0 is not a valid HGVS position, but historical inputs
// can land here. Preserve the legacy mapping (treat as the
// last 5'UTR base, equivalent to c.-1) rather than failing.
Ok(cds_start.saturating_sub(1))
} else {
Ok(cds_start + pos.base as u64 - 1)
}
}
/// Convert transcript position to CDS position
fn tx_to_cds_pos(
&self,
pos: u64,
cds_start: u64,
cds_end: Option<u64>,
) -> Result<CdsPos, FerroError> {
let end = cds_end.ok_or_else(|| FerroError::ConversionError {
msg: "No CDS end".to_string(),
})?;
if pos < cds_start {
// 5'UTR: HGVS numbering skips c.0, so a tx position one
// base 5' of cds_start is c.-1 (not c.0). Inverse of the
// forward formula `tx = cds_start + base` for negative
// base: `base = tx - cds_start`. Issue #97 — the previous
// formula `tx - cds_start + 1` would emit base = 0 for
// tx = cds_start - 1, rendered by `CdsPos::Display` as
// `c.?` (`CDS_BASE_UNKNOWN`).
Ok(CdsPos {
base: pos as i64 - cds_start as i64,
offset: None,
utr3: false,
})
} else if pos > end {
Ok(CdsPos {
base: (pos - end) as i64,
offset: None,
utr3: true,
})
} else {
Ok(CdsPos {
base: (pos - cds_start + 1) as i64,
offset: None,
utr3: false,
})
}
}
/// Apply minimal notation to a CDS variant without full normalization.
///
/// This is used when we can't do full normalization (e.g., missing transcript)
/// but still want to apply minimal HGVS notation rules.
fn canonicalize_cds_variant(&self, variant: &CdsVariant) -> CdsVariant {
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return variant.clone(),
};
// Only canonicalize if the edit has redundant information
if !should_canonicalize(edit) {
return variant.clone();
}
let canonical_edit = canonicalize_edit(edit);
CdsVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| canonical_edit),
),
}
}
/// Apply minimal notation to a genome variant without full normalization.
fn canonicalize_genome_variant(&self, variant: &GenomeVariant) -> GenomeVariant {
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return variant.clone(),
};
if !should_canonicalize(edit) {
return variant.clone();
}
let canonical_edit = canonicalize_edit(edit);
GenomeVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| canonical_edit),
),
}
}
/// Apply minimal notation to a transcript variant without full normalization.
fn canonicalize_tx_variant(&self, variant: &TxVariant) -> TxVariant {
let edit = match variant.loc_edit.edit.inner() {
Some(e) => e,
None => return variant.clone(),
};
if !should_canonicalize(edit) {
return variant.clone();
}
let canonical_edit = canonicalize_edit(edit);
TxVariant {
accession: variant.accession.clone(),
gene_symbol: variant.gene_symbol.clone(),
loc_edit: LocEdit::with_uncertainty(
variant.loc_edit.location.clone(),
variant.loc_edit.edit.map_ref(|_| canonical_edit),
),
}
}
/// Issue #160 inv sub-span split for a single normalized variant.
/// Coord-system-agnostic: handles `g.`, `m.`, `c.` (CDS-proper positions
/// only), `n.`, and `r.`. Fetches the per-coord-system reference window
/// internally, calls `decompose_delins_inv`, and rebuilds N variants when
/// the decomposition fires. Returns `vec![variant]` if the variant
/// doesn't decompose (non-Delins, complex location, no provider data,
/// no inv sub-span).
///
/// Position math: `decompose_delins_inv` returns 0-indexed offsets into
/// the fetched `ref_bytes` slice. `ref_bytes[0]` corresponds to the
/// variant's HGVS start position, so absolute HGVS pos = `hgvs_start +
/// offset`.
///
/// RNA `r.` variants have `U` bases in the alt while transcript ref bytes
/// are `T`. Both slices are normalized to `T` before comparison so the
/// rev-comp scan works uniformly; the emitted `Substitution` sub-edits
/// preserve the original alt `Base` (which may be `Base::U`).
fn apply_inv_split(&self, variant: HgvsVariant) -> Vec<HgvsVariant> {
let Some((hgvs_start, hgvs_end, alt_bytes, ref_bytes)) =
self.fetch_ref_for_inv_split(&variant)
else {
return vec![variant];
};
let n = ref_bytes.len();
debug_assert_eq!(
n,
(hgvs_end - hgvs_start + 1) as usize,
"ref_bytes length must match HGVS interval span"
);
let ref_norm = normalize_t_u(&ref_bytes);
let alt_norm = normalize_t_u(&alt_bytes);
let Some(subedits) = rules::decompose_delins_inv(&ref_norm, 0, n, &alt_norm) else {
return vec![variant];
};
// Substitution sub-edits inherit `alt_norm` bytes (T-form) from
// decompose_delins_inv, but the user's literal alt may have been U
// (r. inputs). Re-derive the substitution `alternative` from the
// pre-normalized `alt_bytes` so r. variants render `g>u` instead of
// a silently coerced `g>t`. The position field is a 0-indexed offset
// into the same window passed to decompose_delins_inv, so it indexes
// alt_bytes directly.
let subedits = subedits
.into_iter()
.map(|se| match se {
rules::DelinsSubedit::Substitution {
position,
reference,
alternative,
} => {
let alt = crate::hgvs::edit::Base::from_char(alt_bytes[position] as char)
.unwrap_or(alternative);
rules::DelinsSubedit::Substitution {
position,
reference,
alternative: alt,
}
}
other => other,
})
.collect();
build_split_variants(&variant, subedits, hgvs_start)
}
/// Per-coord-system extraction of `(hgvs_start, hgvs_end, alt_bytes,
/// ref_bytes)` for inv-split. Returns `None` when the variant is not a
/// single-Delins at simple positions, or when the provider can't supply
/// the ref window.
///
/// The `ref_bytes` slice is sized exactly to the variant's HGVS interval
/// (`hgvs_end - hgvs_start + 1` bytes), with `ref_bytes[0]` aligned to
/// HGVS pos `hgvs_start`. This invariant lets the caller use a uniform
/// `hgvs_pos = hgvs_start + offset` formula regardless of coord system.
fn fetch_ref_for_inv_split(
&self,
variant: &HgvsVariant,
) -> Option<(u64, u64, Vec<u8>, Vec<u8>)> {
let (hgvs_start, hgvs_end, alt) = extract_simple_delins(variant)?;
let ref_bytes = match variant {
HgvsVariant::Genome(g) => self
.provider
// get_sequence is 0-based half-open: [hgvs_start - 1, hgvs_end).
.get_sequence(
&g.accession.transcript_accession(),
hgvs_start - 1,
hgvs_end,
)
.ok()?
.into_bytes(),
HgvsVariant::Mt(m) => self
.provider
.get_sequence(
&m.accession.transcript_accession(),
hgvs_start - 1,
hgvs_end,
)
.ok()?
.into_bytes(),
HgvsVariant::Cds(c) => {
// CDS pos N → 1-based tx pos = cds_start + N - 1.
// 0-based tx slice = [cds_start + N - 2, cds_start + end - 1).
let tx = self
.provider
.get_transcript(&c.accession.transcript_accession())
.ok()?;
let cds_start = tx.cds_start?;
let s = cds_start.checked_add(hgvs_start)?.checked_sub(2)? as usize;
let e = cds_start.checked_add(hgvs_end)?.checked_sub(1)? as usize;
let bytes = tx.sequence.as_deref()?.as_bytes();
if e > bytes.len() || s >= e {
return None;
}
bytes[s..e].to_vec()
}
HgvsVariant::Tx(t) => {
let tx = self
.provider
.get_transcript(&t.accession.transcript_accession())
.ok()?;
let s = (hgvs_start - 1) as usize;
let e = hgvs_end as usize;
let bytes = tx.sequence.as_deref()?.as_bytes();
if e > bytes.len() || s >= e {
return None;
}
bytes[s..e].to_vec()
}
HgvsVariant::Rna(r) => {
let tx = self
.provider
.get_transcript(&r.accession.transcript_accession())
.ok()?;
let s = (hgvs_start - 1) as usize;
let e = hgvs_end as usize;
let bytes = tx.sequence.as_deref()?.as_bytes();
if e > bytes.len() || s >= e {
return None;
}
bytes[s..e].to_vec()
}
_ => return None,
};
Some((hgvs_start, hgvs_end, alt, ref_bytes))
}
/// Issue #160 post-merge canonicalization for a single variant. Used by
/// the cis-allele merge path; `normalize_allele` applies this per merged
/// variant. Conservatively returns `vec![v]` for variants the helper
/// can't process.
///
/// Two spec rules are folded together by re-running normalization on the
/// merged variant:
/// - Full-span canonicalization (identity / dup / sub / del / ins /
/// full-span inv with outer-pair shortening) handled by
/// `canonicalize_delins` inside `normalize_na_edit`.
/// - Sub-span inv decomposition (the issue #160 case) handled by
/// `apply_inv_split` wired into each per-coord-system `normalize_*`.
///
/// If the result is an `HgvsVariant::Allele` (sub-span split fired),
/// unwrap its inner variants so they flatten into the outer cis-allele
/// list rather than nesting.
fn split_inv_for_variant(&self, v: HgvsVariant) -> Vec<HgvsVariant> {
if !matches!(
v,
HgvsVariant::Genome(_)
| HgvsVariant::Mt(_)
| HgvsVariant::Cds(_)
| HgvsVariant::Tx(_)
| HgvsVariant::Rna(_)
) {
return vec![v];
}
if extract_simple_delins(&v).is_none() {
return vec![v];
}
match self.normalize_with_warnings(&v) {
Ok(r) => match r.result {
HgvsVariant::Allele(a) => a.variants,
other => vec![other],
},
Err(_) => vec![v],
}
}
}
/// Flip a fetched intronic genomic-strand window into transcript-view
/// orientation when the host transcript is on the minus strand. Returns
/// the input unchanged on plus strand. The relative positions and the
/// shuffle boundaries are flipped so they index into the returned
/// sequence consistently. Companion to [`unflip_intronic_positions`].
fn flip_intronic_for_strand(
strand: Strand,
genomic_seq: &str,
rel_start: u64,
rel_end: u64,
boundaries: &Boundaries,
) -> (String, u64, u64, Boundaries) {
if strand != Strand::Minus {
return (
genomic_seq.to_string(),
rel_start,
rel_end,
boundaries.clone(),
);
}
let seq_len = genomic_seq.len() as u64;
let rc = crate::sequence::reverse_complement(genomic_seq);
let new_rel_start = seq_len - rel_end + 1;
let new_rel_end = seq_len - rel_start + 1;
let new_boundaries = Boundaries::new(
seq_len - boundaries.right + 1,
seq_len - boundaries.left + 1,
);
(rc, new_rel_start, new_rel_end, new_boundaries)
}
/// Inverse of [`flip_intronic_for_strand`] for the result positions
/// emitted by `normalize_na_edit`. On plus strand returns the input
/// unchanged; on minus strand maps from transcript-view back to the
/// genomic-strand frame.
fn unflip_intronic_positions(
strand: Strand,
seq_len: u64,
rel_start: u64,
rel_end: u64,
) -> (u64, u64) {
if strand == Strand::Minus {
(seq_len - rel_end + 1, seq_len - rel_start + 1)
} else {
(rel_start, rel_end)
}
}
// =============================================================================
// Issue #160: inv sub-span split helpers
// =============================================================================
//
// After `normalize_na_edit` (or `merge_consecutive_edits` for cis alleles)
// produces a Delins variant, we may discover the delins span actually contains
// an `inv`-eligible sub-span. The HGVS spec puts `inv` higher than `delins`
// in the edit-priority order, so the canonical form is to split the delins
// into a sequence of [..., inv, ...] sub-edits and wrap them back in a cis
// allele.
//
// The split is implemented as a post-pass over an already-built variant. It
// fetches a reference window via the provider, calls
// `rules::decompose_delins_inv`, and rebuilds N variants when the
// decomposition fires. For variants that don't decompose (most cases), the
// helper returns `vec![input]` and is effectively a no-op.
/// Per-coord-system-aware extraction of `(hgvs_start, hgvs_end, alt_bytes)`
/// from a variant whose edit is a literal `Delins` at simple positions
/// (no offsets, no uncertainty). Returns `None` for any variant shape that
/// can't be decomposed by the inv-split rule (non-Delins, intronic, uncertain
/// boundary, non-literal insert, etc.).
fn extract_simple_delins(variant: &HgvsVariant) -> Option<(u64, u64, Vec<u8>)> {
let (start, end, edit) = match variant {
HgvsVariant::Genome(v) => simple_genome_loc_edit(&v.loc_edit)?,
HgvsVariant::Cds(v) => simple_cds_loc_edit(&v.loc_edit)?,
HgvsVariant::Tx(v) => simple_tx_loc_edit(&v.loc_edit)?,
HgvsVariant::Rna(v) => simple_rna_loc_edit(&v.loc_edit)?,
HgvsVariant::Mt(v) => simple_genome_loc_edit(&v.loc_edit)?,
_ => return None,
};
let NaEdit::Delins { sequence, .. } = edit else {
return None;
};
let InsertedSequence::Literal(seq) = sequence else {
return None;
};
let alt: Vec<u8> = seq.bases().iter().map(|b| b.to_u8()).collect();
Some((start, end, alt))
}
fn simple_genome_loc_edit(
le: &LocEdit<Interval<GenomePos>, NaEdit>,
) -> Option<(u64, u64, &NaEdit)> {
let edit = le.edit.inner()?;
let s = simple_genome_pos(le.location.start.as_single()?)?;
let e = simple_genome_pos(le.location.end.as_single()?)?;
Some((s, e, edit))
}
fn simple_genome_pos(mu: &Mu<GenomePos>) -> Option<u64> {
let Mu::Certain(p) = mu else { return None };
if p.is_special() || p.offset.is_some() {
return None;
}
Some(p.base)
}
fn simple_cds_loc_edit(le: &LocEdit<Interval<CdsPos>, NaEdit>) -> Option<(u64, u64, &NaEdit)> {
let edit = le.edit.inner()?;
// Only handle simple positive CDS positions (no UTR, no intronic, no
// uncertainty). UTR delins decomposition would need its own coord-axis
// logic and is out of scope for this fix.
let s = simple_cds_pos(le.location.start.as_single()?)?;
let e = simple_cds_pos(le.location.end.as_single()?)?;
Some((s, e, edit))
}
fn simple_cds_pos(mu: &Mu<CdsPos>) -> Option<u64> {
let Mu::Certain(p) = mu else { return None };
if p.is_unknown() || p.is_intronic() || p.is_3utr() || p.base <= 0 {
return None;
}
Some(p.base as u64)
}
fn simple_tx_loc_edit(le: &LocEdit<Interval<TxPos>, NaEdit>) -> Option<(u64, u64, &NaEdit)> {
let edit = le.edit.inner()?;
let s = simple_tx_pos(le.location.start.as_single()?)?;
let e = simple_tx_pos(le.location.end.as_single()?)?;
Some((s, e, edit))
}
fn simple_tx_pos(mu: &Mu<TxPos>) -> Option<u64> {
let Mu::Certain(p) = mu else { return None };
if p.is_intronic() || p.is_downstream() || p.base <= 0 {
return None;
}
Some(p.base as u64)
}
fn simple_rna_loc_edit(le: &LocEdit<Interval<RnaPos>, NaEdit>) -> Option<(u64, u64, &NaEdit)> {
let edit = le.edit.inner()?;
let s = simple_rna_pos(le.location.start.as_single()?)?;
let e = simple_rna_pos(le.location.end.as_single()?)?;
Some((s, e, edit))
}
fn simple_rna_pos(mu: &Mu<RnaPos>) -> Option<u64> {
let Mu::Certain(p) = mu else { return None };
if p.is_intronic() || p.is_3utr() || p.base <= 0 {
return None;
}
Some(p.base as u64)
}
/// Build a single HgvsVariant matching `template`'s coord-system kind /
/// accession / gene_symbol, with a new `[start_1based, end_1based]` location
/// and the given edit. Used by `build_split_variants` to spread the output
/// of `decompose_delins_inv` back into a sequence of HgvsVariants.
fn build_variant_at(
template: &HgvsVariant,
start_1based: u64,
end_1based: u64,
edit: NaEdit,
) -> HgvsVariant {
match template {
HgvsVariant::Genome(g) => HgvsVariant::Genome(GenomeVariant {
accession: g.accession.clone(),
gene_symbol: g.gene_symbol.clone(),
loc_edit: LocEdit::new(
Interval::new(GenomePos::new(start_1based), GenomePos::new(end_1based)),
edit,
),
}),
HgvsVariant::Cds(c) => HgvsVariant::Cds(CdsVariant {
accession: c.accession.clone(),
gene_symbol: c.gene_symbol.clone(),
loc_edit: LocEdit::new(
Interval::new(
CdsPos::new(start_1based as i64),
CdsPos::new(end_1based as i64),
),
edit,
),
}),
HgvsVariant::Tx(t) => HgvsVariant::Tx(TxVariant {
accession: t.accession.clone(),
gene_symbol: t.gene_symbol.clone(),
loc_edit: LocEdit::new(
Interval::new(
TxPos::new(start_1based as i64),
TxPos::new(end_1based as i64),
),
edit,
),
}),
HgvsVariant::Rna(r) => HgvsVariant::Rna(RnaVariant {
accession: r.accession.clone(),
gene_symbol: r.gene_symbol.clone(),
loc_edit: LocEdit::new(
Interval::new(
RnaPos::new(start_1based as i64),
RnaPos::new(end_1based as i64),
),
edit,
),
}),
HgvsVariant::Mt(m) => HgvsVariant::Mt(MtVariant {
accession: m.accession.clone(),
gene_symbol: m.gene_symbol.clone(),
loc_edit: LocEdit::new(
Interval::new(GenomePos::new(start_1based), GenomePos::new(end_1based)),
edit,
),
}),
_ => unreachable!("build_variant_at called with non-NaEdit variant kind"),
}
}
/// Build N HgvsVariants from a Vec<DelinsSubedit>. Position offsets in the
/// subedits are 0-indexed into the (per-variant-sized) ref slice; absolute
/// 1-based HGVS positions are recovered as `offset + hgvs_start`, where
/// `hgvs_start` is the variant's HGVS start position.
///
/// Consecutive `Substitution` sub-edits whose positions are strictly
/// adjacent (no gap, no `Inversion` or `IdentityAt` between them) are
/// grouped into a single `delins` variant per HGVS spec — `substitution.md`:
/// "changes involving two or more consecutive nucleotides are described as
/// deletion/insertion (delins)" (issue #182). Singleton sub-runs stay as
/// `Substitution`; an `Inversion` or `IdentityAt` always breaks a run and
/// emits separately. `Inversion` therefore acts as a hard barrier — adjacent
/// sub flanks on either side of an inv are NOT re-merged into the inv span,
/// preserving the inv-priority decomposition introduced by #166 (which was
/// adopted to align with the spec's edit-priority list `general.md:45`:
/// sub > del > inv > dup > ins).
fn build_split_variants(
template: &HgvsVariant,
subedits: Vec<DelinsSubedit>,
hgvs_start: u64,
) -> Vec<HgvsVariant> {
let abs = |idx: usize| -> u64 { idx as u64 + hgvs_start };
let mut output: Vec<HgvsVariant> = Vec::new();
// Pending run of strictly-adjacent Substitution sub-edits, in
// left-to-right order. Each entry is `(position, reference, alternative)`
// with `position` the 0-indexed offset into the variant's ref window.
let mut run: Vec<(usize, Base, Base)> = Vec::new();
for se in subedits {
match se {
DelinsSubedit::Substitution {
position,
reference,
alternative,
} => {
let breaks_run = matches!(run.last(), Some((prev, _, _)) if *prev + 1 != position);
if breaks_run {
flush_substitution_run(&mut output, template, hgvs_start, &mut run);
}
run.push((position, reference, alternative));
}
DelinsSubedit::Inversion { start, end } => {
flush_substitution_run(&mut output, template, hgvs_start, &mut run);
// Half-open 0-indexed [start, end) of length L=end-start.
// HGVS inclusive interval covers L bases starting at
// abs(start) and ending at abs(start)+L-1 = abs(end-1).
let s = abs(start);
let e = abs(end) - 1;
output.push(build_variant_at(
template,
s,
e,
NaEdit::Inversion {
sequence: None,
length: None,
},
));
}
// Drop IdentityAt: an unchanged base is not an edit, so emitting
// a `pos=` sub-variant would clutter the split allele. Both the
// codon-frame-merge interior identity (issue #79) and the outer
// bases absorbed by `shorten_inversion` map to IdentityAt. An
// identity also ends any in-flight substitution run — the gap
// means the surrounding subs are no longer "consecutive".
DelinsSubedit::IdentityAt { .. } => {
flush_substitution_run(&mut output, template, hgvs_start, &mut run);
}
}
}
flush_substitution_run(&mut output, template, hgvs_start, &mut run);
output
}
/// Flush a pending run of consecutive substitution sub-edits into `output`.
/// A length-1 run emits a `Substitution`; a length-2+ run emits a single
/// `Delins` over `[run.first.position, run.last.position]` with `sequence`
/// = concatenated `alternative` bases. See `build_split_variants` for the
/// spec rationale (issue #182).
fn flush_substitution_run(
output: &mut Vec<HgvsVariant>,
template: &HgvsVariant,
hgvs_start: u64,
run: &mut Vec<(usize, Base, Base)>,
) {
if run.is_empty() {
return;
}
let abs = |idx: usize| -> u64 { idx as u64 + hgvs_start };
if run.len() == 1 {
let (position, reference, alternative) = run.pop().unwrap();
let p = abs(position);
output.push(build_variant_at(
template,
p,
p,
NaEdit::Substitution {
reference,
alternative,
},
));
return;
}
let s = abs(run.first().unwrap().0);
let e = abs(run.last().unwrap().0);
let alt_bases: Vec<Base> = run.drain(..).map(|(_, _, a)| a).collect();
output.push(build_variant_at(
template,
s,
e,
NaEdit::Delins {
sequence: InsertedSequence::Literal(Sequence::new(alt_bases)),
deleted: None,
deleted_length: None,
},
));
}
/// Normalize DNA `T` and RNA `U` to a single byte (`T`) so byte-wise
/// comparison works across coord systems. Used by `apply_inv_split` to make
/// the rev-comp scan T/U-agnostic for `r.` variants whose alt bytes contain
/// `U` while the transcript ref contains `T`.
fn normalize_t_u(seq: &[u8]) -> Vec<u8> {
seq.iter()
.map(|&b| match b {
b'U' => b'T',
b'u' => b't',
other => other,
})
.collect()
}
/// If `variants` has 1 element return it directly; if >1 wrap in a cis Allele.
fn wrap_allele_if_split(mut variants: Vec<HgvsVariant>) -> HgvsVariant {
debug_assert!(!variants.is_empty(), "wrap_allele_if_split: empty input");
if variants.len() == 1 {
variants.pop().unwrap()
} else {
HgvsVariant::Allele(AlleleVariant::new(variants, AllelePhase::Cis))
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::hgvs::parser::parse_hgvs;
use crate::reference::MockProvider;
#[test]
fn test_normalize_substitution_unchanged() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10A>G").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
// Substitutions should not change
assert_eq!(format!("{}", variant), format!("{}", normalized));
}
#[test]
fn test_normalize_with_config() {
let provider = MockProvider::with_test_data();
let config = NormalizeConfig::default().with_direction(ShuffleDirection::FivePrime);
let normalizer = Normalizer::with_config(provider, config);
assert_eq!(
normalizer.config().shuffle_direction,
ShuffleDirection::FivePrime
);
}
#[test]
fn test_normalizer_handles_missing_transcript() {
let provider = MockProvider::new(); // Empty provider
let normalizer = Normalizer::new(provider);
// Should return variant unchanged when transcript not found
let variant = parse_hgvs("NM_MISSING.1:c.100del").unwrap();
let result = normalizer.normalize(&variant);
assert!(result.is_ok());
// Verify output equals input (unchanged)
assert_eq!(
format!("{}", variant),
format!("{}", result.unwrap()),
"Missing transcript should return variant unchanged"
);
}
#[test]
fn test_normalize_deletion_shifts_3prime() {
// NM_001234.1 has G repeat spanning exon boundaries
// Exon 1: c.1-11, Exon 2: c.12-26, Exon 3: c.27+
// G repeat is at c.9-c.33, but shift stops at exon boundary
// c.10 is in exon 1 (ends at c.11), so deletion shifts to c.11
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_001234.1:c.10del").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Should remain a deletion
assert!(
output.contains("del"),
"Deletion should remain a deletion, got: {}",
output
);
// Should shift from c.10 to c.11 (3'-most within exon 1)
assert!(
output.contains("c.11del"),
"Deletion should shift 3' to exon boundary (c.11), got: {}",
output
);
}
#[test]
fn test_normalize_insertion_becomes_dup() {
// NM_001234.1 has G repeat at CDS positions c.9-c.33
// Inserting G after position 10 should shift 3' and become dup
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_001234.1:c.10_11insG").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Inserting G in a G-repeat should become dup
assert!(
output.contains("dup"),
"Insertion of matching base should become dup, got: {}",
output
);
}
#[test]
fn test_normalize_duplication_shifts_3prime() {
// NM_001234.1 has G repeat spanning positions c.9-33 (25 G's)
// Single-base duplications stay as simple dups (only 2+ base dups become repeat notation)
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_001234.1:c.10dup").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Single-base duplication should shift 3' and stay as dup
// c.10dup in GGGGG...GGG tract shifts to rightmost position (c.33) but stays as dup
assert!(
output.contains("dup"),
"Single-base duplication should remain as dup notation, got: {}",
output
);
}
#[test]
fn test_normalize_delins_unchanged() {
// A delins that doesn't simplify should stay as delins
// Deleting G and inserting AT is not a dup pattern
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10delinsAT").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
assert!(
output.contains("delinsAT"),
"Delins should remain unchanged, got: {}",
output
);
}
#[test]
fn test_normalize_single_base_delins_becomes_substitution() {
// HGVS edit-type priority: a 1→1 delins with ref!=alt must be expressed
// as a substitution. Transcript NM_000088.3 starts ATGCCCAAGG...; position
// 10 is G. c.10delinsT replaces G with T → c.10G>T.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10delinsT").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.10G>T");
}
#[test]
fn test_normalize_single_base_delins_same_base_becomes_identity() {
// Per HGVS, a delins whose insert equals the reference is identity (=).
// Transcript NM_000088.3 starts ATGCCCAAGG...; position 10 is G.
// c.10delinsG produces no change → c.10=.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10delinsG").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.10=");
}
#[test]
fn test_normalize_multi_base_delins_same_seq_becomes_identity() {
// Transcript NM_000088.3 starts ATG at positions 1-3.
// c.1_3delinsATG produces no change → c.1_3=.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.1_3delinsATG").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.1_3=");
}
#[test]
fn test_normalize_multi_base_delete_delins_to_pure_deletion() {
// c.10_11delinsT against NM_000088.3 (c.10_11 = GT). The shared `T`
// suffix consumes the inserted base entirely, leaving a single-base
// deletion at c.10. Per HGVS minimal-form rules (sub > del > inv >
// dup > ins) the canonical output is a pure deletion, not a delins.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10_11delinsT").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.10del");
}
#[test]
fn test_normalize_empty_insert_delins_becomes_deletion() {
// HGVS spec: a delins whose inserted sequence is empty is semantically
// a deletion and must be rendered as `del`. Issue #81 item A3.
// Transcript NM_000088.3 starts ATGCCCAAGG…; c.10delins (empty insert)
// is a deletion of position 10 → c.10del.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10delins").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.10del");
}
#[test]
fn test_normalize_empty_insert_multi_base_delins_becomes_deletion() {
// Multi-base form: c.10_11delins (deletes "GT" at positions 10-11,
// inserts nothing) → del, then the spec's 3'-rule shifts the deletion
// to c.11_12del because ref[10]=G == ref[12]=G. Issue #81 item A3.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10_11delins").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.11_12del");
}
#[test]
fn test_normalize_delins_to_dup_still_works() {
// Regression guard: adding identity/substitution checks before the dup
// check must not block legitimate dup conversions. ref[5] = C;
// c.5delinsCC matches the dup pattern (insert == deleted twice) and
// must still normalize to dup.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.5delinsCC").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
assert!(
output.contains("dup"),
"delins matching dup pattern should normalize to dup, got: {}",
output
);
assert!(
!output.contains("delins"),
"delins should not survive the dup conversion, got: {}",
output
);
}
#[test]
fn test_normalize_delins_different_bases_becomes_substitution() {
// c.1_3delinsACG against NM_000088.3 (c.1_3 = ATG). The shared `A`
// prefix and `G` suffix collapse the delins to T -> C at c.2 per the
// HGVS minimal-form rule (sub > del > inv > dup > ins).
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.1_3delinsACG").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.2T>C");
// r. twin: same collapse on the RNA path. NM_000088.3 has cds_start = 1,
// so r.1_3 maps to the same ATG run and the residual is at r.2.
// The substitution edit Display lowercases the reference byte but does
// not map T -> u for r. variants synthesized by canonicalize_delins,
// so the locked form is `r.2t>c` rather than the spec-ideal `r.2u>c`.
// RNA U/T mapping for synthesized substitutions is a separate display-
// layer concern (see `NaEdit::Substitution` in src/hgvs/edit.rs).
let variant = parse_hgvs("NM_000088.3:r.1_3delinsacg").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:r.2t>c");
}
#[test]
fn test_normalize_substitution_ref_equals_alt_becomes_identity() {
// Per HGVS, a substitution where the reference and alternative bases
// are identical produces no change and must be expressed using
// identity notation (`=`). SNV companion to the same-base delins rule.
// Transcript NM_000088.3 starts ATGCCCAAGG...; position 10 is G.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10G>G").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.10=");
}
#[test]
fn test_normalize_substitution_ref_equals_alt_first_position() {
// Boundary check: the rule must fire at position 1 (first base).
// Transcript NM_000088.3 starts ATG...; position 1 is A.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.1A>A").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.1=");
}
#[test]
fn test_normalize_substitution_ref_not_equal_alt_unchanged() {
// Regression guard: a real SNV must not be rewritten to identity.
// c.10G>T at position 10 (G) is a valid substitution.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10G>T").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_000088.3:c.10G>T");
}
#[test]
fn test_normalize_substitution_ref_equals_alt_without_provider_data() {
// The A4 rule is purely syntactic, so it must fire even when the
// provider has no transcript loaded — matching the spec's stance that
// `c.123C>C` is "not allowed" regardless of reference availability.
// Spec example: docs/recommendations/DNA/other.md (HGVS v21.0).
let provider = MockProvider::new(); // empty — no transcripts
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_004006.2:c.123C>C").unwrap();
let result = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", result), "NM_004006.2:c.123=");
}
#[test]
fn test_normalize_protein_substitution_unchanged() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Protein substitution variants should pass through unchanged
let variant = parse_hgvs("NP_000079.2:p.Val600Glu").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", variant), format!("{}", normalized));
}
#[test]
fn test_normalize_protein_deletion_removes_redundant_sequence() {
// Redundant sequence removal: p.Val600delVal → p.Val600del
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NP_000079.2:p.Val600delVal").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
let output = format!("{}", normalized);
// Should remove redundant "Val" from the deletion
assert_eq!(
output, "NP_000079.2:p.Val600del",
"Redundant sequence should be removed from deletion"
);
}
#[test]
fn test_normalize_protein_deletion_range_removes_redundant_sequence() {
// Redundant sequence removal for range: p.Lys23_Glu25delLysAlaGlu → p.Lys23_Glu25del
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NP_000079.2:p.Lys23_Glu25delLysAlaGlu").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
let output = format!("{}", normalized);
// Should remove redundant sequence from the deletion
assert_eq!(
output, "NP_000079.2:p.Lys23_Glu25del",
"Redundant sequence should be removed from range deletion"
);
}
#[test]
fn test_normalize_protein_deletion_non_matching_sequence_unchanged() {
// Non-matching sequence should stay: p.Val600delGlu should NOT change
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NP_000079.2:p.Val600delGlu").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
let output = format!("{}", normalized);
// Should NOT remove non-matching sequence
assert_eq!(
output, "NP_000079.2:p.Val600delGlu",
"Non-matching sequence should not be removed"
);
}
#[test]
fn test_normalize_protein_deletion_no_sequence_unchanged() {
// Deletion without sequence should stay unchanged
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NP_000079.2:p.Val600del").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
let output = format!("{}", normalized);
assert_eq!(
output, "NP_000079.2:p.Val600del",
"Deletion without sequence should remain unchanged"
);
}
#[test]
fn test_normalize_protein_duplication_unchanged() {
// Duplications should pass through unchanged
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NP_000079.2:p.Val600dup").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", variant), format!("{}", normalized));
}
#[test]
fn test_normalize_protein_frameshift_unchanged() {
// Frameshifts should pass through unchanged
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NP_000079.2:p.Arg97ProfsTer23").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", variant), format!("{}", normalized));
}
#[test]
fn test_normalize_protein_reference_validation_match() {
// Test that validation passes when amino acid matches reference
// NP_TEST.1 has: M at position 1, V at position 2
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Position 1 = M (Met), Position 2 = V (Val)
let variant = parse_hgvs("NP_TEST.1:p.Met1Val").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Validation should pass for matching amino acid"
);
}
#[test]
fn test_normalize_protein_reference_validation_mismatch() {
// Test that validation fails when amino acid doesn't match reference
// NP_TEST.1 has M at position 1, but we claim it's Val
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Position 1 is M (Met), not V (Val)
let variant = parse_hgvs("NP_TEST.1:p.Val1Glu").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_err(),
"Validation should fail for mismatched amino acid"
);
if let Err(crate::error::FerroError::AminoAcidMismatch {
position,
expected,
found,
..
}) = result
{
assert_eq!(position, 1);
assert_eq!(expected, "Val");
assert_eq!(found, "M");
} else {
panic!("Expected AminoAcidMismatch error");
}
}
#[test]
fn test_normalize_protein_reference_validation_deletion() {
// Test validation for deletion variants
// NP_TEST.1 has V at position 2
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Position 2 = V (Val) - should pass
let variant = parse_hgvs("NP_TEST.1:p.Val2del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Validation should pass for matching deletion position"
);
}
#[test]
fn test_normalize_protein_reference_validation_missing_protein() {
// Test that missing protein data skips validation (doesn't fail)
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// NP_MISSING.1 doesn't exist in provider
let variant = parse_hgvs("NP_MISSING.1:p.Val600Glu").unwrap();
let result = normalizer.normalize(&variant);
// Should NOT error - just skip validation when protein not available
assert!(
result.is_ok(),
"Missing protein should skip validation, not fail"
);
}
#[test]
fn test_normalize_rna_substitution_unchanged() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// RNA substitutions should pass through unchanged
let variant = parse_hgvs("NM_000088.3:r.10a>g").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", variant), format!("{}", normalized));
}
#[test]
fn test_normalize_rna_deletion_shifts_3prime() {
// NM_001234.1 has G repeat at positions 13-37 (position 37 is actually T,
// but the normalization shifts to the 3'-most position)
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_001234.1:r.14del").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Should remain a deletion and shift 3'
assert!(
output.contains("del"),
"Deletion should remain a deletion, got: {}",
output
);
// Verify it shifted 3' (position should be > 14)
assert!(
output.contains("r.37del"),
"Deletion should shift 3' to position 37, got: {}",
output
);
}
#[test]
fn test_normalize_rna_insertion_becomes_dup() {
// NM_001234.1 has G repeat at positions 13-36
// Inserting g after position 14 should shift 3' and become dup
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_001234.1:r.14_15insg").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Inserting g in a G-repeat should become dup
assert!(
output.contains("dup"),
"Insertion of matching base should become dup, got: {}",
output
);
}
#[test]
fn test_normalize_rna_duplication_shifts_3prime() {
// NM_001234.1 has G repeat - single-base duplications stay as simple dups
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_001234.1:r.14dup").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Single-base duplication should shift 3' and stay as dup
assert!(
output.contains("dup"),
"Single-base RNA duplication should remain as dup notation, got: {}",
output
);
}
#[test]
fn test_normalize_rna_intronic_returns_error() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Intronic RNA variants should return an error
let variant = parse_hgvs("NM_001234.1:r.10+5del").unwrap();
let result = normalizer.normalize(&variant);
assert!(result.is_err(), "Intronic RNA variant should return error");
}
#[test]
fn test_normalize_rna_missing_transcript_unchanged() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Missing transcript should return variant unchanged
let variant = parse_hgvs("NM_MISSING.1:r.100del").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
assert_eq!(format!("{}", variant), format!("{}", normalized));
}
#[test]
fn test_normalize_null_allele() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Null alleles should pass through
let variant = HgvsVariant::NullAllele;
let normalized = normalizer.normalize(&variant).unwrap();
assert!(matches!(normalized, HgvsVariant::NullAllele));
}
#[test]
fn test_normalize_unknown_allele() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Unknown alleles should pass through
let variant = HgvsVariant::UnknownAllele;
let normalized = normalizer.normalize(&variant).unwrap();
assert!(matches!(normalized, HgvsVariant::UnknownAllele));
}
#[test]
fn test_normalize_allele_variant() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Allele variants should normalize each component
// Using substitutions which should remain unchanged
let variant = parse_hgvs("[NM_000088.3:c.10A>G;NM_000088.3:c.20C>T]").unwrap();
let result = normalizer.normalize(&variant).unwrap();
// Verify it's still an allele
assert!(matches!(result, HgvsVariant::Allele(_)));
// Verify output is the canonical compact form (ACC:c.[edit1;edit2])
assert_eq!(
format!("{}", result),
"NM_000088.3:c.[10A>G;20C>T]",
"Allele display should use canonical compact form"
);
}
#[test]
fn test_normalize_5prime_direction() {
// Test that 5' direction shifts toward 5' end instead of 3'
// NM_001234.1 has G repeat spanning exons
// Exon 2: c.12-c.26
// With 5' direction, deletion at c.20 should shift toward c.12
// Note: Actual shift depends on boundary handling
let provider = MockProvider::with_test_data();
let config = NormalizeConfig::default().with_direction(ShuffleDirection::FivePrime);
let normalizer = Normalizer::with_config(provider, config);
// Delete G at position 20 (middle of G repeat in exon 2)
let variant = parse_hgvs("NM_001234.1:c.20del").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
assert!(
output.contains("del"),
"Should remain a deletion, got: {}",
output
);
// With 5' direction within exon 2, should shift toward 5' boundary
// The exact position depends on exon boundary handling
assert!(
output.contains("c.13del") || output.contains("c.12del"),
"5' direction should shift deletion toward exon start, got: {}",
output
);
}
#[test]
fn test_normalize_3prime_direction() {
let provider = MockProvider::with_test_data();
let config = NormalizeConfig::default().with_direction(ShuffleDirection::ThreePrime);
let normalizer = Normalizer::with_config(provider, config);
let variant = parse_hgvs("NM_000088.3:c.10del").unwrap();
let result = normalizer.normalize(&variant);
assert!(result.is_ok());
}
#[test]
fn test_normalize_with_cross_boundaries() {
let provider = MockProvider::with_test_data();
let config = NormalizeConfig::default().allow_crossing_boundaries();
let normalizer = Normalizer::with_config(provider, config);
let variant = parse_hgvs("NM_000088.3:c.10del").unwrap();
let result = normalizer.normalize(&variant);
assert!(result.is_ok());
}
#[test]
fn test_normalize_genomic_variant() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Genomic variants with missing sequence should pass through unchanged
let variant = parse_hgvs("NC_000001.11:g.12345del").unwrap();
let result = normalizer.normalize(&variant);
assert!(result.is_ok());
}
#[test]
fn test_normalize_tx_variant() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NR_000001.1:n.100del").unwrap();
let result = normalizer.normalize(&variant);
assert!(result.is_ok());
}
#[test]
fn test_normalize_mt_variant() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// MT variants pass through unchanged
let variant = parse_hgvs("NC_012920.1:m.100A>G").unwrap();
let normalized = normalizer.normalize(&variant).unwrap();
assert!(matches!(normalized, HgvsVariant::Mt(_)));
}
#[test]
fn test_cds_to_tx_pos_utr5() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// 5' UTR position (negative)
let cds_pos = CdsPos {
base: -5,
offset: None,
utr3: false,
};
let result = normalizer.cds_to_tx_pos(&cds_pos, 10, Some(50));
assert!(result.is_ok());
}
#[test]
fn test_cds_to_tx_pos_utr3() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// 3' UTR position
let cds_pos = CdsPos {
base: 5,
offset: None,
utr3: true,
};
let result = normalizer.cds_to_tx_pos(&cds_pos, 10, Some(50));
assert!(result.is_ok());
assert_eq!(result.unwrap(), 55);
}
#[test]
fn test_cds_to_tx_pos_coding() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Normal coding position
let cds_pos = CdsPos {
base: 10,
offset: None,
utr3: false,
};
let result = normalizer.cds_to_tx_pos(&cds_pos, 5, Some(50));
assert!(result.is_ok());
assert_eq!(result.unwrap(), 14); // 5 + 10 - 1 = 14
}
#[test]
fn test_tx_to_cds_pos_utr5() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Position before CDS start
let result = normalizer.tx_to_cds_pos(3, 10, Some(50));
assert!(result.is_ok());
let cds_pos = result.unwrap();
assert!(cds_pos.base < 0);
assert!(!cds_pos.utr3);
}
#[test]
fn test_tx_to_cds_pos_utr3() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Position after CDS end
let result = normalizer.tx_to_cds_pos(55, 10, Some(50));
assert!(result.is_ok());
let cds_pos = result.unwrap();
assert!(cds_pos.utr3);
}
#[test]
fn test_tx_to_cds_pos_coding() {
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// Normal coding position
let result = normalizer.tx_to_cds_pos(20, 10, Some(50));
assert!(result.is_ok());
let cds_pos = result.unwrap();
assert!(!cds_pos.utr3);
assert_eq!(cds_pos.base, 11); // 20 - 10 + 1 = 11
}
#[test]
fn test_config_default() {
let config = NormalizeConfig::default();
assert_eq!(config.shuffle_direction, ShuffleDirection::ThreePrime);
assert!(!config.cross_boundaries);
}
#[test]
#[allow(deprecated)]
fn test_config_builder() {
let config = NormalizeConfig::default()
.with_direction(ShuffleDirection::FivePrime)
.allow_crossing_boundaries()
.skip_validation();
assert_eq!(config.shuffle_direction, ShuffleDirection::FivePrime);
assert!(config.cross_boundaries);
// skip_validation now sets RefSeqMismatch to SilentCorrect
assert!(!config.should_reject_ref_mismatch());
assert!(!config.should_warn_ref_mismatch());
}
#[test]
fn test_duplication_3prime_shift_two_bases() {
// Test the exact scenario from ClinVar: c.4159dup vs c.4160dup
// When duplicating an A in a homopolymer tract (AA),
// HGVS requires converting to repeat notation.
//
// NM_888888.1 sequence: ATGCCCGAAGCCCCCCCCCGTTTGCATGCATGCATGCAT
// Positions (1-based): 12345678901234567890...
// c.8 = A, c.9 = A (the "AA" in "GAA")
//
// Single-base duplications stay as simple dups
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_888888.1:c.8dup").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Single-base duplication should shift 3' and stay as dup
assert!(
output.contains("dup"),
"Single-base duplication should remain as dup notation, got: {}",
output
);
}
#[test]
fn test_duplication_3prime_shift_three_bases() {
// Test with three consecutive identical bases (TTT)
//
// NM_888888.1 sequence: ATGCCCGAAGCCCCCCCCCGTTTGCATGCATGCATGCAT
// Positions: ... 2021222324...
// c.20 = G, c.21 = T, c.22 = T, c.23 = T, c.24 = G
//
// Single-base duplications stay as simple dups
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_888888.1:c.21dup").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
// Single-base duplication should shift 3' to c.23 and stay as dup
assert!(
output.contains("dup"),
"Single-base duplication should remain as dup notation, got: {}",
output
);
}
#[test]
fn test_duplication_no_shift_when_unique() {
// Test that a duplication of a unique base doesn't shift
//
// NM_888888.1 sequence: ATGCCCGAAGCCCCCCCCCGTTTGCATGCATGCATGCAT
// c.7 = G (followed by AA, so no G to shift to)
//
// c.7dup should stay as c.7dup
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_888888.1:c.7dup").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
assert!(
output.contains("dup"),
"Should remain a duplication, got: {}",
output
);
assert!(
output.contains("c.7dup"),
"Duplication of unique G at c.7 should not shift, got: {}",
output
);
}
// =====================================================================
// Exon-Intron Boundary Spanning Variant Tests
// =====================================================================
/// Create a provider with a transcript that has genomic coordinates and introns
/// for testing boundary-spanning variant normalization.
///
/// Transcript structure (NM_BOUNDARY.1):
/// - Gene: BOUNDARY
/// - Strand: Plus
/// - Chromosome: chr1
///
/// Genomic layout (chr1):
/// Position: 1000 1020 1030 1050 1060 1080
/// |-------- Exon 1 ------| |-------- Exon 2 ------| |-------- Exon 3 ------|
/// ATGCCCAAAGGGTTTAGGCCC AAAGGGTTTAGGCCCAAAAAA GGGTTTAGGCCCAAATGA
/// ^^^ ^^^ ^^^ ^^^
/// intron 1 intron 2
///
/// Transcript positions (tx):
/// - Exon 1: tx 1-20 = genomic 1000-1019
/// - Intron 1: genomic 1020-1029 (10 bp)
/// - Exon 2: tx 21-40 = genomic 1030-1049
/// - Intron 2: genomic 1050-1059 (10 bp)
/// - Exon 3: tx 41-58 = genomic 1060-1077
///
/// CDS: starts at tx 1 (no 5' UTR for simplicity)
/// CDS positions: c.1 = tx 1, c.20 = tx 20 (last of exon 1), c.21 = tx 21 (first of exon 2)
///
/// Intron 1 sequence (g.1020-1029): "GTAAGCTAGG" (10 bp)
/// - c.20+1 = g.1020 (G)
/// - c.20+10 = g.1029 (G)
/// - c.21-10 = g.1020 (G)
/// - c.21-1 = g.1029 (G)
///
/// Intron 2 sequence (g.1050-1059): "GTAAGTAAGG" (10 bp)
fn make_boundary_test_provider() -> MockProvider {
use crate::reference::transcript::{Exon, ManeStatus, Strand, Transcript};
use std::sync::OnceLock;
let mut provider = MockProvider::new();
// Build transcript sequence (exons only, spliced)
// Exon 1 (20bp): ATGCCCAAAGGGTTTAGGCC (ends with CC at exon boundary)
// Exon 2 (20bp): AAAGGGTTTAGGCCCAAAAA (AA repeat at both boundaries)
// Exon 3 (18bp): GGGTTTAGGCCCAAATGA
// Total: 58bp transcript
let tx_seq = "ATGCCCAAAGGGTTTAGGCCAAAGGGTTTAGGCCCAAAAAGGGTTTAGGCCCAAATGA";
// Build genomic sequence around the transcript
// We'll create 100bp before, the gene region, and 100bp after
// Gene region: exon1 + intron1 + exon2 + intron2 + exon3
// = 20 + 10 + 20 + 10 + 18 = 78bp
//
// Genomic: 900-999 (padding) + 1000-1019 (exon1) + 1020-1029 (intron1) +
// 1030-1049 (exon2) + 1050-1059 (intron2) + 1060-1077 (exon3) + 1078+ (padding)
let mut genomic_seq = String::new();
// Padding before (positions 0-999, 1000 bytes at 0-based)
for _ in 0..1000 {
genomic_seq.push('N');
}
// Exon 1 (positions 1000-1019, 0-based 1000-1019)
genomic_seq.push_str("ATGCCCAAAGGGTTTAGGCC");
// Intron 1 (positions 1020-1029) - with splice consensus
// Note: The intron has AAA at the end (1027-1029) to test shifting
genomic_seq.push_str("GTAAGCTAAA");
// Exon 2 (positions 1030-1049)
genomic_seq.push_str("AAAGGGTTTAGGCCCAAAAA");
// Intron 2 (positions 1050-1059) - with AAA at start for testing
genomic_seq.push_str("AAAGTAAGGG");
// Exon 3 (positions 1060-1077)
genomic_seq.push_str("GGGTTTAGGCCCAAATGA");
// Padding after (100 bytes)
for _ in 0..100 {
genomic_seq.push('N');
}
// Add genomic sequence to provider
provider.add_genomic_sequence("chr1", genomic_seq);
// Create transcript with exons that have genomic coordinates
provider.add_transcript(Transcript {
id: "NM_BOUNDARY.1".to_string(),
gene_symbol: Some("BOUNDARY".to_string()),
strand: Strand::Plus,
sequence: Some(tx_seq.to_string()),
cds_start: Some(1),
cds_end: Some(58),
exons: vec![
Exon::with_genomic(1, 1, 20, 1000, 1019),
Exon::with_genomic(2, 21, 40, 1030, 1049),
Exon::with_genomic(3, 41, 58, 1060, 1077),
],
chromosome: Some("chr1".to_string()),
genomic_start: Some(1000),
genomic_end: Some(1077),
genome_build: Default::default(),
mane_status: ManeStatus::None,
refseq_match: None,
ensembl_match: None,
exon_cigars: Vec::new(),
cached_introns: OnceLock::new(),
});
provider
}
/// Minus-strand mirror of `make_boundary_test_provider`.
///
/// Same transcript sequence as the plus-strand fixture, so c.40_40+3
/// still spans the same poly-A region in transcript view. The genomic
/// content at the gene region is the reverse complement of each exon
/// (so RC of the genomic plus strand recovers `tx_seq`), and the
/// exon-to-genomic mapping is reversed: tx 1 maps to the high genomic
/// end (g.1077) and tx 58 to the low end (g.1000). Intron 2 is laid
/// out so that c.40+1..c.40+4 read as `A` in transcript view, putting
/// the boundary-spanning dup inside the same 5-A tract that the plus
/// fixture exercises.
fn make_boundary_test_provider_minus() -> MockProvider {
use crate::reference::transcript::{Exon, ManeStatus, Strand, Transcript};
use std::sync::OnceLock;
let mut provider = MockProvider::new();
let tx_seq = "ATGCCCAAAGGGTTTAGGCCAAAGGGTTTAGGCCCAAAAAGGGTTTAGGCCCAAATGA";
let mut genomic_seq = String::new();
for _ in 0..1000 {
genomic_seq.push('N');
}
// Exon 3 region (g.1000-1017): RC of tx[41..58] ("GGGTTTAGGCCCAAATGA").
genomic_seq.push_str("TCATTTGGGCCTAAACCC");
// Intron 2 (g.1018-1027): the last four bases (g.1024-1027) are 'T',
// so c.40+1..c.40+4 read as 'A' in transcript view, extending the
// exonic poly-A across the boundary.
genomic_seq.push_str("AAAGTATTTT");
// Exon 2 region (g.1028-1047): RC of tx[21..40] ("AAAGGGTTTAGGCCCAAAAA").
genomic_seq.push_str("TTTTTGGGCCTAAACCCTTT");
// Intron 1 (g.1048-1057): mirrors the plus fixture's intron 1 content.
genomic_seq.push_str("GTAAGCTAAA");
// Exon 1 region (g.1058-1077): RC of tx[1..20] ("ATGCCCAAAGGGTTTAGGCC").
genomic_seq.push_str("GGCCTAAACCCTTTGGGCAT");
for _ in 0..100 {
genomic_seq.push('N');
}
provider.add_genomic_sequence("chr1", genomic_seq);
provider.add_transcript(Transcript {
id: "NM_BOUNDARYM.1".to_string(),
gene_symbol: Some("BOUNDARY_M".to_string()),
strand: Strand::Minus,
sequence: Some(tx_seq.to_string()),
cds_start: Some(1),
cds_end: Some(58),
exons: vec![
Exon::with_genomic(1, 1, 20, 1058, 1077),
Exon::with_genomic(2, 21, 40, 1028, 1047),
Exon::with_genomic(3, 41, 58, 1000, 1017),
],
chromosome: Some("chr1".to_string()),
genomic_start: Some(1000),
genomic_end: Some(1077),
genome_build: Default::default(),
mane_status: ManeStatus::None,
refseq_match: None,
ensembl_match: None,
exon_cigars: Vec::new(),
cached_introns: OnceLock::new(),
});
provider
}
#[test]
fn test_boundary_spanning_exonic_to_intronic_del() {
// Test: c.20_20+3del - deletion from last exon base into intron
// c.20 = last base of exon 1 (C at g.1019)
// c.20+3 = 3rd intronic base (A at g.1022)
// Deletes: C (exonic) + GTA (intronic) = 4 bases
//
// This should normalize without error (using genomic space)
let provider = make_boundary_test_provider();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARY.1:c.20_20+3del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Boundary-spanning deletion should normalize, got error: {:?}",
result.err()
);
let output = format!("{}", result.unwrap());
assert!(
output.contains("del"),
"Should remain a deletion, got: {}",
output
);
}
#[test]
fn test_boundary_spanning_intronic_to_exonic_del() {
// Test: c.21-3_23del - deletion from intron into exon
// c.21-3 = 3rd base before exon 2 (A at g.1027)
// c.23 = 3rd base of exon 2 (A at g.1032)
// Deletes: AAA (intronic) + AAA (exonic) = 6 bases
//
// The intron ends with AAA (g.1027-1029) and exon starts with AAA (g.1030-1032)
// This is a repeat, so normalization might shift
let provider = make_boundary_test_provider();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARY.1:c.21-3_23del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Boundary-spanning deletion should normalize, got error: {:?}",
result.err()
);
let output = format!("{}", result.unwrap());
assert!(
output.contains("del"),
"Should remain a deletion, got: {}",
output
);
}
#[test]
fn test_boundary_spanning_same_base_position() {
// Test: c.20_20+5del - deletion starting and ending at same CDS base
// Start is exonic (c.20), end is intronic (c.20+5)
let provider = make_boundary_test_provider();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARY.1:c.20_20+5del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Same-base boundary-spanning deletion should normalize, got error: {:?}",
result.err()
);
}
#[test]
fn test_boundary_splice_site_plus1() {
// Test: c.20_20+1del - deletion of last exon base + splice donor (GT)
// This is a clinically important splice site variant
let provider = make_boundary_test_provider();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARY.1:c.20_20+1del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Splice site +1 deletion should normalize, got error: {:?}",
result.err()
);
}
#[test]
fn test_boundary_splice_site_minus1() {
// Test: c.21-1_22del - deletion of splice acceptor + first exon bases
// c.21-1 = last intronic base before exon 2 (A at g.1029)
// c.22 = 2nd base of exon 2 (A at g.1031)
let provider = make_boundary_test_provider();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARY.1:c.21-1_22del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Splice site -1 deletion should normalize, got error: {:?}",
result.err()
);
}
#[test]
fn test_boundary_spanning_dup() {
// Test: c.40_40+3dup - duplication spanning exon-intron boundary.
// The dup is 4 A's in a poly-A region. Per HGVS spec (repeated.md
// codon-frame exception): in c. context, repeat notation requires
// unit_len % 3 == 0, so unit_len=1 routes the multi-copy dup to
// `ins<literal>` form rather than `A[N]` or a multi-base dup.
let provider = make_boundary_test_provider();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARY.1:c.40_40+3dup").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Boundary-spanning duplication should normalize, got error: {:?}",
result.err()
);
let output = format!("{}", result.unwrap());
assert!(
output.contains("ins") && !output.contains("A["),
"Boundary-spanning multi-copy dup in c. with unit_len=1 must emit \
ins<literal> per codon-frame gate, got: {}",
output
);
}
#[test]
fn test_boundary_spanning_dup_minus_strand() {
// Minus-strand mirror of `test_boundary_spanning_dup`. Pins the
// strand-specific flip in `normalize_boundary_spanning_cds`: the
// genomic-strand window is RC of the transcript view, so without
// flipping, the codon-frame gate would inspect the wrong alphabet
// and the gated `ins<literal>` rewrite would not fire.
let provider = make_boundary_test_provider_minus();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARYM.1:c.40_40+3dup").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Boundary-spanning duplication should normalize, got error: {:?}",
result.err()
);
let output = format!("{}", result.unwrap());
assert!(
output.contains("ins") && !output.contains("A["),
"Minus-strand boundary-spanning multi-copy dup in c. with \
unit_len=1 must emit ins<literal> per codon-frame gate, got: {}",
output
);
}
#[test]
fn test_boundary_spanning_delins() {
// Test: c.20_20+2delinsTTT - delins spanning exon-intron boundary
let provider = make_boundary_test_provider();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_BOUNDARY.1:c.20_20+2delinsTTT").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Boundary-spanning delins should normalize, got error: {:?}",
result.err()
);
let output = format!("{}", result.unwrap());
assert!(
output.contains("delins") || output.contains(">"),
"Should remain a delins or become substitution, got: {}",
output
);
}
#[test]
fn test_boundary_no_genomic_data_returns_error() {
// Test that without genomic data, we still get the ExonIntronBoundary error
let provider = MockProvider::with_test_data(); // No genomic data
let normalizer = Normalizer::new(provider);
// NM_001234.1 doesn't have genomic coordinates
let variant = parse_hgvs("NM_001234.1:c.11_11+3del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_err(),
"Boundary-spanning without genomic data should return error"
);
}
#[test]
fn test_deletion_3prime_shift_consecutive_bases() {
// Test case simulating NM_001408491.1:c.517delA -> should become c.518del
// Create a transcript with consecutive A's at positions that should shift
use crate::reference::transcript::{Exon, ManeStatus, Strand};
use std::sync::OnceLock;
let mut provider = MockProvider::new();
// Create a sequence where c.517 and c.518 are both 'A'
// CDS starts at position 1, so c.N = transcript position N
// Put "AA" at positions 517-518 (1-based)
// Sequence: 516 bases of padding + "AA" + more padding
let mut seq = String::new();
for _ in 0..516 {
seq.push('G'); // Padding (not A to ensure we see the shift)
}
seq.push('A'); // Position 517 (c.517)
seq.push('A'); // Position 518 (c.518)
for _ in 519..=600 {
seq.push('G'); // More padding
}
provider.add_transcript(crate::reference::transcript::Transcript {
id: "NM_777777.1".to_string(),
gene_symbol: Some("SHIFTTEST".to_string()),
strand: Strand::Plus,
sequence: Some(seq.clone()),
cds_start: Some(1),
cds_end: Some(600),
exons: vec![Exon::new(1, 1, 600)], // Single exon covering all
chromosome: None,
genomic_start: None,
genomic_end: None,
genome_build: Default::default(),
mane_status: ManeStatus::None,
refseq_match: None,
ensembl_match: None,
exon_cigars: Vec::new(),
cached_introns: OnceLock::new(),
});
let normalizer = Normalizer::new(provider);
// Parse c.517delA - deleting the first A
let variant = parse_hgvs("NM_777777.1:c.517delA").unwrap();
// Debug: print the sequence around positions 517-518
println!("Sequence length: {}", seq.len());
println!(
"Position 516 (0-based 515): {}",
seq.chars().nth(515).unwrap()
);
println!(
"Position 517 (0-based 516): {}",
seq.chars().nth(516).unwrap()
);
println!(
"Position 518 (0-based 517): {}",
seq.chars().nth(517).unwrap()
);
println!(
"Position 519 (0-based 518): {}",
seq.chars().nth(518).unwrap()
);
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
println!("Input: NM_777777.1:c.517delA");
println!("Output: {}", output);
// The deletion should shift from c.517 to c.518 (3' rule)
// because both positions are 'A'
assert!(
output.contains("c.518del"),
"Deletion at c.517 should shift to c.518 (3' rule), got: {}",
output
);
}
#[test]
fn test_deletion_3prime_shift_with_utr() {
// Same test but with a 5' UTR (cds_start > 1)
// This simulates real transcripts more accurately
use crate::reference::transcript::{Exon, ManeStatus, Strand};
use std::sync::OnceLock;
let mut provider = MockProvider::new();
// Create a transcript with 100bp 5' UTR
// CDS starts at position 101, so:
// c.1 = tx position 101
// c.517 = tx position 617
// c.518 = tx position 618
let utr_len = 100;
let mut seq = String::new();
// 5' UTR (100 bases)
for _ in 0..utr_len {
seq.push('T');
}
// CDS: 516 bases of G padding, then "AA", then more G
for _ in 0..516 {
seq.push('G');
}
seq.push('A'); // tx position 617 = c.517
seq.push('A'); // tx position 618 = c.518
for _ in 0..100 {
seq.push('G');
}
let seq_len = seq.len();
println!("Test with UTR:");
println!(" Sequence length: {}", seq_len);
println!(" CDS start (1-based): 101");
println!(" c.517 = tx position 617 (0-based 616)");
println!(" c.518 = tx position 618 (0-based 617)");
println!(
" tx pos 617 (0-based 616): {}",
seq.chars().nth(616).unwrap()
);
println!(
" tx pos 618 (0-based 617): {}",
seq.chars().nth(617).unwrap()
);
provider.add_transcript(crate::reference::transcript::Transcript {
id: "NM_666666.1".to_string(),
gene_symbol: Some("UTRTEST".to_string()),
strand: Strand::Plus,
sequence: Some(seq.clone()),
cds_start: Some(101),
cds_end: Some(seq_len as u64),
exons: vec![Exon::new(1, 1, seq_len as u64)], // Single exon
chromosome: None,
genomic_start: None,
genomic_end: None,
genome_build: Default::default(),
mane_status: ManeStatus::None,
refseq_match: None,
ensembl_match: None,
exon_cigars: Vec::new(),
cached_introns: OnceLock::new(),
});
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_666666.1:c.517delA").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
println!("Input: NM_666666.1:c.517delA");
println!("Output: {}", output);
assert!(
output.contains("c.518del"),
"Deletion at c.517 should shift to c.518 (3' rule) even with UTR, got: {}",
output
);
}
#[test]
fn test_normalize_inverted_range_insertion_no_panic() {
// Regression: ClinVar pattern NC_000011.10:g.5238138_5153222insTATTT
// has start > end (inverted range). Previously caused a panic in
// insertion_is_duplication due to slice index out of bounds.
// The normalizer should return an error, not panic.
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NC_000011.10:g.5238138_5153222insTATTT").unwrap();
let result = normalizer.normalize(&variant);
// It's fine if this returns Ok (unchanged) or Err (validation failure),
// but it must NOT panic.
let _ = result;
}
#[test]
fn test_delins_should_not_shift() {
// HGVS spec: delins should NOT be 3' shifted like del/dup/ins
// This test ensures we don't incorrectly shift delins positions
use crate::reference::transcript::{Exon, ManeStatus, Strand};
use std::sync::OnceLock;
let mut provider = MockProvider::new();
// Create a transcript where delins could theoretically shift if we were wrong
// Sequence: ...GGAATTCC... where we do c.10_11delinsXX
// If incorrectly shifted, it might become c.11_12delinsXX
let seq = "GGGGGGGGGGAATTCCGGGGGGGGGG".to_string(); // c.10=A, c.11=A, c.12=T, c.13=T
provider.add_transcript(crate::reference::transcript::Transcript {
id: "NM_555555.1".to_string(),
gene_symbol: Some("DELINSTEST".to_string()),
strand: Strand::Plus,
sequence: Some(seq),
cds_start: Some(1),
cds_end: Some(26),
exons: vec![Exon::new(1, 1, 26)],
chromosome: None,
genomic_start: None,
genomic_end: None,
genome_build: Default::default(),
mane_status: ManeStatus::None,
refseq_match: None,
ensembl_match: None,
exon_cigars: Vec::new(),
cached_introns: OnceLock::new(),
});
let normalizer = Normalizer::new(provider);
// Test delins - should NOT shift
let variant = parse_hgvs("NM_555555.1:c.10_11delinsTT").unwrap();
let result = normalizer.normalize(&variant).unwrap();
let output = format!("{}", result);
assert!(
output.contains("c.10_11delins"),
"Delins should NOT be shifted (HGVS spec), got: {}",
output
);
}
#[test]
fn test_cds_to_tx_pos_utr5_underflow() {
// cds_start=5, base=-6 → 5 + (-6) - 1 = -2, should return Err not wrap to u64::MAX
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let pos = CdsPos {
base: -6,
offset: None,
utr3: false,
};
let result = normalizer.cds_to_tx_pos(&pos, 5, Some(38));
assert!(
result.is_err(),
"cds_to_tx_pos should return Err for positions before transcript start, got: {:?}",
result
);
}
#[test]
fn test_cds_to_tx_pos_utr5_valid() {
// HGVS numbering skips c.0, so c.-N maps to tx position
// cds_start - N. For cds_start=5, c.-3 → tx = 5 + (-3) = 2.
// Issue #97 — the previous formula `cds_start + base - 1`
// double-counted the gap and returned tx 1 (the c.-4 base).
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let pos = CdsPos {
base: -3,
offset: None,
utr3: false,
};
let result = normalizer.cds_to_tx_pos(&pos, 5, Some(38));
assert_eq!(result.unwrap(), 2);
}
#[test]
fn test_normalize_cds_utr5_deep_negative() {
// A deeply negative 5' UTR position that would overflow should return an error, not panic
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// c.-88 with cds_start=5 → 5 + (-88) - 1 = -84, which would wrap to huge u64
let variant = parse_hgvs("NM_001234.1:c.-88A>G").unwrap();
let result = normalizer.normalize(&variant);
// The primary check is that this doesn't panic.
let _ = result;
}
#[test]
fn test_normalize_unknown_offset_returns_unchanged() {
// Variants with ? offsets (sentinel values i64::MAX/MIN) should return unchanged
// because we can't normalize with indeterminate boundaries
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
// c.-85-?_834+?del has unknown offsets on both positions
let variant = parse_hgvs("NM_000088.3:c.-85-?_834+?del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Unknown offset should not error, got: {:?}",
result.err()
);
}
#[test]
fn test_normalize_unknown_offset_single_position() {
// Even a single unknown offset should cause early return
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_000088.3:c.10-?del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"Single unknown offset should not error, got: {:?}",
result.err()
);
}
#[test]
fn test_normalize_utr_before_tx_start_returns_unchanged() {
// c.-215 with a small UTR should not error - return unchanged
// NM_001234.1 has cds_start=5, so c.-215 maps to 5 + (-215) - 1 = -211
let provider = MockProvider::with_test_data();
let normalizer = Normalizer::new(provider);
let variant = parse_hgvs("NM_001234.1:c.-215_-214del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"UTR before transcript start should not error, got: {:?}",
result.err()
);
}
#[test]
fn test_normalize_no_cds_returns_unchanged() {
// An NR_ transcript with c. coordinates should not error
let mut provider = MockProvider::new();
use crate::reference::transcript::{Exon, Transcript};
provider.add_transcript(Transcript {
id: "NR_001566.1".to_string(),
gene_symbol: Some("NCRNA".to_string()),
strand: crate::reference::transcript::Strand::Plus,
sequence: Some("ATGCATGCATGCATGCATGCATGCATGCATGCATGCATGCATGCATGCATGC".to_string()),
cds_start: None,
cds_end: None,
exons: vec![Exon::new(1, 1, 51)],
chromosome: None,
genomic_start: None,
genomic_end: None,
genome_build: Default::default(),
mane_status: Default::default(),
refseq_match: None,
ensembl_match: None,
exon_cigars: Vec::new(),
cached_introns: std::sync::OnceLock::new(),
});
let normalizer = Normalizer::new(provider);
// c. variant on a non-coding transcript (no CDS)
let variant = parse_hgvs("NR_001566.1:c.10del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"No CDS should not error, got: {:?}",
result.err()
);
}
#[test]
fn test_normalize_tx_intronic() {
// n. intronic variants should normalize via genomic space
// Build a non-coding transcript with genomic coords and intronic positions
use crate::reference::transcript::{Exon, GenomeBuild, ManeStatus, Strand, Transcript};
let mut provider = MockProvider::new();
// Create transcript: 2 exons with an intron in between
// Exon 1: tx 1-100, genomic 1000-1099
// Intron: genomic 1100-1199
// Exon 2: tx 101-200, genomic 1200-1299
// Sequence in the intron around position 1100+: AAAA... (for shifting test)
let tx_sequence = "A".repeat(200);
provider.add_transcript(Transcript {
id: "NR_038982.1".to_string(),
gene_symbol: Some("NCRNA_TEST".to_string()),
strand: Strand::Plus,
sequence: Some(tx_sequence),
cds_start: None,
cds_end: None,
exons: vec![
Exon::with_genomic(1, 1, 100, 1000, 1099),
Exon::with_genomic(2, 101, 200, 1200, 1299),
],
chromosome: Some("chr1".to_string()),
genomic_start: Some(1000),
genomic_end: Some(1299),
genome_build: GenomeBuild::GRCh38,
mane_status: ManeStatus::None,
refseq_match: None,
ensembl_match: None,
exon_cigars: Vec::new(),
cached_introns: std::sync::OnceLock::new(),
});
// Add genomic sequence for chr1 around positions 1000-1299
// Make the intron region (1100-1199) be "AGCT" repeated to test shifting
let mut genomic = String::new();
for _ in 0..325 {
genomic.push_str("AGCT");
}
provider.add_genomic_sequence("chr1", genomic);
let normalizer = Normalizer::new(provider);
// n.100+4del - intronic deletion in a non-coding transcript
let variant = parse_hgvs("NR_038982.1:n.100+4del").unwrap();
let result = normalizer.normalize(&variant);
assert!(
result.is_ok(),
"n. intronic normalization should succeed, got: {:?}",
result.err()
);
let output = format!("{}", result.unwrap());
assert!(
output.contains('+') || output.contains('-'),
"Normalized intronic n. variant should retain intronic notation, got: {}",
output
);
}
}