IGenotypes

所有超级接口:

java.lang.Iterable<Genotype>

所有已知实现类:

BEDGenotypes, CacheGenotypes, Genotypes
```
public interface IGenotypes
extends java.lang.Iterable<Genotype>
```
基因型序列接口

另请参阅:

基因型对象, 基因型对应的等位基因含义由 Variant 类定义

方法概要

所有方法静态方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`IGenotypes`	`asModifiable()` 转为可变的基因型序列类型
`IGenotypes`	`asUnmodifiable()` 转为不可变的基因型序列类型
`default void`	`clear()` 重设基因型序列
`edu.sysu.pmglab.container.ByteCode`	`encode()` 基因型编码方法
`default void`	`format(edu.sysu.pmglab.container.VolumeByteStream cache, byte separator)` 格式化基因型
`default void`	`format(edu.sysu.pmglab.container.VolumeByteStream cache, edu.sysu.pmglab.container.ByteCode separator)` 格式化基因型
`default int`	`getAC()` 获取等位基因计数 (allele count) 非 .
`default int`	`getAC(int index)` 获取指定等位基因索引的等位基因计数
`default float`	`getAF()` 获取等位基因频率 (allele frequency) 非 .
`default float`	`getAF(int index)` 获取指定等位基因索引的等位基因频率
`default int`	`getAN()` 获取等位基因总数 (allele number) 非 .
`Genotype`	`getGenotype(int genotypeIndex)` 获取基因型
`default java.util.Map<Genotype,java.lang.Integer>`	`getGenotypeCounts()` 获取基因型计数值
`int`	`getGenotypeNum()` 获取基因型序列长度
`default int`	`getLeftGenotype(int genotypeIndex)` 获取左侧基因型
`default int[]`	`getLeftGenotypes()` 获取左侧基因型序列
`default int`	`getMissingGenotypeNum()` 获取基因型序列长度
`default int`	`getRightGenotype(int genotypeIndex)` 获取右侧基因型
`default int[]`	`getRightGenotypes()` 获取右侧基因型序列
`default boolean`	`isMissingGenotype(int genotypeIndex)` 是否为缺失基因型
`boolean`	`isModifiable()` 当前基因型序列类型是否可修改的
`boolean`	`isPhased()` 基因型是否有向
`default java.util.Iterator<Genotype>`	`iterator()`
`static IGenotypes`	`load(boolean phased, int genotypeNum)` 基因型解码方法加载一个不包含任何基因型的基因型对象, 通常它用于缺失位点的占位
`static IGenotypes`	`load(edu.sysu.pmglab.container.ByteCode encodedSequence)` 基因型解码方法解码后的基因型储存在 CacheGenotypes 中
`static IGenotypes`	`load(Variant variant)` 从 Variant 对象中获取基因型序列
`default IGenotypes`	`setGenotype(int genotypeIndex, Genotype genotype)` 设置基因型
`default IGenotypes`	`subGenotypes(edu.sysu.pmglab.container.array.BaseArray<java.lang.Integer> indexes)` 获取子基因型序列
`default IGenotypes`	`subGenotypes(int[] indexes)` 获取子基因型序列
`default IGenotypes`	`toBiallelic(int refAlleleIndex, int altAlleleIndex)` 转为二等位基因位点指定的 refAlleleIndex 作为 0, altAlleleIndex 作为 1, 包含了其他值的基因型会被替换为 ./.
`default IGenotypes`	`toPhased()` 转为 Phased 基因型
`default IGenotypes`	`toPhased(boolean phased)` 转换基因型向型
`default IGenotypes`	`toUnPhased()` 转为 unPhased 基因型

从接口继承的方法 java.lang.Iterable
forEach, spliterator

- 方法详细资料
  - isPhased
```
boolean isPhased()
```
    基因型是否有向
    
    返回:
    
    基因型是否有向
  - getGenotypeNum
```
int getGenotypeNum()
```
    获取基因型序列长度
    
    返回:
    
    基因型序列长度
  - getMissingGenotypeNum
```
default int getMissingGenotypeNum()
```
    获取基因型序列长度
    
    返回:
    
    基因型序列长度
  - getGenotype
```
Genotype getGenotype(int genotypeIndex)
```
    获取基因型
    
    参数:
    
    genotypeIndex - 基因型索引
    
    返回:
    
    指定基因型索引的基因型
  - setGenotype
```
default IGenotypes setGenotype(int genotypeIndex,
                               Genotype genotype)
```
    设置基因型
    
    参数:
    
    genotypeIndex - 基因型索引
    
    genotype - 基因型
    
    返回:
    
    本类
  - getLeftGenotype
```
default int getLeftGenotype(int genotypeIndex)
```
    获取左侧基因型
    
    参数:
    
    genotypeIndex - 基因型索引
    
    返回:
    
    指定基因型索引的左侧基因型
  - getRightGenotype
```
default int getRightGenotype(int genotypeIndex)
```
    获取右侧基因型
    
    参数:
    
    genotypeIndex - 基因型索引
    
    返回:
    
    指定基因型索引的右侧基因型
  - getLeftGenotypes
```
default int[] getLeftGenotypes()
```
    获取左侧基因型序列
    
    返回:
    
    左侧基因型序列
  - getRightGenotypes
```
default int[] getRightGenotypes()
```
    获取右侧基因型序列
    
    返回:
    
    右侧基因型序列
  - isMissingGenotype
```
default boolean isMissingGenotype(int genotypeIndex)
```
    是否为缺失基因型
    
    参数:
    
    genotypeIndex - 基因型索引
    
    返回:
    
    指定基因型索引的基因型是否为缺失基因型
  - iterator
```
default java.util.Iterator<Genotype> iterator()
```
    指定者:
    
    iterator 在接口中 java.lang.Iterable<Genotype>
  - getAC
```
default int getAC()
```
    获取等位基因计数 (allele count) 非 . 和非 0 基因型的总数
    
    返回:
    
    等位基因计数
  - getAN
```
default int getAN()
```
    获取等位基因总数 (allele number) 非 . 基因型的总数
    
    返回:
    
    等位基因总数
  - getAF
```
default float getAF()
```
    获取等位基因频率 (allele frequency) 非 . 和非 0 基因型的频率
    
    返回:
    
    等位基因频率
  - getAC
```
default int getAC(int index)
```
    获取指定等位基因索引的等位基因计数
    
    参数:
    
    index - 等位基因索引
    
    返回:
    
    指定等位基因索引的等位基因计数
  - getAF
```
default float getAF(int index)
```
    获取指定等位基因索引的等位基因频率
    
    参数:
    
    index - 等位基因索引
    
    返回:
    
    指定等位基因索引的等位基因频率
  - getGenotypeCounts
```
default java.util.Map<Genotype,java.lang.Integer> getGenotypeCounts()
```
    获取基因型计数值
    
    返回:
    
    基因型计数结果
  - clear
```
default void clear()
```
    重设基因型序列
  - toUnPhased
```
default IGenotypes toUnPhased()
```
    转为 unPhased 基因型
    
    返回:
    
    unphased Genotypes
  - toPhased
```
default IGenotypes toPhased()
```
    转为 Phased 基因型
    
    返回:
    
    phased Genotypes
  - toPhased
```
default IGenotypes toPhased(boolean phased)
```
    转换基因型向型
    
    参数:
    
    phased - 向型
    
    返回:
    
    本类
  - toBiallelic
```
default IGenotypes toBiallelic(int refAlleleIndex,
                               int altAlleleIndex)
```
    转为二等位基因位点指定的 refAlleleIndex 作为 0, altAlleleIndex 作为 1, 包含了其他值的基因型会被替换为 ./.
    
    参数:
    
    refAlleleIndex - 设置参考基因型的索引
    
    altAlleleIndex - 设置替代基因型的索引
    
    返回:
    
    本类
  - load
```
static IGenotypes load(Variant variant)
```
    从 Variant 对象中获取基因型序列
    
    参数:
    
    variant - 变异位点对象
    
    返回:
    
    基因型信息, null 表示位点中不存在该对象
  - load
```
static IGenotypes load(edu.sysu.pmglab.container.ByteCode encodedSequence)
```
    基因型解码方法解码后的基因型储存在 CacheGenotypes 中
    
    参数:
    
    encodedSequence - 编码流
    
    返回:
    
    本类
  - load
```
static IGenotypes load(boolean phased,
                       int genotypeNum)
```
    基因型解码方法加载一个不包含任何基因型的基因型对象, 通常它用于缺失位点的占位
    
    参数:
    
    phased - 向型
    
    genotypeNum - 基因型序列长度
    
    返回:
    
    本类
  - encode
```
edu.sysu.pmglab.container.ByteCode encode()
```
    基因型编码方法
    
    返回:
    
    本类
  - format
```
default void format(edu.sysu.pmglab.container.VolumeByteStream cache,
                    byte separator)
```
    格式化基因型
    
    参数:
    
    cache - 格式化容器
    
    separator - 连接符
  - format
```
default void format(edu.sysu.pmglab.container.VolumeByteStream cache,
                    edu.sysu.pmglab.container.ByteCode separator)
```
    格式化基因型
    
    参数:
    
    cache - 格式化容器
    
    separator - 连接符
  - asUnmodifiable
```
IGenotypes asUnmodifiable()
```
    转为不可变的基因型序列类型
    
    返回:
    
    不可变的基因型序列类型
  - asModifiable
```
IGenotypes asModifiable()
```
    转为可变的基因型序列类型
    
    返回:
    
    可变的基因型序列类型
  - subGenotypes
```
default IGenotypes subGenotypes(int[] indexes)
```
    获取子基因型序列
    
    参数:
    
    indexes - 基因型索引
    
    返回:
    
    子基因型序列
  - subGenotypes
```
default IGenotypes subGenotypes(edu.sysu.pmglab.container.array.BaseArray<java.lang.Integer> indexes)
```
    获取子基因型序列
    
    参数:
    
    indexes - 基因型索引
    
    返回:
    
    子基因型序列
  - isModifiable
```
boolean isModifiable()
```
    当前基因型序列类型是否可修改的
    
    返回:
    
    当前基因型序列类型是否可修改的

接口 IGenotypes

方法概要

从接口继承的方法 java.lang.Iterable

方法详细资料

isPhased

getGenotypeNum

getMissingGenotypeNum

getGenotype

setGenotype

getLeftGenotype

getRightGenotype

getLeftGenotypes

getRightGenotypes

isMissingGenotype

iterator

getAC

getAN

getAF

getAC

getAF

getGenotypeCounts

clear

toUnPhased

toPhased

toPhased

toBiallelic

load

load

load

encode

format

format

asUnmodifiable

asModifiable

subGenotypes

subGenotypes

isModifiable