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
//! An `HpoSet` can represent e.g. the clinical information of a patient or the symptoms of a disease
use std::collections::HashMap;

use crate::annotations::Genes;
use crate::annotations::OmimDiseases;
use crate::similarity::GroupSimilarity;
use crate::similarity::Similarity;
use crate::similarity::SimilarityCombiner;
use crate::term::HpoGroup;
use crate::HpoTermId;

use crate::term::{InformationContent, Iter};
use crate::HpoResult;
use crate::HpoTerm;

use crate::Ontology;

/// A set of unique HPO terms
///
/// It provides several convinience functions to operate on a set of terms.
/// A typical use-case for an [`HpoSet`] is to record the clinical information
/// of a patient. You can compare the aggregated information of the patient
/// with other patients, genes or dieases.
///
/// As in a set, each term can only appear once.
///
/// # Examples
///
/// ```
/// use hpo::term::InformationContentKind;
/// use hpo::{Ontology, HpoSet};
/// use hpo::term::HpoGroup;
/// use hpo::similarity::{Builtins, StandardCombiner};
///
/// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
///
/// // create one set
/// let mut hpos = HpoGroup::new();
/// hpos.insert(707u32);
/// hpos.insert(12639u32);
/// hpos.insert(12638u32);
/// hpos.insert(818u32);
/// hpos.insert(2715u32);
/// let set = HpoSet::new(&ontology, hpos);
/// assert_eq!(set.len(), 5);
///
/// // create another set
/// let mut hpos_2 = HpoGroup::new();
/// hpos_2.insert(100547u32);
/// hpos_2.insert(12638u32);
/// hpos_2.insert(864u32);
/// hpos_2.insert(25454u32);
/// let set_2 = HpoSet::new(&ontology, hpos_2);
/// assert_eq!(set_2.len(), 4);
///
/// let similarity = set.similarity(
///     &set_2,
///     Builtins::GraphIc(InformationContentKind::Omim),
///     StandardCombiner::default()
/// );
///
/// assert_eq!(similarity, 0.8177036);
/// ```
#[must_use]
pub struct HpoSet<'a> {
    ontology: &'a Ontology,
    group: HpoGroup,
}

impl<'a> HpoSet<'a> {
    /// Constructs an [`HpoSet`]
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(707u32);
    /// hpos.insert(12639u32);
    /// hpos.insert(12638u32);
    /// hpos.insert(818u32);
    /// hpos.insert(2715u32);
    /// let set = HpoSet::new(&ontology, hpos);
    /// assert_eq!(set.len(), 5);
    /// ```
    pub fn new(ontology: &'a Ontology, group: HpoGroup) -> Self {
        Self { ontology, group }
    }

    /// Returns a new `HpoSet` that contains only the child-most terms
    ///
    /// This means that it only contains terms that don't have a child
    /// term present in the set.
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(707u32);
    /// hpos.insert(12639u32);
    /// hpos.insert(12638u32);
    /// hpos.insert(818u32);
    /// hpos.insert(2715u32);
    /// let mut set = HpoSet::new(&ontology, hpos);
    /// assert_eq!(set.len(), 5);
    /// let children = set.child_nodes();
    /// assert_eq!(children.len(), 4);
    /// ```
    /// # Panics
    /// TODO
    pub fn child_nodes(&self) -> Self {
        let group = self
            .group
            .iter()
            .filter(|term1_id| {
                self.group.iter().all(|term2_id| {
                    !self
                        .ontology
                        .get(term2_id)
                        .expect("HpoTermId must be in Ontology")
                        .all_parents()
                        .contains(term1_id)
                })
            })
            .collect();
        HpoSet::new(self.ontology, group)
    }

    /// Returns the number of terms in the set
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(707u32);
    /// hpos.insert(12639u32);
    /// hpos.insert(12638u32);
    /// hpos.insert(818u32);
    /// hpos.insert(2715u32);
    /// let set = HpoSet::new(&ontology, hpos);
    /// assert_eq!(set.len(), 5);
    /// ```
    pub fn len(&self) -> usize {
        self.group.len()
    }

    /// Returns true if there are no terms in the set
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let hpos = HpoGroup::new();
    /// let set = HpoSet::new(&ontology, hpos);
    /// assert!(set.is_empty());
    /// ```
    pub fn is_empty(&self) -> bool {
        self.group.is_empty()
    }

    /// Removes all modifier terms in-place
    ///
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// # use hpo::term::HpoGroup;
    /// # fn method_that_returns_an_hposet<'a>(ontology: &'a Ontology) -> HpoSet<'a> {
    /// # let mut hpos = HpoGroup::new();
    /// # hpos.insert(707u32);
    /// # hpos.insert(12639u32);
    /// # hpos.insert(12638u32);
    /// # hpos.insert(3581u32);
    /// # hpos.insert(7u32);
    /// # HpoSet::new(ontology, hpos)
    /// # }
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut set: HpoSet = method_that_returns_an_hposet(&ontology);
    /// assert_eq!(set.len(), 5);
    ///
    /// set.remove_modifier();
    /// assert_eq!(set.len(), 3);
    /// ```
    pub fn remove_modifier(&mut self) {
        let group: HpoGroup = self.iter().filter(|term| !term.is_modifier()).collect();
        self.group = group;
    }

    /// Returns a new set without modifier terms
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// # use hpo::term::HpoGroup;
    /// # fn method_that_returns_an_hposet<'a>(ontology: &'a Ontology) -> HpoSet<'a> {
    /// # let mut hpos = HpoGroup::new();
    /// # hpos.insert(707u32);
    /// # hpos.insert(12639u32);
    /// # hpos.insert(12638u32);
    /// # hpos.insert(3581u32);
    /// # hpos.insert(7u32);
    /// # HpoSet::new(ontology, hpos)
    /// # }
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let set_1: HpoSet = method_that_returns_an_hposet(&ontology);
    /// assert_eq!(set_1.len(), 5);
    ///
    /// let set_2 = set_1.without_modifier();
    /// assert_eq!(set_2.len(), 3);
    ///
    /// for term in set_1.iter() {
    ///     if !set_2.contains(&term.id()) {
    ///         println!("Modifier: {} | {}", term.id(), term.name());
    ///     }
    /// }
    /// // "HP:0000007 | Autosomal recessive inheritance"
    /// // "HP:0003581 | Adult onset"
    /// ```
    pub fn without_modifier(&self) -> Self {
        let group: HpoGroup = self.iter().filter(|term| !term.is_modifier()).collect();
        Self {
            ontology: self.ontology,
            group,
        }
    }

    /// Removes all obsolete terms in-place
    ///
    /// # Panics
    ///
    /// When an `HpoTermId` of the set is not part of the Ontology
    ///
    /// # Examples
    ///
    /// The example Ontology does not contain obsolete terms,
    /// so this example does not show an actual effect.
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    /// # fn method_that_returns_an_hposet<'a>(ontology: &'a Ontology) -> HpoSet<'a> {
    /// # let mut hpos = HpoGroup::new();
    /// # hpos.insert(707u32);
    /// # hpos.insert(12639u32);
    /// # hpos.insert(12638u32);
    /// # hpos.insert(818u32);
    /// # hpos.insert(2715u32);
    /// # HpoSet::new(ontology, hpos)
    /// # }
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut set: HpoSet = method_that_returns_an_hposet(&ontology);
    /// assert_eq!(set.len(), 5);
    ///
    /// set.remove_obsolete();
    /// assert_eq!(set.len(), 5);
    /// ```
    pub fn remove_obsolete(&mut self) {
        let group: HpoGroup = self
            .group
            .iter()
            .filter(|term_id| {
                !self
                    .ontology
                    .get(*term_id)
                    .expect("HpoTermId must be in Ontology")
                    .obsolete()
            })
            .collect();
        self.group = group;
    }

    /// Returns a new set without obsolete terms
    ///
    /// # Panics
    ///
    /// When an `HpoTermId` of the set is not part of the Ontology
    ///
    /// # Examples
    ///
    /// The example Ontology does not contain obsolete terms,
    /// so this example does not show an actual effect.
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    /// # fn method_that_returns_an_hposet<'a>(ontology: &'a Ontology) -> HpoSet<'a> {
    /// # let mut hpos = HpoGroup::new();
    /// # hpos.insert(707u32);
    /// # hpos.insert(12639u32);
    /// # hpos.insert(12638u32);
    /// # hpos.insert(818u32);
    /// # hpos.insert(2715u32);
    /// # HpoSet::new(ontology, hpos)
    /// # }
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let set: HpoSet = method_that_returns_an_hposet(&ontology);
    /// assert_eq!(set.len(), 5);
    ///
    /// let new_set = set.without_obsolete();
    /// assert_eq!(new_set.len(), 5);
    /// ```
    pub fn without_obsolete(&self) -> Self {
        let group: HpoGroup = self
            .group
            .iter()
            .filter(|term_id| {
                !self
                    .ontology
                    .get(*term_id)
                    .expect("HpoTermId must be in Ontology")
                    .obsolete()
            })
            .collect();
        Self {
            ontology: self.ontology,
            group,
        }
    }

    /// Returns a new set where obsolete terms are replaced
    ///
    /// All terms with a `replaced_by` attribute are replaced accordingly.
    ///
    /// See [`HpoTerm::replaced_by`] for more information
    ///
    /// # Panics
    ///
    /// When an `HpoTermId` of the set is not part of the Ontology
    ///
    /// # Examples
    ///
    /// The example Ontology does not contain replacement terms,
    /// so this example does not show an actual effect.
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    /// # fn method_that_returns_an_hposet<'a>(ontology: &'a Ontology) -> HpoSet<'a> {
    /// # let mut hpos = HpoGroup::new();
    /// # hpos.insert(707u32);
    /// # hpos.insert(12639u32);
    /// # hpos.insert(12638u32);
    /// # hpos.insert(818u32);
    /// # hpos.insert(2715u32);
    /// # HpoSet::new(ontology, hpos)
    /// # }
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let set: HpoSet = method_that_returns_an_hposet(&ontology);
    /// assert_eq!(set.len(), 5);
    ///
    /// let new_set = set.with_replaced_obsolete();
    /// assert_eq!(new_set.len(), 5);
    /// ```
    pub fn with_replaced_obsolete(&self) -> Self {
        let group: HpoGroup = self
            .group
            .iter()
            .map(|term_id| {
                self.ontology
                    .get(term_id)
                    .expect("HpoTermId must be in Ontology")
                    .replacement()
                    .unwrap_or(term_id)
            })
            .collect();
        Self {
            ontology: self.ontology,
            group,
        }
    }

    /// Replaces obsolete terms in-place
    ///
    /// All terms with a `replaced_by` attribute are replaced accordingly.
    ///
    /// See [`HpoTerm::replaced_by`] for more information
    ///
    /// # Panics
    ///
    /// When an `HpoTermId` of the set is not part of the Ontology
    ///
    /// # Examples
    ///
    /// The example Ontology does not contain replacement terms,
    /// so this example does not show an actual effect.
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    /// # fn method_that_returns_an_hposet<'a>(ontology: &'a Ontology) -> HpoSet<'a> {
    /// # let mut hpos = HpoGroup::new();
    /// # hpos.insert(707u32);
    /// # hpos.insert(12639u32);
    /// # hpos.insert(12638u32);
    /// # hpos.insert(818u32);
    /// # hpos.insert(2715u32);
    /// # HpoSet::new(ontology, hpos)
    /// # }
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut set: HpoSet = method_that_returns_an_hposet(&ontology);
    /// assert_eq!(set.len(), 5);
    ///
    /// set.replace_obsolete();
    /// assert_eq!(set.len(), 5);
    /// ```
    pub fn replace_obsolete(&mut self) {
        let group: HpoGroup = self
            .group
            .iter()
            .map(|term_id| {
                self.ontology
                    .get(term_id)
                    .expect("HpoTermId must be in Ontology")
                    .replacement()
                    .unwrap_or(term_id)
            })
            .collect();
        self.group = group;
    }

    /// Returns all [`crate::annotations::GeneId`]s that are associated to the set
    ///
    /// # Panics
    ///
    /// When an `HpoTermId` of the set is not part of the Ontology
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(12639u32);
    /// hpos.insert(818u32);
    /// let set = HpoSet::new(&ontology, hpos);
    /// // `ABCD1 (HGNC:215)` is linked to `HP:0012639`
    /// assert!(set.gene_ids().contains(&215u32.into()));
    /// ```
    pub fn gene_ids(&self) -> Genes {
        self.group
            .iter()
            .map(|term_id| {
                self.ontology
                    .get(term_id)
                    .expect("HpoTermId must be in Ontology")
                    .genes()
            })
            .fold(Genes::default(), |acc, element| &acc | element)
    }

    /// Returns all [`crate::annotations::OmimDiseaseId`]s that are associated to the set
    ///
    /// # Panics
    ///
    /// When an `HpoTermId` of the set is not part of the Ontology
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(12639u32);
    /// hpos.insert(818u32);
    /// let set = HpoSet::new(&ontology, hpos);
    /// // `Microphthalmia, syndromic 6 (OMIM:607932)` is linked to `HP:0012639`
    /// assert!(set.omim_disease_ids().contains(&607932u32.into()));
    /// ```
    pub fn omim_disease_ids(&self) -> OmimDiseases {
        self.group
            .iter()
            .map(|term_id| {
                self.ontology
                    .get(term_id)
                    .expect("HpoTermId must be in Ontology")
                    .omim_diseases()
            })
            .fold(OmimDiseases::default(), |acc, element| &acc | element)
    }

    /// Returns the counts of all categories in the set
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet, HpoTermId};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(12285u32);  // Abnormal hypothalamus physiology
    /// hpos.insert(12639u32);  // Abnormal nervous system morphology
    /// hpos.insert(12638u32);  // Abnormal nervous system physiology
    /// hpos.insert(12648u32);  // Decreased inflammatory response
    /// hpos.insert(3581u32);  // Adult onset
    /// hpos.insert(7u32);  // Autosomal recessive inheritance
    ///
    /// let set: HpoSet = HpoSet::new(&ontology, hpos);
    /// let cats = set.categories();
    ///
    /// assert_eq!(cats.get(&HpoTermId::from_u32(5)).unwrap(), &1);
    /// assert_eq!(cats.get(&HpoTermId::from_u32(707)).unwrap(), &3);
    /// assert_eq!(cats.get(&HpoTermId::from_u32(818)).unwrap(), &1);
    /// assert_eq!(cats.get(&HpoTermId::from_u32(2715)).unwrap(), &1);
    /// assert_eq!(cats.get(&HpoTermId::from_u32(12823)).unwrap(), &1);
    /// ```
    pub fn categories(&self) -> HashMap<HpoTermId, usize> {
        let mut res: HashMap<HpoTermId, usize> = HashMap::new();
        for term in self {
            for category in term.categories() {
                res.entry(category)
                    .and_modify(|count| *count += 1)
                    .or_insert(1);
            }
        }
        res
    }

    /// Calculates and returns the aggregated [`InformationContent`] of the set
    ///
    /// The `InformationContent` is not cached internally, so this operation
    /// is not cheap
    ///
    /// # Errors
    ///
    /// - When the ontology or set have more than `u16::MAX` genes or diseases
    ///
    /// # Panics
    ///
    /// - When an `HpoTermId` of the set is not part of the Ontology
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(707u32);
    /// hpos.insert(12639u32);
    /// hpos.insert(12638u32);
    /// hpos.insert(818u32);
    /// hpos.insert(2715u32);
    /// let set = HpoSet::new(&ontology, hpos);
    /// assert_eq!(set.information_content().unwrap().gene(), 0.14216587);
    /// ```
    pub fn information_content(&self) -> HpoResult<InformationContent> {
        let n_diseases = self.ontology.omim_diseases().len();
        let n_genes = self.ontology.genes().len();

        let mut ic = InformationContent::default();
        ic.set_gene(n_genes, self.gene_ids().len())?;
        ic.set_omim_disease(n_diseases, self.omim_disease_ids().len())?;
        Ok(ic)
    }

    /// Returns the [`HpoTerm`] at the given index
    ///
    /// # Panics
    ///
    /// - When an `HpoTermId` of the set is not part of the Ontology
    pub fn get(&self, index: usize) -> Option<HpoTerm<'a>> {
        let term = self.group.get(index)?;
        Some(HpoTerm::try_new(self.ontology, *term).unwrap())
    }

    /// Calculates the similarity to another [`HpoSet`]
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::term::InformationContentKind;
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    /// use hpo::similarity::{Builtins, StandardCombiner};
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// // create one set
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(707u32);
    /// hpos.insert(12639u32);
    /// hpos.insert(12638u32);
    /// hpos.insert(818u32);
    /// hpos.insert(2715u32);
    /// let set = HpoSet::new(&ontology, hpos);
    ///
    /// // create another set
    /// let mut hpos_2 = HpoGroup::new();
    /// hpos_2.insert(100547u32);
    /// hpos_2.insert(12638u32);
    /// hpos_2.insert(864u32);
    /// hpos_2.insert(25454u32);
    /// let set_2 = HpoSet::new(&ontology, hpos_2);
    ///
    /// let similarity = set.similarity(
    ///     &set_2,
    ///     Builtins::GraphIc(InformationContentKind::Omim),
    ///     StandardCombiner::default()
    /// );
    ///
    /// assert_eq!(similarity, 0.8177036);
    /// ```
    pub fn similarity<S: Similarity, C: SimilarityCombiner>(
        &self,
        other: &HpoSet,
        similarity: S,
        combiner: C,
    ) -> f32 {
        let group_sim = GroupSimilarity::new(combiner, similarity);
        group_sim.calculate(self, other)
    }

    /// Returns an Iterator of [`HpoTerm`]
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::term::InformationContentKind;
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    /// use hpo::similarity::{Builtins, StandardCombiner};
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// // create one set
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(707u32);
    /// hpos.insert(12639u32);
    ///
    /// let set = HpoSet::new(&ontology, hpos);
    ///
    /// let mut iter = set.iter();
    /// assert!(iter.next().is_some());
    /// assert!(iter.next().is_some());
    /// assert!(iter.next().is_none());
    /// ```
    pub fn iter(&self) -> Iter<'_> {
        self.into_iter()
    }

    /// Returns true if the set contains a term with the [`HpoTermId`]
    ///
    /// # Examples
    ///
    /// ```
    /// use hpo::term::InformationContentKind;
    /// use hpo::{Ontology, HpoSet};
    /// use hpo::term::HpoGroup;
    /// use hpo::similarity::{Builtins, StandardCombiner};
    ///
    /// let ontology = Ontology::from_binary("tests/example.hpo").unwrap();
    ///
    /// // create one set
    /// let mut hpos = HpoGroup::new();
    /// hpos.insert(707u32);
    /// hpos.insert(12639u32);
    ///
    /// let set = HpoSet::new(&ontology, hpos);
    ///
    /// assert!(set.contains(&707u32.into()));
    /// assert!(!set.contains(&66666u32.into()));
    /// ```
    pub fn contains(&self, id: &HpoTermId) -> bool {
        self.group.contains(id)
    }
}

impl<'a> IntoIterator for &'a HpoSet<'a> {
    type Item = HpoTerm<'a>;
    type IntoIter = Iter<'a>;
    fn into_iter(self) -> Self::IntoIter {
        Iter::new(self.group.iter(), self.ontology)
    }
}

impl<'b, 'a> Extend<HpoTerm<'b>> for HpoSet<'a> {
    fn extend<T: IntoIterator<Item = HpoTerm<'b>>>(&mut self, iter: T) {
        for term in iter {
            self.group.insert(term.id());
        }
    }
}

#[cfg(test)]
mod test {
    use crate::similarity::{Builtins, StandardCombiner};
    use crate::term::internal::HpoTermInternal;
    use crate::term::HpoGroup;
    use crate::term::InformationContentKind;
    use crate::{HpoSet, Ontology};

    #[test]
    fn test() {
        let ontology = Ontology::from_binary("tests/example.hpo").unwrap();

        // create one set
        let mut hpos = HpoGroup::new();
        hpos.insert(707u32);
        hpos.insert(12639u32);
        hpos.insert(12638u32);
        hpos.insert(818u32);
        hpos.insert(2715u32);
        let set = HpoSet::new(&ontology, hpos);
        assert_eq!(set.len(), 5);

        // create another set
        let mut hpos_2 = HpoGroup::new();
        hpos_2.insert(100_547u32);
        hpos_2.insert(12638u32);
        hpos_2.insert(864u32);
        hpos_2.insert(25454u32);
        let set_2 = HpoSet::new(&ontology, hpos_2);
        assert_eq!(set_2.len(), 4);

        let similarity = set.similarity(
            &set_2,
            Builtins::GraphIc(InformationContentKind::Omim),
            StandardCombiner::default(),
        );

        assert!((similarity - 0.817_703_6).abs() < f32::EPSILON);
    }

    #[test]
    fn test_obsolete() {
        let mut ontology = Ontology::from_binary("tests/example.hpo").unwrap();

        let mut obsolete_term = HpoTermInternal::new("Obsolete: Foo".to_string(), 666u32.into());
        *obsolete_term.obsolete_mut() = true;

        ontology.add_term(obsolete_term);

        let mut hpos = HpoGroup::new();
        hpos.insert(707u32);
        hpos.insert(12639u32);
        hpos.insert(12638u32);
        hpos.insert(666u32);
        hpos.insert(2715u32);
        let mut set = HpoSet::new(&ontology, hpos);
        assert_eq!(set.len(), 5);

        let set2 = set.without_obsolete();
        assert_eq!(set.len(), 5);
        assert_eq!(set2.len(), 4);

        set.remove_obsolete();
        assert_eq!(set.len(), 4);
    }

    #[test]
    fn test_with_replaced_obsolete() {
        let mut ontology = Ontology::from_binary("tests/example.hpo").unwrap();

        let mut obsolete_term = HpoTermInternal::new("Obsolete: Foo".to_string(), 666u32.into());
        *obsolete_term.replacement_mut() = Some(25454u32.into());
        ontology.add_term(obsolete_term.clone());

        let mut hpos = HpoGroup::new();
        hpos.insert(707u32);
        hpos.insert(12639u32);
        hpos.insert(12638u32);
        hpos.insert(666u32);
        hpos.insert(2715u32);
        let set = HpoSet::new(&ontology, hpos);
        assert_eq!(set.len(), 5);

        let set2 = set.with_replaced_obsolete();
        assert_eq!(set.len(), 5);
        assert_eq!(set2.len(), 5);

        assert!(set.contains(&666u32.into()));
        assert!(!set2.contains(&666u32.into()));

        assert!(!set.contains(&25454u32.into()));
        assert!(set2.contains(&25454u32.into()));
    }

    #[test]
    fn test_replace_obsolete() {
        let mut ontology = Ontology::from_binary("tests/example.hpo").unwrap();

        let mut obsolete_term = HpoTermInternal::new("Obsolete: Foo".to_string(), 666u32.into());
        *obsolete_term.replacement_mut() = Some(25454u32.into());
        ontology.add_term(obsolete_term.clone());

        let mut hpos = HpoGroup::new();
        hpos.insert(707u32);
        hpos.insert(12639u32);
        hpos.insert(12638u32);
        hpos.insert(666u32);
        hpos.insert(2715u32);
        let mut set = HpoSet::new(&ontology, hpos);
        assert_eq!(set.len(), 5);

        set.replace_obsolete();
        assert_eq!(set.len(), 5);
        assert!(!set.contains(&666u32.into()));
        assert!(set.contains(&25454u32.into()));
    }
}