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
use std::ops::{Deref, DerefMut};
use std::vec;
use crate::bindings as ll_bindings;
use crate::error::TskitError;
use crate::types::Bookmark;
use crate::IndividualTableSortOptions;
use crate::Position;
use crate::SimplificationOptions;
use crate::TableClearOptions;
use crate::TableEqualityOptions;
use crate::TableIntegrityCheckFlags;
use crate::TableOutputOptions;
use crate::TableSortOptions;
use crate::TreeSequenceFlags;
use crate::TskReturnValue;
use crate::TskitTypeAccess;
use crate::{tsk_id_t, tsk_size_t};
use crate::{EdgeId, NodeId};
use ll_bindings::tsk_table_collection_free;
use mbox::MBox;
/// A table collection.
///
/// This is a thin wrapper around the C type
/// [`tsk_table_collection_t`](crate::bindings::tsk_table_collection_t).
///
/// # See also
///
/// * [`metadata`](crate::metadata)
///
/// # Examples
///
/// ```
///
/// let mut tables = tskit::TableCollection::new(100.).unwrap();
/// assert_eq!(tables.sequence_length(), 100.);
///
/// // Adding edges:
///
/// let rv = tables.add_edge(0., 53., 1, 11).unwrap();
///
/// // Add node:
///
/// let rv = tables.add_node(0, 3.2, tskit::PopulationId::NULL, tskit::IndividualId::NULL).unwrap();
///
/// // Get immutable reference to edge table
/// let edges = tables.edges();
/// assert_eq!(edges.num_rows(), 1);
///
/// // Get immutable reference to node table
/// let nodes = tables.nodes();
/// assert_eq!(nodes.num_rows(), 1);
/// ```
///
pub struct TableCollection {
inner: MBox<ll_bindings::tsk_table_collection_t>,
idmap: Vec<NodeId>,
views: crate::table_views::TableViews,
}
impl TskitTypeAccess<ll_bindings::tsk_table_collection_t> for TableCollection {
fn as_ptr(&self) -> *const ll_bindings::tsk_table_collection_t {
&*self.inner
}
fn as_mut_ptr(&mut self) -> *mut ll_bindings::tsk_table_collection_t {
&mut *self.inner
}
}
impl Drop for TableCollection {
fn drop(&mut self) {
let rv = unsafe { tsk_table_collection_free(self.as_mut_ptr()) };
assert_eq!(rv, 0);
}
}
impl Deref for TableCollection {
type Target = crate::table_views::TableViews;
fn deref(&self) -> &Self::Target {
&self.views
}
}
impl DerefMut for TableCollection {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.views
}
}
/// Returns a pointer to an uninitialized tsk_table_collection_t
pub(crate) fn uninit_table_collection() -> MBox<ll_bindings::tsk_table_collection_t> {
let temp = unsafe {
libc::malloc(std::mem::size_of::<ll_bindings::tsk_table_collection_t>())
as *mut ll_bindings::tsk_table_collection_t
};
let nonnull = match std::ptr::NonNull::<ll_bindings::tsk_table_collection_t>::new(temp) {
Some(x) => x,
None => panic!("out of memory"),
};
unsafe { MBox::from_non_null_raw(nonnull) }
}
impl TableCollection {
/// Create a new table collection with a sequence length.
///
/// # Examples
///
/// ```
/// let tables = tskit::TableCollection::new(55.0).unwrap();
/// ```
///
/// Negative sequence lengths are errors:
///
/// ```{should_panic}
/// let tables = tskit::TableCollection::new(-55.0).unwrap();
/// ```
pub fn new<P: Into<Position>>(sequence_length: P) -> Result<Self, TskitError> {
let sequence_length = sequence_length.into();
if sequence_length <= 0. {
return Err(TskitError::ValueError {
got: sequence_length.0.to_string(),
expected: "sequence_length >= 0.0".to_string(),
});
}
let mut mbox = uninit_table_collection();
let rv = unsafe { ll_bindings::tsk_table_collection_init(&mut *mbox, 0) };
if rv < 0 {
return Err(crate::error::TskitError::ErrorCode { code: rv });
}
let views = crate::table_views::TableViews::new_from_mbox_table_collection(&mut mbox)?;
// AHA?
assert!(std::ptr::eq(
&mbox.as_ref().edges as *const ll_bindings::tsk_edge_table_t,
views.edges().table_.as_ptr() as *const ll_bindings::tsk_edge_table_t
));
let mut tables = Self {
inner: mbox,
idmap: vec![],
views,
};
unsafe {
(*tables.as_mut_ptr()).sequence_length = sequence_length.0;
}
Ok(tables)
}
/// # Safety
///
/// It is possible that the mbox's inner pointer has not be run through
/// tsk_table_collection_init, meaning that it is in an uninitialized state.
/// Or, it may be initialized and about to be used in a part of the C API
/// requiring an uninitialized table collection.
/// Consult the C API docs before using!
pub(crate) unsafe fn new_from_mbox(
mbox: MBox<ll_bindings::tsk_table_collection_t>,
) -> Result<Self, TskitError> {
let mut mbox = mbox;
let views = crate::table_views::TableViews::new_from_mbox_table_collection(&mut mbox)?;
Ok(Self {
inner: mbox,
idmap: vec![],
views,
})
}
pub(crate) fn into_raw(self) -> Result<*mut ll_bindings::tsk_table_collection_t, TskitError> {
let mut tables = self;
// rust won't let use move inner out b/c this type implements Drop.
// So we have to replace the existing pointer with a new one.
let table_ptr = unsafe {
libc::malloc(std::mem::size_of::<ll_bindings::tsk_table_collection_t>())
as *mut ll_bindings::tsk_table_collection_t
};
let rv = unsafe { ll_bindings::tsk_table_collection_init(table_ptr, 0) };
let mut temp = unsafe { MBox::from_raw(table_ptr) };
std::mem::swap(&mut temp, &mut tables.inner);
handle_tsk_return_value!(rv, MBox::into_raw(temp))
}
/// Load a table collection from a file.
///
/// # Examples
///
/// The function is generic over references to `str`:
///
/// ```
/// # let empty_tables = tskit::TableCollection::new(100.).unwrap();
/// # empty_tables.dump("trees.file", tskit::TableOutputOptions::default()).unwrap();
/// let tables = tskit::TableCollection::new_from_file("trees.file").unwrap();
///
/// let filename = String::from("trees.file");
/// // Pass filename by reference
/// let tables = tskit::TableCollection::new_from_file(&filename).unwrap();
///
/// // Move filename
/// let tables = tskit::TableCollection::new_from_file(filename).unwrap();
///
/// // Boxed String are an unlikely use case, but can be made to work:
/// let filename = Box::new(String::from("trees.file"));
/// let tables = tskit::TableCollection::new_from_file(&*filename.as_ref()).unwrap();
/// # std::fs::remove_file("trees.file").unwrap();
/// ```
///
/// # Panics
///
/// This function allocates a `CString` to pass the file name to the C API.
/// A panic will occur if the system runs out of memory.
pub fn new_from_file(filename: impl AsRef<str>) -> Result<Self, TskitError> {
// Arbitrary sequence_length.
let mut tables = match TableCollection::new(1.0) {
Ok(t) => t,
Err(e) => return Err(e),
};
let c_str = std::ffi::CString::new(filename.as_ref()).map_err(|_| {
TskitError::LibraryError("call to ffi::CString::new failed".to_string())
})?;
let rv = unsafe {
ll_bindings::tsk_table_collection_load(
tables.as_mut_ptr(),
c_str.as_ptr(),
ll_bindings::TSK_NO_INIT,
)
};
handle_tsk_return_value!(rv, tables)
}
/// Length of the sequence/"genome".
/// # Examples
///
/// ```
/// let tables = tskit::TableCollection::new(100.).unwrap();
/// assert_eq!(tables.sequence_length(), 100.0);
/// ```
pub fn sequence_length(&self) -> Position {
unsafe { (*self.as_ptr()).sequence_length }.into()
}
edge_table_add_row!(
/// Add a row to the edge table
///
/// # Examples
///
/// ```
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
///
/// // left, right, parent, child
/// match tables.add_edge(0., 53., 1, 11) {
/// // This is the first edge, so its id will be
/// // zero (0).
/// Ok(edge_id) => assert_eq!(edge_id, 0),
/// Err(e) => panic!("{:?}", e),
/// }
/// ```
///
/// You may also use [`Position`] and [`NodeId`] as inputs.
///
/// ```
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// let left = tskit::Position::from(0.0);
/// let right = tskit::Position::from(53.0);
/// let parent = tskit::NodeId::from(1);
/// let child = tskit::NodeId::from(11);
/// match tables.add_edge(left, right, parent, child) {
/// Ok(edge_id) => assert_eq!(edge_id, 0),
/// Err(e) => panic!("{:?}", e),
/// }
/// ```
///
/// Adding invalid data is allowed at this point:
///
/// ```
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// assert!(tables.add_edge(0., 53.,
/// tskit::NodeId::NULL,
/// tskit::NodeId::NULL).is_ok());
/// # assert!(tables.check_integrity(tskit::TableIntegrityCheckFlags::default()).is_err());
/// ```
///
/// See [`TableCollection::check_integrity`] for how to catch these data model
/// violations.
=> add_edge, self, self.inner.edges);
edge_table_add_row_with_metadata!(
/// Add a row with optional metadata to the edge table
///
/// # Examples
///
/// See [`metadata`](crate::metadata) for more details about required
/// trait implementations.
/// Those details have been omitted from this example.
///
/// ```
/// # #[cfg(feature = "derive")] {
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::EdgeMetadata)]
/// # #[serializer("serde_json")]
/// # struct EdgeMetadata {
/// # x: i32,
/// # }
/// let metadata = EdgeMetadata{x: 1};
/// assert!(tables.add_edge_with_metadata(0., 53., 1, 11, &metadata).is_ok());
/// # }
/// ```
=> add_edge_with_metadata, self, self.inner.edges);
individual_table_add_row!(
/// Add a row to the individual table
///
/// # Examples
///
/// ## No flags, location, nor parents
///
/// ```
/// #
/// # let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// tables.add_individual(0, None, None).unwrap();
/// # assert!(tables.individuals().location(0).is_none());
/// # assert!(tables.individuals().parents(0).is_none());
/// ```
///
/// ## No flags, a 3d location, no parents
///
/// ```
/// #
/// # let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// tables.add_individual(0, &[-0.5, 0.3, 10.0], None).unwrap();
/// # match tables.individuals().location(0) {
/// # Some(loc) => loc.iter().zip([-0.5, 0.3, 10.0].iter()).for_each(|(a,b)| assert_eq!(a, b)),
/// # None => panic!("expected a location"),
/// # }
/// ```
///
/// ## No flags, no location, two parents
/// ```
/// # let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// #
/// tables.add_individual(0, None, &[1, 11]);
/// # match tables.individuals().parents(0) {
/// # Some(parents) => parents.iter().zip([1, 11].iter()).for_each(|(a,b)| assert_eq!(a, b)),
/// # None => panic!("expected parents"),
/// # }
/// ```
=> add_individual, self, self.inner.individuals);
individual_table_add_row_with_metadata!(
/// Add a row with metadata to the individual table
///
/// # Examples
///
/// See [`metadata`](crate::metadata) for more details about required
/// trait implementations.
/// Those details have been omitted from this example.
///
/// ```
/// # #[cfg(feature = "derive")] {
///
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::IndividualMetadata)]
/// # #[serializer("serde_json")]
/// # struct IndividualMetadata {
/// # x: i32,
/// # }
/// let metadata = IndividualMetadata{x: 1};
/// assert!(tables.add_individual_with_metadata(0, None, None,
/// &metadata).is_ok());
/// # let decoded = tables.individuals().metadata::<IndividualMetadata>(0.into()).unwrap().unwrap();
/// # assert_eq!(decoded.x, 1);
/// # }
=> add_individual_with_metadata, self, self.inner.individuals);
migration_table_add_row!(
/// Add a row to the migration table
///
/// # Warnings
///
/// Migration tables are not currently supported
/// by tree sequence simplification.
/// # Examples
///
/// ```
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// assert!(tables.add_migration((0.5, 100.0),
/// 3,
/// (0, 1),
/// 53.5).is_ok());
/// ```
=> add_migration, self, self.inner.migrations);
migration_table_add_row_with_metadata!(
/// Add a row with optional metadata to the migration table
///
/// # Examples
///
/// See [`metadata`](crate::metadata) for more details about required
/// trait implementations.
/// Those details have been omitted from this example.
///
/// ```
/// # #[cfg(feature = "derive")] {
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::MigrationMetadata)]
/// # #[serializer("serde_json")]
/// # struct MigrationMetadata {
/// # x: i32,
/// # }
/// let metadata = MigrationMetadata{x: 1};
/// assert!(tables.add_migration_with_metadata((0.5, 100.0),
/// 3,
/// (0, 1),
/// 53.5,
/// &metadata).is_ok());
/// # }
/// ```
///
/// # Warnings
///
/// Migration tables are not currently supported
/// by tree sequence simplification.
=> add_migration_with_metadata, self, self.inner.migrations);
node_table_add_row!(
/// Add a row to the node table
=> add_node, self, self.inner.nodes
);
node_table_add_row_with_metadata!(
/// Add a row with optional metadata to the node table
///
/// # Examples
///
/// See [`metadata`](crate::metadata) for more details about required
/// trait implementations.
/// Those details have been omitted from this example.
///
/// ```
/// # #[cfg(feature = "derive")] {
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::NodeMetadata)]
/// # #[serializer("serde_json")]
/// # struct NodeMetadata {
/// # x: i32,
/// # }
/// let metadata = NodeMetadata{x: 1};
/// assert!(tables.add_node_with_metadata(0, 0.0, -1, -1, &metadata).is_ok());
/// # }
/// ```
=> add_node_with_metadata, self, self.inner.nodes);
site_table_add_row!(
/// Add a row to the site table
=> add_site, self, self.inner.sites);
site_table_add_row_with_metadata!(
/// Add a row with optional metadata to the site table
///
/// # Examples
///
/// See [`metadata`](crate::metadata) for more details about required
/// trait implementations.
/// Those details have been omitted from this example.
///
/// ```
/// # #[cfg(feature = "derive")] {
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::SiteMetadata)]
/// # #[serializer("serde_json")]
/// # struct SiteMetadata {
/// # x: i32,
/// # }
/// let metadata = SiteMetadata{x: 1};
/// assert!(tables.add_site_with_metadata(tskit::Position::from(111.0),
/// Some(&[111]),
/// &metadata).is_ok());
/// # }
/// ```
=> add_site_with_metadata, self, self.inner.sites);
mutation_table_add_row!(
/// Add a row to the mutation table.
=> add_mutation, self, self.inner.mutations);
mutation_table_add_row_with_metadata!(
/// Add a row with optional metadata to the mutation table.
///
/// # Examples
///
/// See [`metadata`](crate::metadata) for more details about required
/// trait implementations.
/// Those details have been omitted from this example.
///
/// ```
/// # #[cfg(feature = "derive")] {
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::MutationMetadata)]
/// # #[serializer("serde_json")]
/// # struct MutationMetadata {
/// # x: i32,
/// # }
/// let metadata = MutationMetadata{x: 1};
/// assert!(tables.add_mutation_with_metadata(0, 0, 0, 100.0, None,
/// &metadata).is_ok());
/// # }
/// ```
=> add_mutation_with_metadata, self, self.inner.mutations);
population_table_add_row!(
/// Add a row to the population_table
///
/// # Examples
///
/// ```
/// # let mut tables = tskit::TableCollection::new(55.0).unwrap();
/// tables.add_population().unwrap();
/// ```
=> add_population, self, self.inner.populations);
population_table_add_row_with_metadata!(
/// Add a row with optional metadata to the population_table
///
/// # Examples
///
/// See [`metadata`](crate::metadata) for more details about required
/// trait implementations.
/// Those details have been omitted from this example.
///
/// ```
/// # #[cfg(feature = "derive")] {
/// # let mut tables = tskit::TableCollection::new(100.).unwrap();
/// # #[derive(serde::Serialize, serde::Deserialize, tskit::metadata::PopulationMetadata)]
/// # #[serializer("serde_json")]
/// # struct PopulationMetadata {
/// # x: i32,
/// # }
/// let metadata = PopulationMetadata{x: 1};
/// assert!(tables.add_population_with_metadata(&metadata).is_ok());
/// # }
=> add_population_with_metadata, self, self.inner.populations);
/// Build the "input" and "output"
/// indexes for the edge table.
///
/// # Note
///
/// The `C API` call behind this takes a `flags` argument
/// that is currently unused. A future release may break `API`
/// here if the `C` library is updated to use flags.
pub fn build_index(&mut self) -> TskReturnValue {
let rv = unsafe { ll_bindings::tsk_table_collection_build_index(self.as_mut_ptr(), 0) };
handle_tsk_return_value!(rv)
}
/// Return `true` if tables are indexed.
pub fn is_indexed(&self) -> bool {
unsafe { ll_bindings::tsk_table_collection_has_index(self.as_ptr(), 0) }
}
/// If `self.is_indexed()` is `true`, return a non-owning
/// slice containing the edge insertion order.
/// Otherwise, return `None`.
pub fn edge_insertion_order(&self) -> Option<&[EdgeId]> {
if self.is_indexed() {
Some(unsafe {
std::slice::from_raw_parts(
(*self.as_ptr()).indexes.edge_insertion_order as *const EdgeId,
usize::try_from((*self.as_ptr()).indexes.num_edges).ok()?,
)
})
} else {
None
}
}
/// If `self.is_indexed()` is `true`, return a non-owning
/// slice containing the edge removal order.
/// Otherwise, return `None`.
pub fn edge_removal_order(&self) -> Option<&[EdgeId]> {
if self.is_indexed() {
Some(unsafe {
std::slice::from_raw_parts(
(*self.as_ptr()).indexes.edge_removal_order as *const EdgeId,
usize::try_from((*self.as_ptr()).indexes.num_edges).ok()?,
)
})
} else {
None
}
}
/// Sort the tables.
/// The [``bookmark``](crate::types::Bookmark) can
/// be used to affect where sorting starts from for each table.
///
/// # Details
///
/// See [`full_sort`](crate::TableCollection::full_sort)
/// for more details about which tables are sorted.
pub fn sort<O: Into<TableSortOptions>>(
&mut self,
start: &Bookmark,
options: O,
) -> TskReturnValue {
let rv = unsafe {
ll_bindings::tsk_table_collection_sort(
self.as_mut_ptr(),
&start.offsets,
options.into().bits(),
)
};
handle_tsk_return_value!(rv)
}
/// Fully sort all tables.
/// Implemented via a call to [``sort``](crate::TableCollection::sort).
///
/// # Details
///
/// This function only sorts the tables that have a strict sortedness
/// requirement according to the `tskit` [data
/// model](https://tskit.dev/tskit/docs/stable/data-model.html).
///
/// These tables are:
///
/// * edges
/// * mutations
/// * sites
///
/// For some use cases it is desirable to have the individual table
/// sorted so that parents appear before offspring. See
/// [``topological_sort_individuals``](crate::TableCollection::topological_sort_individuals).
pub fn full_sort<O: Into<TableSortOptions>>(&mut self, options: O) -> TskReturnValue {
let b = Bookmark::new();
self.sort(&b, options)
}
/// Sorts the individual table in place, so that parents come before children,
/// and the parent column is remapped as required. Node references to individuals
/// are also updated.
///
/// This function is needed because neither [``sort``](crate::TableCollection::sort) nor
/// [``full_sort``](crate::TableCollection::full_sort) sorts
/// the individual table!
///
/// # Examples
///
/// ```
/// // Parent comes AFTER the child
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let i0 = tables.add_individual(0, None, &[1]).unwrap();
/// assert_eq!(i0, 0);
/// let i1 = tables.add_individual(0, None, None).unwrap();
/// assert_eq!(i1, 1);
/// let n0 = tables.add_node(0, 0.0, -1, i1).unwrap();
/// assert_eq!(n0, 0);
/// let n1 = tables.add_node(0, 1.0, -1, i0).unwrap();
/// assert_eq!(n1, 1);
///
/// // Testing for valid individual order will Err:
/// match tables.check_integrity(tskit::TableIntegrityCheckFlags::CHECK_INDIVIDUAL_ORDERING) {
/// Ok(_) => panic!("expected Err"),
/// Err(_) => (),
/// };
///
/// // The standard sort doesn't fix the Err...:
/// tables.full_sort(tskit::TableSortOptions::default()).unwrap();
/// match tables.check_integrity(tskit::TableIntegrityCheckFlags::CHECK_INDIVIDUAL_ORDERING) {
/// Ok(_) => panic!("expected Err"),
/// Err(_) => (),
/// };
///
/// // ... so we need to intentionally sort the individuals.
/// let _ = tables.topological_sort_individuals(tskit::IndividualTableSortOptions::default()).unwrap();
/// tables.check_integrity(tskit::TableIntegrityCheckFlags::CHECK_INDIVIDUAL_ORDERING).unwrap();
/// ```
///
/// # Errors
///
/// Will return an error code if the underlying `C` function returns an error.
pub fn topological_sort_individuals<O: Into<IndividualTableSortOptions>>(
&mut self,
options: O,
) -> TskReturnValue {
let rv = unsafe {
ll_bindings::tsk_table_collection_individual_topological_sort(
self.as_mut_ptr(),
options.into().bits(),
)
};
handle_tsk_return_value!(rv)
}
/// Dump the table collection to file.
///
/// # Panics
///
/// This function allocates a `CString` to pass the file name to the C API.
/// A panic will occur if the system runs out of memory.
pub fn dump<O: Into<TableOutputOptions>>(&self, filename: &str, options: O) -> TskReturnValue {
let c_str = std::ffi::CString::new(filename).map_err(|_| {
TskitError::LibraryError("call to ffi::CString::new failed".to_string())
})?;
let rv = unsafe {
ll_bindings::tsk_table_collection_dump(
self.as_ptr(),
c_str.as_ptr(),
options.into().bits(),
)
};
handle_tsk_return_value!(rv)
}
/// Clear the contents of all tables.
/// Does not release memory.
/// Memory will be released when the object goes out
/// of scope.
pub fn clear<O: Into<TableClearOptions>>(&mut self, options: O) -> TskReturnValue {
let rv = unsafe {
ll_bindings::tsk_table_collection_clear(self.as_mut_ptr(), options.into().bits())
};
handle_tsk_return_value!(rv)
}
/// Free all memory allocated on the C side.
/// Not public b/c not very safe.
#[allow(dead_code)]
fn free(&mut self) -> TskReturnValue {
let rv = unsafe { ll_bindings::tsk_table_collection_free(self.as_mut_ptr()) };
handle_tsk_return_value!(rv)
}
/// Return ``true`` if ``self`` contains the same
/// data as ``other``, and ``false`` otherwise.
pub fn equals<O: Into<TableEqualityOptions>>(
&self,
other: &TableCollection,
options: O,
) -> bool {
unsafe {
ll_bindings::tsk_table_collection_equals(
self.as_ptr(),
other.as_ptr(),
options.into().bits(),
)
}
}
/// Return a "deep" copy of the tables.
pub fn deepcopy(&self) -> Result<TableCollection, TskitError> {
// The output is UNINITIALIZED tables,
// else we leak memory
let mut inner = uninit_table_collection();
let rv = unsafe { ll_bindings::tsk_table_collection_copy(self.as_ptr(), &mut *inner, 0) };
// SAFETY: we just initialized it.
// The C API doesn't free NULL pointers.
handle_tsk_return_value!(rv, unsafe { Self::new_from_mbox(inner)? })
}
/// Return a [`crate::TreeSequence`] based on the tables.
/// This function will raise errors if tables are not sorted,
/// not indexed, or invalid in any way.
pub fn tree_sequence(
self,
flags: TreeSequenceFlags,
) -> Result<crate::TreeSequence, TskitError> {
crate::TreeSequence::new(self, flags)
}
/// Simplify tables in place.
///
/// # Parameters
///
/// * `samples`: a slice containing non-null node ids.
/// The tables are simplified with respect to the ancestry
/// of these nodes.
/// * `options`: A [`SimplificationOptions`] bit field controlling
/// the behavior of simplification.
/// * `idmap`: if `true`, the return value contains a vector equal
/// in length to the input node table. For each input node,
/// this vector either contains the node's new index or [`NodeId::NULL`]
/// if the input node is not part of the simplified history.
pub fn simplify<N: Into<NodeId>, O: Into<SimplificationOptions>>(
&mut self,
samples: &[N],
options: O,
idmap: bool,
) -> Result<Option<&[NodeId]>, TskitError> {
if idmap {
self.idmap
.resize(usize::try_from(self.nodes().num_rows())?, NodeId::NULL);
}
let rv = unsafe {
ll_bindings::tsk_table_collection_simplify(
self.as_mut_ptr(),
samples.as_ptr().cast::<tsk_id_t>(),
samples.len() as tsk_size_t,
options.into().bits(),
match idmap {
true => self.idmap.as_mut_ptr().cast::<tsk_id_t>(),
false => std::ptr::null_mut(),
},
)
};
handle_tsk_return_value!(
rv,
match idmap {
true => Some(&self.idmap),
false => None,
}
)
}
/// Validate the contents of the table collection
///
/// # Parameters
///
/// `flags` is an instance of [`TableIntegrityCheckFlags`]
///
/// # Return value
///
/// `0` upon success, or an error code.
/// However, if `flags` contains [`TableIntegrityCheckFlags::CHECK_TREES`],
/// and no error is returned, then the return value is the number
/// of trees.
///
/// # Note
///
/// Creating a [`crate::TreeSequence`] from a table collection will automatically
/// run an integrity check.
/// See [`TableCollection::tree_sequence`].
///
/// # Examples
///
/// There are many ways for a table colletion to be invalid.
/// These examples are just the tip of the iceberg.
///
/// ```should_panic
/// let mut tables = tskit::TableCollection::new(10.0).unwrap();
/// // Right position is > sequence_length
/// tables.add_edge(0.0, 11.0, 0, 0);
/// tables.check_integrity(tskit::TableIntegrityCheckFlags::default()).unwrap();
/// ```
///
/// ```should_panic
/// # let mut tables = tskit::TableCollection::new(10.0).unwrap();
/// // Left position is < 0.0
/// tables.add_edge(-1., 10.0, 0, 0);
/// tables.check_integrity(tskit::TableIntegrityCheckFlags::default()).unwrap();
/// ```
///
/// ```should_panic
/// # let mut tables = tskit::TableCollection::new(10.0).unwrap();
/// // Edges cannot have null node ids
/// tables.add_edge(0., 10.0, tskit::NodeId::NULL, 0);
/// tables.check_integrity(tskit::TableIntegrityCheckFlags::default()).unwrap();
/// ```
pub fn check_integrity(&self, flags: TableIntegrityCheckFlags) -> TskReturnValue {
let rv = unsafe {
ll_bindings::tsk_table_collection_check_integrity(self.as_ptr(), flags.bits())
};
handle_tsk_return_value!(rv)
}
#[cfg(feature = "provenance")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "provenance")))]
provenance_table_add_row!(
/// Add provenance record with a time stamp.
///
/// All implementation of this trait provided by `tskit` use
/// an `ISO 8601` format time stamp
/// written using the [RFC 3339](https://tools.ietf.org/html/rfc3339)
/// specification.
/// This formatting approach has been the most straightforward method
/// for supporting round trips to/from a [`crate::provenance::ProvenanceTable`].
/// The implementations used here use the [`humantime`](https://docs.rs/humantime/latest/humantime/) crate.
///
/// # Parameters
///
/// * `record`: the provenance record
///
/// # Examples
/// ```
///
/// let mut tables = tskit::TableCollection::new(1000.).unwrap();
/// # #[cfg(feature = "provenance")] {
/// tables.add_provenance(&String::from("Some provenance")).unwrap();
///
/// // Get reference to the table
/// let prov_ref = tables.provenances();
///
/// // Get the first row
/// let row_0 = prov_ref.row(0).unwrap();
///
/// assert_eq!(row_0.record, "Some provenance");
///
/// // Get the first record
/// let record_0 = prov_ref.record(0).unwrap();
/// assert_eq!(record_0, row_0.record);
///
/// // Get the first time stamp
/// let timestamp = prov_ref.timestamp(0).unwrap();
/// assert_eq!(timestamp, row_0.timestamp);
///
/// // You can get the `humantime::Timestamp` object back from the `String`:
/// use core::str::FromStr;
/// let timestamp_string = humantime::Timestamp::from_str(×tamp).unwrap();
///
/// // Provenance transfers to the tree sequences
/// let treeseq = tables.tree_sequence(tskit::TreeSequenceFlags::BUILD_INDEXES).unwrap();
/// assert_eq!(treeseq.provenances().record(0).unwrap(), "Some provenance");
/// // We can still compare to row_0 because it is a copy of the row data:
/// assert_eq!(treeseq.provenances().record(0).unwrap(), row_0.record);
/// # }
/// ```
=> add_provenance, self, self.inner.provenances);
/// Set the edge table from an [`OwnedEdgeTable`](`crate::OwnedEdgeTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut edges = tskit::OwnedEdgeTable::default();
/// edges.add_row(0., 1., 0, 12).unwrap();
/// tables.set_edges(&edges).unwrap();
/// assert_eq!(tables.edges().num_rows(), 1);
/// assert_eq!(tables.edges().child(0).unwrap(), 12);
/// # edges.clear().unwrap();
/// # assert_eq!(edges.num_rows(), 0);
/// ```
pub fn set_edges(&mut self, edges: &crate::OwnedEdgeTable) -> TskReturnValue {
// SAFETY: neither self nor edges are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_edge_table_set_columns(
&mut self.inner.edges,
(*edges.as_ptr()).num_rows,
(*edges.as_ptr()).left,
(*edges.as_ptr()).right,
(*edges.as_ptr()).parent,
(*edges.as_ptr()).child,
(*edges.as_ptr()).metadata,
(*edges.as_ptr()).metadata_offset,
)
};
handle_tsk_return_value!(rv)
}
/// Set the node table from an [`OwnedNodeTable`](`crate::OwnedNodeTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut nodes = tskit::OwnedNodeTable::default();
/// nodes.add_row(0, 10.0, -1, -1).unwrap();
/// tables.set_nodes(&nodes).unwrap();
/// assert_eq!(tables.nodes().num_rows(), 1);
/// assert_eq!(tables.nodes().time(0).unwrap(), 10.0);
/// # nodes.clear().unwrap();
/// # assert_eq!(nodes.num_rows(), 0);
/// ```
pub fn set_nodes(&mut self, nodes: &crate::OwnedNodeTable) -> TskReturnValue {
// SAFETY: neither self nor nodes are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_node_table_set_columns(
&mut self.inner.nodes,
(*nodes.as_ptr()).num_rows,
(*nodes.as_ptr()).flags,
(*nodes.as_ptr()).time,
(*nodes.as_ptr()).population,
(*nodes.as_ptr()).individual,
(*nodes.as_ptr()).metadata,
(*nodes.as_ptr()).metadata_offset,
)
};
handle_tsk_return_value!(rv)
}
/// Set the site table from an [`OwnedSiteTable`](`crate::OwnedSiteTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut sites = tskit::OwnedSiteTable::default();
/// sites.add_row(11.0, None).unwrap();
/// tables.set_sites(&sites).unwrap();
/// assert_eq!(tables.sites().num_rows(), 1);
/// assert_eq!(tables.sites().position(0).unwrap(), 11.0);
/// # sites.clear().unwrap();
/// # assert_eq!(sites.num_rows(), 0);
/// ```
pub fn set_sites(&mut self, sites: &crate::OwnedSiteTable) -> TskReturnValue {
// SAFETY: neither self nor nodes are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_site_table_set_columns(
&mut self.inner.sites,
(*sites.as_ptr()).num_rows,
(*sites.as_ptr()).position,
(*sites.as_ptr()).ancestral_state,
(*sites.as_ptr()).ancestral_state_offset,
(*sites.as_ptr()).metadata,
(*sites.as_ptr()).metadata_offset,
)
};
handle_tsk_return_value!(rv)
}
/// Set the mutation table from an [`OwnedMutationTable`](`crate::OwnedSiteTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut mutations = tskit::OwnedMutationTable::default();
/// mutations.add_row(14, 12, -1, 11.3, None).unwrap();
/// tables.set_mutations(&mutations).unwrap();
/// assert_eq!(tables.mutations().num_rows(), 1);
/// assert_eq!(tables.mutations().site(0).unwrap(), 14);
/// # mutations.clear().unwrap();
/// # assert_eq!(mutations.num_rows(), 0);
/// ```
pub fn set_mutations(&mut self, mutations: &crate::OwnedMutationTable) -> TskReturnValue {
// SAFETY: neither self nor nodes are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_mutation_table_set_columns(
&mut self.inner.mutations,
(*mutations.as_ptr()).num_rows,
(*mutations.as_ptr()).site,
(*mutations.as_ptr()).node,
(*mutations.as_ptr()).parent,
(*mutations.as_ptr()).time,
(*mutations.as_ptr()).derived_state,
(*mutations.as_ptr()).derived_state_offset,
(*mutations.as_ptr()).metadata,
(*mutations.as_ptr()).metadata_offset,
)
};
handle_tsk_return_value!(rv)
}
/// Set the individual table from an [`OwnedIndividualTable`](`crate::OwnedSiteTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut individuals = tskit::OwnedIndividualTable::default();
/// individuals.add_row(0, [0.1, 10.0], None).unwrap();
/// tables.set_individuals(&individuals).unwrap();
/// assert_eq!(tables.individuals().num_rows(), 1);
/// let expected = vec![tskit::Location::from(0.1), tskit::Location::from(10.0)];
/// assert_eq!(tables.individuals().location(0), Some(expected.as_slice()));
/// # individuals.clear().unwrap();
/// # assert_eq!(individuals.num_rows(), 0);
/// ```
pub fn set_individuals(&mut self, individuals: &crate::OwnedIndividualTable) -> TskReturnValue {
// SAFETY: neither self nor nodes are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_individual_table_set_columns(
&mut self.inner.individuals,
(*individuals.as_ptr()).num_rows,
(*individuals.as_ptr()).flags,
(*individuals.as_ptr()).location,
(*individuals.as_ptr()).location_offset,
(*individuals.as_ptr()).parents,
(*individuals.as_ptr()).parents_offset,
(*individuals.as_ptr()).metadata,
(*individuals.as_ptr()).metadata_offset,
)
};
handle_tsk_return_value!(rv)
}
/// Set the migration table from an [`OwnedMigrationTable`](`crate::OwnedSiteTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut migrations = tskit::OwnedMigrationTable::default();
/// migrations.add_row((0.25, 0.37), 1, (0, 1), 111.0).unwrap();
/// tables.set_migrations(&migrations).unwrap();
/// assert_eq!(tables.migrations().num_rows(), 1);
/// assert_eq!(tables.migrations().time(0).unwrap(), 111.0);
/// # migrations.clear().unwrap();
/// # assert_eq!(migrations.num_rows(), 0);
/// ```
pub fn set_migrations(&mut self, migrations: &crate::OwnedMigrationTable) -> TskReturnValue {
// SAFETY: neither self nor edges are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_migration_table_set_columns(
&mut self.inner.migrations,
(*migrations.as_ptr()).num_rows,
(*migrations.as_ptr()).left,
(*migrations.as_ptr()).right,
(*migrations.as_ptr()).node,
(*migrations.as_ptr()).source,
(*migrations.as_ptr()).dest,
(*migrations.as_ptr()).time,
(*migrations.as_ptr()).metadata,
(*migrations.as_ptr()).metadata_offset,
)
};
handle_tsk_return_value!(rv)
}
/// Set the population table from an [`OwnedPopulationTable`](`crate::OwnedSiteTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut populations = tskit::OwnedPopulationTable::default();
/// populations.add_row().unwrap();
/// tables.set_populations(&populations).unwrap();
/// assert_eq!(tables.populations().num_rows(), 1);
/// # populations.clear().unwrap();
/// # assert_eq!(populations.num_rows(), 0);
/// ```
pub fn set_populations(&mut self, populations: &crate::OwnedPopulationTable) -> TskReturnValue {
// SAFETY: neither self nor edges are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_population_table_set_columns(
&mut self.inner.populations,
(*populations.as_ptr()).num_rows,
(*populations.as_ptr()).metadata,
(*populations.as_ptr()).metadata_offset,
)
};
handle_tsk_return_value!(rv)
}
#[cfg(feature = "provenance")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "provenance")))]
/// Set the provenance table from an
/// [`OwnedProvenanceTable`](`crate::provenance::OwnedProvenanceTable`)
///
/// # Errors
///
/// Any errors from the C API propagate.
///
/// # Example
///
/// ```rust
/// # #[cfg(feature="provenance")] {
/// #
/// let mut tables = tskit::TableCollection::new(1.0).unwrap();
/// let mut provenances = tskit::provenance::OwnedProvenanceTable::default();
/// provenances.add_row("I like pancakes").unwrap();
/// tables.set_provenances(&provenances).unwrap();
/// assert_eq!(tables.provenances().num_rows(), 1);
/// assert_eq!(tables.provenances().record(0).unwrap(), "I like pancakes");
/// # provenances.clear().unwrap();
/// # assert_eq!(provenances.num_rows(), 0);
/// # }
/// ```
pub fn set_provenances(
&mut self,
provenances: &crate::provenance::OwnedProvenanceTable,
) -> TskReturnValue {
// SAFETY: neither self nor edges are possible
// to create with null pointers.
let rv = unsafe {
ll_bindings::tsk_provenance_table_set_columns(
&mut self.inner.provenances,
(*provenances.as_ptr()).num_rows,
(*provenances.as_ptr()).timestamp,
(*provenances.as_ptr()).timestamp_offset,
(*provenances.as_ptr()).record,
(*provenances.as_ptr()).record_offset,
)
};
handle_tsk_return_value!(rv)
}
}