.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Bio::DB::Sam::Constants 3pm"
.TH Bio::DB::Sam::Constants 3pm 2024-03-12 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Bio::DB::Sam::Constants \-\- Constants for use with SAM/BAM
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use Bio::DB::Sam::Constants;
\& my $pad_flag = BAM_CPAD;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module exports several constants for use with the SAM/BAM
module. See the SAM documentation for their interpretation.
.IP "Cigar operations" 4
.IX Item "Cigar operations"
.Vb 9
\&  BAM_CIGAR_SHIFT
\&  BAM_CIGAR_MASK
\&  BAM_CMATCH
\&  BAM_CINS
\&  BAM_CDEL
\&  BAM_CREF_SKIP
\&  BAM_CSOFT_CLIP
\&  BAM_CHARD_CLIP
\&  BAM_CPAD
.Ve
.IP FLAGS 4
.IX Item "FLAGS"
A hashref that maps flag values to human-readable names. For example:
.Sp
.Vb 1
\& FLAGS\->{0x0008} == \*(AqM_UNMAPPED\*(Aq
.Ve
.IP RFLAGS 4
.IX Item "RFLAGS"
The reverse of FLAGS:
.Sp
.Vb 1
\& FLAGS\->{M_UNMAPPED} == 0x0008
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Bio::Perl, Bio::DB::Sam, Bio::DB::Bam::Alignment
.SH AUTHOR
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@oicr.on.ca>.
<lincoln.stein@bmail.com>
.PP
Copyright (c) 2009\-2015 Ontario Institute for Cancer Research.
.PP
This package and its accompanying libraries are free software; you can
redistribute it and/or modify it under the terms of the Artistic
License 2.0, the Apache 2.0 License, or the GNU General Public License
(version 1 or higher).  Refer to LICENSE for the full license text.