Design Philosophy

[cauliyang]

Quick ideas about all I will do

Revise VcfReader

• ‼️ Use unique ptr to manage memory
• ‼️ Add operator*, operator++ , operator !=, and return VcfRecord
• ‼️ Change VcfRecord as iterator VS Change VcfRecord as a Generator
• ‼️ Use sentinel as end_iterator
• ‼️ Change VcfReader's iterator tag to input_itrator
• Support standard algorithm library
• ⭐ Adopt C++20 standards to use concepts and support ranges operations
• Add Error message when one vcf_reader has been consumed and call being() again
• ‼️ Support ranges
• Design related Views eg. Info_views , base_view (chr, pos, ..)
• consider replacing function object with lambda in smart ptr deleter in order to reduce size of ptr
• Consider to do not using impl and define iterator in class
• Use std::default_sentinel as end_iterator

Implement VcfWriter

Build Interval Tree

• Build an Interval Tree based on RB Tree
• Adopt async to find overlaps concurrently
• Using Google Benchmark to benchmark interval tree, brute force, the method by index
• 🤔 Add iterator and support ranges
• remove getter and setter for children
• add initilizelist to build tree
• design concept for node and tree type

General Design

• build benchmark suit
• add usage example
• change library namespace name to binary
• use constexpr constructor
• fix compatible problems in macOS
• Support Clang in CI
• Support Codecov in pull request
• Support docker in CI
• First use then fall to fmt instead of std::cout
• Overload related objects to format lib

Other to do

• write a blog to summarize how to use smart ptrs
• clang use libc++ cannot compile