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
|
/*
* Copyright (C) 2014-2021 Brian L. Browning
*
* This file is part of Beagle
*
* Beagle is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Beagle is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package vcf;
/**
* <p>Interface {@code GT} represents genotype data
* for a list of markers and a list of samples.
* </p>
* <p>All instances of {@code GT} are required to be immutable.
* </p>
*
* @author Brian L. Browning {@code <browning@uw.edu>}
*/
public interface GT {
/**
* Returns {@code true} if the markers are ordered by decreasing chromosome
* base position, and returns {@code false} otherwise.
* @return {@code true} if the markers are ordered by decreasing chromosome
* base position
*/
boolean isReversed();
/**
* Returns the number of markers.
* @return the number of markers
*/
int nMarkers();
/**
* Returns the specified marker.
* @param marker a marker index
* @return the specified marker
* @throws IndexOutOfBoundsException if
* {@code marker < 0 || marker >= this.nMarkers()}
*/
Marker marker(int marker);
/**
* Returns the list of markers in order of increasing chromosome position.
* If {@code (this.isReversed() == false)} then
* {@code (this.markers().marker(j).equals(this.marker(j)) == true)} for
* all {@code (0 <= j && j < this.nMarkers())}.
* If {@code (this.isReversed() == true)} then
* {@code (this.markers().marker(this.nMarkers() - 1 - j).equals(this.marker(j)) == true)}
* for all {@code (0 <= j && j < this.nMarkers())}
* @return the list of markers in order of increasing chromosome position
*/
Markers markers();
/**
* Returns the number of haplotypes. The returned value is equal to
* {@code 2*this.nSamples()}.
* @return the number of haplotypes
*/
int nHaps();
/**
* Returns the number of samples.
* @return the number of samples
*/
int nSamples();
/**
* Returns the list of samples.
* @return the list of samples
*/
Samples samples();
/**
* Returns {@code true} if the genotype for each marker and sample
* has non-missing alleles and is either haploid or diploid with
* a phased allele separator, and returns {@code false} otherwise.
* @return {@code true} if the genotype for each marker and sample
* is a phased, non-missing genotype
*/
boolean isPhased();
/**
* Returns the allele on the specified haplotype for the specified marker
* or return -1 if the allele is missing. The order of the two alleles
* is unspecified if {@code this.isPhased() == false}.
* @param marker the marker index
* @param hap the haplotype index
* @return the allele on the specified haplotype for the specified marker
*
* @throws IndexOutOfBoundsException if
* {@code marker < 0 || marker >= this.nMarkers()}
* @throws IndexOutOfBoundsException if
* {@code hap < 0 || hap >= this.nHaps()}
*/
int allele(int marker, int hap);
/**
* Returns a {@code GT} instance restricted to genotype data for
* the specified markers.
* @param markers the list of markers in the returned instance
* @param indices a list of distinct marker indices (from
* {@code this.markers())} in increasing order
* @return a {@code GT} instance restricted to genotype data for
* the specified markers
*
* @throws IndexOutOfBoundsException if there exists {@code j} such that
* {@code (0 <= j && j < indices.length)} such that
* {@code (indices[j] < 0 || indices[j] >= this.nMarkers())}
* @throws IllegalArgumentException if there exists {@code j} such that
* {@code (1 <= j && j < indices.length)} such that
* {@code (indices[j] <= indice[j - 1])}
* @throws IllegalArgumentException if there exists {@code j} such that
* {@code (0 <= j && j < indices.length)} such that
* {@code (this.marker(indices[j]).equals(markers.marker(j)) == false)}
* @throws NullPointerException if {@code indices == null}
* @throws UnsupportedOperationException if {@code this.isReversed() == true}
*/
GT restrict(Markers markers, int[] indices);
/**
* Returns a new {@code GT} instance restricted to genotype data for
* the specified markers.
* @param start the start marker (inclusive)
* @param end the end marker (exclusive)
* @return a {@code GT} instance restricted to genotype data for
* the specified markers
* @throws IllegalArgumentException if {@code start >= end}
* @throws IndexOutOfBoundsException if
* {@code start < 0 || end > this.markers()}
*/
GT restrict(int start, int end);
}
|
