Skip to content

Commit 63f9251

Browse files
molpopgenmolpopgen
authored
style: Rename all OwnedX tables to OwningX. (#408)
BREAKING CHANGE: changed name of public type.
1 parent ed66893 commit 63f9251

10 files changed

+86
-80
lines changed

‎src/edge_table.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -345,9 +345,9 @@ build_owned_table_type!(
345345
/// # Examples
346346
///
347347
/// ```
348-
/// use tskit::OwnedEdgeTable;
348+
/// use tskit::OwningEdgeTable;
349349
///
350-
/// let mut edges = OwnedEdgeTable::default();
350+
/// let mut edges = OwningEdgeTable::default();
351351
/// let rowid = edges.add_row(1., 2., 0, 1).unwrap();
352352
/// assert_eq!(rowid, 0);
353353
/// assert_eq!(edges.num_rows(), 1);
@@ -361,7 +361,7 @@ build_owned_table_type!(
361361
///
362362
/// ```
363363
/// # #[cfg(any(feature="doc", feature="derive"))] {
364-
/// use tskit::OwnedEdgeTable;
364+
/// use tskit::OwningEdgeTable;
365365
///
366366
/// #[derive(serde::Serialize,
367367
/// serde::Deserialize,
@@ -373,7 +373,7 @@ build_owned_table_type!(
373373
///
374374
/// let metadata = EdgeMetadata{value: 42};
375375
///
376-
/// let mut edges = OwnedEdgeTable::default();
376+
/// let mut edges = OwningEdgeTable::default();
377377
///
378378
/// let rowid = edges.add_row_with_metadata(0., 1., 5, 10, &metadata).unwrap();
379379
/// assert_eq!(rowid, 0);
@@ -387,15 +387,15 @@ build_owned_table_type!(
387387
/// }
388388
/// # }
389389
/// ```
390-
=> OwnedEdgeTable,
390+
=> OwningEdgeTable,
391391
EdgeTable,
392392
tsk_edge_table_t,
393393
tsk_edge_table_init,
394394
tsk_edge_table_free,
395395
crate::bindings::tsk_edge_table_clear
396396
);
397397

398-
impl OwnedEdgeTable {
398+
impl OwningEdgeTable {
399399
edge_table_add_row!(=> add_row, self, *self.table);
400400
edge_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
401401
}

‎src/individual_table.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -459,9 +459,9 @@ build_owned_table_type!(
459459
/// # Examples
460460
///
461461
/// ```
462-
/// use tskit::OwnedIndividualTable;
462+
/// use tskit::OwningIndividualTable;
463463
///
464-
/// let mut individuals = OwnedIndividualTable::default();
464+
/// let mut individuals = OwningIndividualTable::default();
465465
/// let rowid = individuals.add_row(0, None, None).unwrap();
466466
/// assert_eq!(rowid, 0);
467467
/// assert_eq!(individuals.num_rows(), 1);
@@ -473,7 +473,7 @@ build_owned_table_type!(
473473
///
474474
/// ```
475475
/// # #[cfg(any(feature="doc", feature="derive"))] {
476-
/// use tskit::OwnedIndividualTable;
476+
/// use tskit::OwningIndividualTable;
477477
///
478478
/// #[derive(serde::Serialize,
479479
/// serde::Deserialize,
@@ -485,7 +485,7 @@ build_owned_table_type!(
485485
///
486486
/// let metadata = IndividualMetadata{value: 42};
487487
///
488-
/// let mut individuals = OwnedIndividualTable::default();
488+
/// let mut individuals = OwningIndividualTable::default();
489489
///
490490
/// let rowid = individuals.add_row_with_metadata(0, None, None, &metadata).unwrap();
491491
/// assert_eq!(rowid, 0);
@@ -500,15 +500,15 @@ build_owned_table_type!(
500500
///
501501
/// # }
502502
/// ```
503-
=> OwnedIndividualTable,
503+
=> OwningIndividualTable,
504504
IndividualTable,
505505
tsk_individual_table_t,
506506
tsk_individual_table_init,
507507
tsk_individual_table_free,
508508
crate::bindings::tsk_individual_table_clear
509509
);
510510

511-
impl OwnedIndividualTable {
511+
impl OwningIndividualTable {
512512
individual_table_add_row!(=> add_row, self, *self.table);
513513
individual_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
514514
}

‎src/lib.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -427,15 +427,15 @@ impl_time_position_arithmetic!(Position, Time);
427427
/// "Null" identifier value.
428428
pub(crate) const TSK_NULL: tsk_id_t = -1;
429429

430-
pub use edge_table::{EdgeTable, EdgeTableRow, OwnedEdgeTable};
430+
pub use edge_table::{EdgeTable, EdgeTableRow, OwningEdgeTable};
431431
pub use error::TskitError;
432432
pub use flags::*;
433-
pub use individual_table::{IndividualTable, IndividualTableRow, OwnedIndividualTable};
434-
pub use migration_table::{MigrationTable, MigrationTableRow, OwnedMigrationTable};
435-
pub use mutation_table::{MutationTable, MutationTableRow, OwnedMutationTable};
436-
pub use node_table::{NodeTable, NodeTableRow, OwnedNodeTable};
437-
pub use population_table::{OwnedPopulationTable, PopulationTable, PopulationTableRow};
438-
pub use site_table::{OwnedSiteTable, SiteTable, SiteTableRow};
433+
pub use individual_table::{IndividualTable, IndividualTableRow, OwningIndividualTable};
434+
pub use migration_table::{MigrationTable, MigrationTableRow, OwningMigrationTable};
435+
pub use mutation_table::{MutationTable, MutationTableRow, OwningMutationTable};
436+
pub use node_table::{NodeTable, NodeTableRow, OwningNodeTable};
437+
pub use population_table::{OwningPopulationTable, PopulationTable, PopulationTableRow};
438+
pub use site_table::{OwningSiteTable, SiteTable, SiteTableRow};
439439
pub use table_collection::TableCollection;
440440
pub use traits::IndividualLocation;
441441
pub use traits::IndividualParents;

‎src/migration_table.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -410,9 +410,9 @@ build_owned_table_type!(
410410
/// # Examples
411411
///
412412
/// ```
413-
/// use tskit::OwnedMigrationTable;
413+
/// use tskit::OwningMigrationTable;
414414
///
415-
/// let mut migrations = OwnedMigrationTable::default();
415+
/// let mut migrations = OwningMigrationTable::default();
416416
/// let rowid = migrations.add_row((0., 1.), 1, (0, 1), 10.3).unwrap();
417417
/// assert_eq!(rowid, 0);
418418
/// assert_eq!(migrations.num_rows(), 1);
@@ -423,7 +423,7 @@ build_owned_table_type!(
423423
///
424424
/// ```
425425
/// # #[cfg(any(feature="doc", feature="derive"))] {
426-
/// use tskit::OwnedMigrationTable;
426+
/// use tskit::OwningMigrationTable;
427427
///
428428
/// #[derive(serde::Serialize,
429429
/// serde::Deserialize,
@@ -435,7 +435,7 @@ build_owned_table_type!(
435435
///
436436
/// let metadata = MigrationMetadata{value: 42};
437437
///
438-
/// let mut migrations = OwnedMigrationTable::default();
438+
/// let mut migrations = OwningMigrationTable::default();
439439
///
440440
/// let rowid = migrations.add_row_with_metadata((0., 1.), 1, (0, 1), 10.3, &metadata).unwrap();
441441
/// assert_eq!(rowid, 0);
@@ -450,15 +450,15 @@ build_owned_table_type!(
450450
///
451451
/// # }
452452
/// ```
453-
=> OwnedMigrationTable,
453+
=> OwningMigrationTable,
454454
MigrationTable,
455455
tsk_migration_table_t,
456456
tsk_migration_table_init,
457457
tsk_migration_table_free,
458458
ll_bindings::tsk_migration_table_clear
459459
);
460460

461-
impl OwnedMigrationTable {
461+
impl OwningMigrationTable {
462462
migration_table_add_row!(=> add_row, self, *self.table);
463463
migration_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
464464
}

‎src/mutation_table.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -377,9 +377,9 @@ build_owned_table_type!(
377377
/// # Examples
378378
///
379379
/// ```
380-
/// use tskit::OwnedMutationTable;
380+
/// use tskit::OwningMutationTable;
381381
///
382-
/// let mut mutations = OwnedMutationTable::default();
382+
/// let mut mutations = OwningMutationTable::default();
383383
/// let rowid = mutations.add_row(1, 2, 0, 1.0, None).unwrap();
384384
/// assert_eq!(rowid, 0);
385385
/// assert_eq!(mutations.num_rows(), 1);
@@ -390,7 +390,7 @@ build_owned_table_type!(
390390
///
391391
/// ```
392392
/// # #[cfg(any(feature="doc", feature="derive"))] {
393-
/// use tskit::OwnedMutationTable;
393+
/// use tskit::OwningMutationTable;
394394
///
395395
/// #[derive(serde::Serialize,
396396
/// serde::Deserialize,
@@ -402,7 +402,7 @@ build_owned_table_type!(
402402
///
403403
/// let metadata = MutationMetadata{value: 42};
404404
///
405-
/// let mut mutations = OwnedMutationTable::default();
405+
/// let mut mutations = OwningMutationTable::default();
406406
///
407407
/// let rowid = mutations.add_row_with_metadata(0, 1, 5, 10.0, None, &metadata).unwrap();
408408
/// assert_eq!(rowid, 0);
@@ -416,15 +416,15 @@ build_owned_table_type!(
416416
/// }
417417
/// # }
418418
/// ```
419-
=> OwnedMutationTable,
419+
=> OwningMutationTable,
420420
MutationTable,
421421
tsk_mutation_table_t,
422422
tsk_mutation_table_init,
423423
tsk_mutation_table_free,
424424
ll_bindings::tsk_mutation_table_clear
425425
);
426426

427-
impl OwnedMutationTable {
427+
impl OwningMutationTable {
428428
mutation_table_add_row!(=> add_row, self, *self.table);
429429
mutation_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
430430
}

‎src/node_table.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -514,13 +514,13 @@ impl NodeTable {
514514
/// # assert!(flags.iter().all(|f| f.is_sample()));
515515
/// ```
516516
///
517-
/// ## Standalone tables
517+
/// ## Owning tables
518518
///
519519
/// The ownership semantics differ when tables are not part of a
520520
/// table collection:
521521
///
522522
/// ```
523-
/// let mut nodes = tskit::OwnedNodeTable::default();
523+
/// let mut nodes = tskit::OwningNodeTable::default();
524524
/// assert!(nodes.add_row(tskit::NodeFlags::IS_SAMPLE, 10., -1, -1).is_ok());
525525
/// # assert_eq!(nodes.num_rows(), 1);
526526
/// let flags = nodes.flags_slice_mut();
@@ -565,9 +565,9 @@ build_owned_table_type!(
565565
/// # Examples
566566
///
567567
/// ```
568-
/// use tskit::OwnedNodeTable;
568+
/// use tskit::OwningNodeTable;
569569
///
570-
/// let mut nodes = OwnedNodeTable::default();
570+
/// let mut nodes = OwningNodeTable::default();
571571
/// let rowid = nodes.add_row(0, 1.1, -1, -1).unwrap();
572572
/// assert_eq!(rowid, 0);
573573
/// assert_eq!(nodes.num_rows(), 1);
@@ -578,7 +578,7 @@ build_owned_table_type!(
578578
///
579579
/// ```
580580
/// # #[cfg(any(feature="doc", feature="derive"))] {
581-
/// use tskit::OwnedNodeTable;
581+
/// use tskit::OwningNodeTable;
582582
///
583583
/// #[derive(serde::Serialize,
584584
/// serde::Deserialize,
@@ -590,7 +590,7 @@ build_owned_table_type!(
590590
///
591591
/// let metadata = NodeMetadata{value: 42};
592592
///
593-
/// let mut nodes = OwnedNodeTable::default();
593+
/// let mut nodes = OwningNodeTable::default();
594594
///
595595
/// let rowid = nodes.add_row_with_metadata(0, 1., -1, -1, &metadata).unwrap();
596596
/// assert_eq!(rowid, 0);
@@ -605,15 +605,15 @@ build_owned_table_type!(
605605
///
606606
/// # }
607607
/// ```
608-
=> OwnedNodeTable,
608+
=> OwningNodeTable,
609609
NodeTable,
610610
tsk_node_table_t,
611611
tsk_node_table_init,
612612
tsk_node_table_free,
613613
ll_bindings::tsk_node_table_clear
614614
);
615615

616-
impl OwnedNodeTable {
616+
impl OwningNodeTable {
617617
node_table_add_row!(=> add_row, self, (*self.table));
618618
node_table_add_row_with_metadata!(=> add_row_with_metadata, self, (*self.table));
619619
}
@@ -624,7 +624,7 @@ mod test_owned_node_table {
624624

625625
#[test]
626626
fn test_add_row() {
627-
let mut nodes = OwnedNodeTable::default();
627+
let mut nodes = OwningNodeTable::default();
628628
let rowid = nodes.add_row(0, 1.1, -1, -1).unwrap();
629629
assert_eq!(rowid, 0);
630630
assert_eq!(nodes.num_rows(), 1);

‎src/population_table.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,9 @@ build_owned_table_type!(
223223
/// # Examples
224224
///
225225
/// ```
226-
/// use tskit::OwnedPopulationTable;
226+
/// use tskit::OwningPopulationTable;
227227
///
228-
/// let mut populations = OwnedPopulationTable::default();
228+
/// let mut populations = OwningPopulationTable::default();
229229
/// let rowid = populations.add_row().unwrap();
230230
/// assert_eq!(rowid, 0);
231231
/// assert_eq!(populations.num_rows(), 1);
@@ -236,7 +236,7 @@ build_owned_table_type!(
236236
///
237237
/// ```
238238
/// # #[cfg(any(feature="doc", feature="derive"))] {
239-
/// use tskit::OwnedPopulationTable;
239+
/// use tskit::OwningPopulationTable;
240240
///
241241
/// #[derive(serde::Serialize,
242242
/// serde::Deserialize,
@@ -248,7 +248,7 @@ build_owned_table_type!(
248248
///
249249
/// let metadata = PopulationMetadata{name: "YRB".to_string()};
250250
///
251-
/// let mut populations = OwnedPopulationTable::default();
251+
/// let mut populations = OwningPopulationTable::default();
252252
///
253253
/// let rowid = populations.add_row_with_metadata(&metadata).unwrap();
254254
/// assert_eq!(rowid, 0);
@@ -262,15 +262,15 @@ build_owned_table_type!(
262262
/// }
263263
/// # }
264264
/// ```
265-
=> OwnedPopulationTable,
265+
=> OwningPopulationTable,
266266
PopulationTable,
267267
tsk_population_table_t,
268268
tsk_population_table_init,
269269
tsk_population_table_free,
270270
ll_bindings::tsk_population_table_clear
271271
);
272272

273-
impl OwnedPopulationTable {
273+
impl OwningPopulationTable {
274274
population_table_add_row!(=> add_row, self, *self.table);
275275
population_table_add_row_with_metadata!(=> add_row_with_metadata, self, *self.table);
276276
}

‎src/provenance.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -287,22 +287,22 @@ build_owned_table_type!(
287287
/// # #[cfg(feature = "provenance")]
288288
/// # #[cfg_attr(doc_cfg, doc(cfg(feature = "provenance")))]
289289
/// {
290-
/// use tskit::provenance::OwnedProvenanceTable;
291-
/// let mut provenances = OwnedProvenanceTable::default();
290+
/// use tskit::provenance::OwningProvenanceTable;
291+
/// let mut provenances = OwningProvenanceTable::default();
292292
/// let id = provenances.add_row("message").unwrap();
293293
/// assert_eq!(id, 0);
294294
/// assert_eq!(provenances.num_rows(), 1);
295295
/// # }
296296
/// ```
297-
=> OwnedProvenanceTable,
297+
=> OwningProvenanceTable,
298298
ProvenanceTable,
299299
tsk_provenance_table_t,
300300
tsk_provenance_table_init,
301301
tsk_provenance_table_free,
302302
ll_bindings::tsk_provenance_table_clear
303303
);
304304

305-
impl OwnedProvenanceTable {
305+
impl OwningProvenanceTable {
306306
provenance_table_add_row!(=> add_row, self, *self.table);
307307
}
308308

0 commit comments

Comments
 (0)