Cigar

Represents a CIGAR string https://samtools.github.io/hts-specs/SAMv1.pdf §1.4.6

struct Cigar {

CigarOp[] ops;

this(uint* cigar, int length);

this(CigarOp[] ops);

bool is_null();

string toString();

int ref_bases_covered [@property getter];

alias alignedLength = ref_bases_covered;

}

Constructors

this this(uint* cigar, int length): Construct Cigar from raw data
this this(CigarOp[] ops): Construct Cigar from an array of CIGAR ops

Members

Aliases

alignedLength alias alignedLength = ref_bases_covered: previous alignedLength function had a bug and it is just a duplicate of ref_bases_covered

Functions

is_null bool is_null(): Undocumented in source. Be warned that the author may not have intended to support it.
toString string toString(): Format Cigar struct as CIGAR string in accordance with SAM spec

Properties

ref_bases_covered int ref_bases_covered [@property getter]: return the alignment length expressed by this Cigar TODO: use CIGAR_TYPE to get rid of switch statement for less branching

Variables

ops CigarOp[] ops;: array of distinct CIGAR ops

Meta

Source

See Implementation

dhtslib cigar enums

Ops

functions

structs

unions

CigarOp

variables

CIGAR_STR