.\" -*- 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 "TFBS::SiteSet 3pm"
.TH TFBS::SiteSet 3pm 2024-03-13 "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
TFBS::SiteSet \- a set of TFBS::Site objects
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my $site_set = TFBS::SiteSet\->new(@list_of_site_objects);
\&
\&    # add a TFBS::Site object to set:
\&    
\&    $site_set\->add_site($site_obj);
\&
\&    # append another TFBS::SiteSet contents: 
\&
\&    $site_pair_set\->add_site_set($site_obj);
\&
\&    # create an iterator:
\&
\&    my $it = $site_set\->Iterator(\-sort_by => \*(Aqstart\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
TFBS::SiteSet is an aggregate class that contains a collection
of TFBS::Site objects. It can be created anew and filled with 
TFBS::Site object. It is also returned by \fBsearch_seq()\fR method call 
of some TFBS::PatternI subclasses (e.g. TFBS::Matrix::PWM).
.SH FEEDBACK
.IX Header "FEEDBACK"
Please send bug reports and other comments to the author.
.SH "AUTHOR \- Boris Lenhard"
.IX Header "AUTHOR - Boris Lenhard"
Boris Lenhard <Boris.Lenhard@cgb.ki.se>
.SH APPENDIX
.IX Header "APPENDIX"
The rest of the documentation details each of the object
methods. Internal methods are preceded with an underscore.
.SS add_site
.IX Subsection "add_site"
.Vb 6
\& Title   : add_site
\& Usage   : $siteset\->add_site($site_object)
\&           $siteset\->add_site(@list_of_site_objects)
\& Function: adds TFBS::Site objects to an existing TFBS::SiteSet object
\& Returns : $sitepair object (usually ignored)
\& Args    : A list of TFBS::Site objects to add
.Ve
.SS add_site_set
.IX Subsection "add_site_set"
.Vb 8
\& Title   : add_site_set
\& Usage   : $siteset\->add_site_set($site_set_object)
\&           $siteset\->add_site(@list_of_site_set_objects)
\& Function: adds the contents of other TFBS::SiteSet objects 
\&           to an existing TFBS::SiteSet object
\& Returns : $siteset object (usually ignored)
\& Args    : A list of TFBS::SiteSet objects whose contents should be 
\&           added to $siteset
.Ve
.SS size
.IX Subsection "size"
.Vb 5
\& Title   : size
\& Usage   : my $size = $siteset\->size()
\& Function: returns a number of TFBS::Site objects contained in the set
\& Returns : a scalar (integer) 
\& Args    : none
.Ve
.SS Iterator
.IX Subsection "Iterator"
.Vb 10
\& Title   : Iterator
\& Usage   : my $siteset_iterator = 
\&                   $siteset\->Iterator(\-sort_by =>\*(Aqstart\*(Aq);
\&           while (my $site = $siteset_iterator\->next) {
\&               # do whatever you want with individual matrix objects
\&           }
\& Function: Returns an iterator object that can be used to go through
\&           all members of the set (TFBS::Site objects)
\& Returns : an iterator object (currently undocumentened in TFBS \-
\&                               but understands the \*(Aqnext\*(Aq method)
\& Args    : \-sort_by # optional \- currently it accepts 
\&                    #   (default sort order in parenthetse)
\&                    #    \*(Aqname\*(Aq (pattern name, alphabetically)
\&                    #    \*(AqID\*(Aq (pattern/matrix ID, alphabetically)
\&                    #    \*(Aqstart\*(Aq (site start in sequence, 
\&                    #             numerically,increasing order)
\&                    #    \*(Aqend\*(Aq (site end in sequence, 
\&                    #           numerically, increasing order)
\&                    #    \*(Aqscore\*(Aq (numerically, decreasing order)
\&                    
\&           \-reverse # optional \- reverses the default sorting order if true
.Ve
.SS GFF
.IX Subsection "GFF"
.Vb 6
\& Title   : GFF
\& Usage   : print $siteset\->GFF();
\&         : print $siteset\->GFF($gff_formatter)
\& Function: returns a "standard" multiline GFF string 
\& Returns : a string (multiline, newline terminated)
\& Args    : a $gff_formatter function reference (optional)
.Ve