MATDecoder

java.lang.Object
- edu.sysu.pmglab.mat.decoder.MATDecoder

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<IRecord>
```
public abstract class MATDecoder
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Closeable, java.lang.Iterable<IRecord>
```
矩阵解码器

另请参阅:

通用矩阵解码器, 稀疏矩阵解码器, 对称矩阵解码器

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`close()` 关闭解码器
`abstract int`	`columnIndexOf(edu.sysu.pmglab.container.ByteCode columnName)` 查看指定列成员元素在列中的索引
`int`	`columnIndexOf(java.lang.String columnName)` 查看指定列成员元素在列中的索引
`abstract edu.sysu.pmglab.container.ByteCode`	`columnNameOf(int columnNameIndex)` 获取指定索引的列名
`boolean`	`containField(java.lang.String fieldName)` 是否包含指定字段
`boolean`	`endOfFile()` 是否到达文件末尾
`abstract int`	`getColumnNum()` 获取列元个数
`int`	`getFieldIndex(java.lang.String fieldName)` 根据字段名获取值字段的索引
`java.lang.String`	`getFieldName(int fieldIndex)` 根据索引获取值的字段名
`int`	`getFieldNum()`
`FieldType`	`getFieldType(java.lang.String fieldName)` 获取值类型
`java.util.Map<java.lang.String,FieldType>`	`getFieldTypes()` 获取值类型 (字段名-类型)
`edu.sysu.pmglab.unifyIO.Path`	`getFilePath()` 获取输入文件名
`MatrixType`	`getMatrixType()` 获取矩阵类型
`MATMeta`	`getMeta()` 获取注释信息
`IRecord`	`getRecord()` 获取记录模版对象
`long`	`getRecordNum()` 获取总记录条目数
`abstract int`	`getRowNum()` 获取行元个数
`boolean`	`isClosed()` 文件是否已关闭
`java.util.Iterator<IRecord>`	`iterator()`
`java.lang.Iterable<IRecord>`	`iterator(java.util.function.Function<IRecord,java.lang.Boolean> filter)` 迭代读取满足条件的所有记录
`java.lang.Iterable<IRecord>`	`iterator(java.util.Map<java.lang.Integer,edu.sysu.pmglab.container.array.IntArray> pairIndexes, java.util.function.Function<IRecord,java.lang.Boolean> filter)` 迭代读取满足条件的所有记录
`static MATDecoder`	`of(CCFTable inputFile)` 实例化解码器
`static MATDecoder`	`of(CCFTable table, java.lang.Iterable<java.lang.String> fieldNames)` 实例化解码器
`static MATDecoder`	`of(CCFTable inputFile, java.lang.String... fieldNames)` 实例化解码器
`static MATDecoder`	`of(java.io.File inputFile)` 实例化解码器
`static MATDecoder`	`of(java.io.File inputFile, java.lang.Iterable<java.lang.String> fieldNames)` 实例化解码器
`static MATDecoder`	`of(java.io.File inputFile, java.lang.String... fieldNames)` 实例化解码器
`static MATDecoder`	`of(edu.sysu.pmglab.unifyIO.Path inputFile)` 实例化解码器
`static MATDecoder`	`of(edu.sysu.pmglab.unifyIO.Path inputFile, java.lang.Iterable<java.lang.String> fieldNames)` 实例化解码器
`static MATDecoder`	`of(edu.sysu.pmglab.unifyIO.Path inputFile, java.lang.String... fieldNames)` 实例化解码器
`static MATDecoder`	`of(java.lang.String inputFileName)` 实例化解码器
`static MATDecoder`	`of(java.lang.String inputFileName, java.lang.Iterable<java.lang.String> fieldNames)` 实例化解码器
`static MATDecoder`	`of(java.lang.String inputFileName, java.lang.String... fieldNames)` 实例化解码器
`IRecord`	`read()` 读取一条记录文件指针到达末尾时返回 null
`abstract boolean`	`read(IRecord record)` 读取一条记录到 IRecord 对象中文件指针到达末尾时返回 false 复用 IRecord 对象有助于减少内存开销
`abstract IRecord`	`readCoordinate()` 读取一条记录的坐标信息 (行列信息) 文件指针到达末尾时返回 null
`long`	`remaining()` 获取当前的剩余可读记录数
`abstract int`	`rowIndexOf(edu.sysu.pmglab.container.ByteCode rowName)` 查看指定行成员元素在行中的索引
`int`	`rowIndexOf(java.lang.String rowName)` 查看指定行成员元素在行中的索引
`abstract edu.sysu.pmglab.container.ByteCode`	`rowNameOf(int rowNameIndex)` 获取指定索引的行名
`boolean`	`seek(edu.sysu.pmglab.container.ByteCode row, edu.sysu.pmglab.container.ByteCode column)` 定位到指定的行、列名位置
`boolean`	`seek(edu.sysu.pmglab.container.ByteCode row, edu.sysu.pmglab.container.ByteCode column, java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)` 定位到指定的行、列名位置
`boolean`	`seek(java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)` 定位到满足指定值过滤器的位置
`abstract boolean`	`seek(int rowIndex, int columnIndex)` 定位到指定的行、列索引位置
`boolean`	`seek(int rowIndex, int columnIndex, java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)` 定位到指定的行、列索引位置
`boolean`	`seek(long recordIndex)` 定位到指定的索引位置
`boolean`	`seek(java.lang.String row, java.lang.String column)` 定位到指定的行、列名位置
`boolean`	`seek(java.lang.String row, java.lang.String column, java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)` 定位到指定的行、列名位置
`long`	`tell()` 获取当前的行号
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- 方法详细资料
  - of
```
public static MATDecoder of(java.lang.String inputFileName)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFileName - 输入文件
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(java.io.File inputFile)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(edu.sysu.pmglab.unifyIO.Path inputFile)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(CCFTable inputFile)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(java.lang.String inputFileName,
                            java.lang.String... fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFileName - 输入文件
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(java.io.File inputFile,
                            java.lang.String... fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(edu.sysu.pmglab.unifyIO.Path inputFile,
                            java.lang.String... fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(CCFTable inputFile,
                            java.lang.String... fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(java.io.File inputFile,
                            java.lang.Iterable<java.lang.String> fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(java.lang.String inputFileName,
                            java.lang.Iterable<java.lang.String> fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFileName - 输入文件名
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(edu.sysu.pmglab.unifyIO.Path inputFile,
                            java.lang.Iterable<java.lang.String> fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    inputFile - 输入文件名
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - of
```
public static MATDecoder of(CCFTable table,
                            java.lang.Iterable<java.lang.String> fieldNames)
                     throws java.io.IOException
```
    实例化解码器
    
    参数:
    
    table - 输入数据表
    
    fieldNames - 读取的列字段
    
    返回:
    
    矩阵解码器
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - getRecord
```
public IRecord getRecord()
```
    获取记录模版对象
    
    返回:
    
    记录模版对象
  - read
```
public final IRecord read()
```
    读取一条记录
    文件指针到达末尾时返回 null
    
    返回:
    
    记录对象
  - read
```
public abstract boolean read(IRecord record)
```
    读取一条记录到 IRecord 对象中
    文件指针到达末尾时返回 false
    复用 IRecord 对象有助于减少内存开销
    
    参数:
    
    record - 记录
    
    返回:
    
    是否读取到了完整的记录
  - readCoordinate
```
public abstract IRecord readCoordinate()
```
    读取一条记录的坐标信息 (行列信息)
    文件指针到达末尾时返回 null
    
    返回:
    
    记录的坐标信息对象
  - seek
```
public final boolean seek(long recordIndex)
```
    定位到指定的索引位置
    
    参数:
    
    recordIndex - 索引位置 (三元组表中的行索引)
    
    返回:
    
    true
  - seek
```
public abstract boolean seek(int rowIndex,
                             int columnIndex)
```
    定位到指定的行、列索引位置
    
    参数:
    
    rowIndex - 行索引
    
    columnIndex - 列索引
    
    返回:
    
    是否找到记录
  - seek
```
public final boolean seek(java.lang.String row,
                          java.lang.String column)
```
    定位到指定的行、列名位置
    
    参数:
    
    row - 行名
    
    column - 列名
    
    返回:
    
    是否找到记录
  - seek
```
public final boolean seek(edu.sysu.pmglab.container.ByteCode row,
                          edu.sysu.pmglab.container.ByteCode column)
```
    定位到指定的行、列名位置
    
    参数:
    
    row - 行名
    
    column - 列名
    
    返回:
    
    是否找到记录
  - seek
```
public final boolean seek(java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)
```
    定位到满足指定值过滤器的位置
    
    参数:
    
    valueFilter - 值过滤器
    
    返回:
    
    是否找到记录
  - seek
```
public final boolean seek(int rowIndex,
                          int columnIndex,
                          java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)
```
    定位到指定的行、列索引位置
    
    参数:
    
    rowIndex - 行索引, -1 表示不限制此值
    
    columnIndex - 列索引, -1 表示不限制此值
    
    valueFilter - 值过滤器
    
    返回:
    
    是否找到记录
  - seek
```
public final boolean seek(java.lang.String row,
                          java.lang.String column,
                          java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)
```
    定位到指定的行、列名位置
    
    参数:
    
    row - 行名
    
    column - 列名
    
    valueFilter - 值过滤器
    
    返回:
    
    是否找到记录
  - seek
```
public final boolean seek(edu.sysu.pmglab.container.ByteCode row,
                          edu.sysu.pmglab.container.ByteCode column,
                          java.util.function.Function<IRecord,java.lang.Boolean> valueFilter)
```
    定位到指定的行、列名位置
    
    参数:
    
    row - 行名
    
    column - 列名
    
    valueFilter - 值过滤器
    
    返回:
    
    是否找到记录
  - getFieldTypes
```
public final java.util.Map<java.lang.String,FieldType> getFieldTypes()
```
    获取值类型 (字段名-类型)
    
    返回:
    
    值类型
  - getFieldType
```
public final FieldType getFieldType(java.lang.String fieldName)
```
    获取值类型
    
    参数:
    
    fieldName - 指定的列名
    
    返回:
    
    值类型
  - getFieldName
```
public final java.lang.String getFieldName(int fieldIndex)
```
    根据索引获取值的字段名
    
    参数:
    
    fieldIndex - 指定的字段索引
    
    返回:
    
    指定字段索引的字段名
  - getFieldIndex
```
public final int getFieldIndex(java.lang.String fieldName)
```
    根据字段名获取值字段的索引
    
    参数:
    
    fieldName - 指定的字段名
    
    返回:
    
    指定字段名的字段索引
  - getFieldNum
```
public final int getFieldNum()
```
    返回:
    
    总字段数
  - containField
```
public final boolean containField(java.lang.String fieldName)
```
    是否包含指定字段
    
    参数:
    
    fieldName - 指定的列名
    
    返回:
    
    值类型
  - getMatrixType
```
public final MatrixType getMatrixType()
```
    获取矩阵类型
    
    返回:
    
    矩阵类型
  - getFilePath
```
public final edu.sysu.pmglab.unifyIO.Path getFilePath()
```
    获取输入文件名
    
    返回:
    
    输入文件名
  - getRecordNum
```
public final long getRecordNum()
```
    获取总记录条目数
    
    返回:
    
    总记录条目数
  - getColumnNum
```
public abstract int getColumnNum()
```
    获取列元个数
    
    返回:
    
    列元个数
  - getRowNum
```
public abstract int getRowNum()
```
    获取行元个数
    
    返回:
    
    行元个数
  - tell
```
public final long tell()
```
    获取当前的行号
    
    返回:
    
    当前的行号
  - remaining
```
public final long remaining()
```
    获取当前的剩余可读记录数
    
    返回:
    
    剩余可读记录数
  - endOfFile
```
public final boolean endOfFile()
```
    是否到达文件末尾
    
    返回:
    
    是否到达文件末尾
  - rowIndexOf
```
public abstract int rowIndexOf(edu.sysu.pmglab.container.ByteCode rowName)
```
    查看指定行成员元素在行中的索引
    
    参数:
    
    rowName - 行成员
    
    返回:
    
    行成员元素的索引
  - rowIndexOf
```
public final int rowIndexOf(java.lang.String rowName)
```
    查看指定行成员元素在行中的索引
    
    参数:
    
    rowName - 行成员
    
    返回:
    
    行成员元素的索引
  - columnIndexOf
```
public abstract int columnIndexOf(edu.sysu.pmglab.container.ByteCode columnName)
```
    查看指定列成员元素在列中的索引
    
    参数:
    
    columnName - 列成员
    
    返回:
    
    列成员元素的索引
  - columnIndexOf
```
public final int columnIndexOf(java.lang.String columnName)
```
    查看指定列成员元素在列中的索引
    
    参数:
    
    columnName - 列成员
    
    返回:
    
    列成员元素的索引
  - rowNameOf
```
public abstract edu.sysu.pmglab.container.ByteCode rowNameOf(int rowNameIndex)
```
    获取指定索引的行名
    
    参数:
    
    rowNameIndex - 行索引
    
    返回:
    
    行名
  - columnNameOf
```
public abstract edu.sysu.pmglab.container.ByteCode columnNameOf(int columnNameIndex)
```
    获取指定索引的列名
    
    参数:
    
    columnNameIndex - 列索引
    
    返回:
    
    列名
  - getMeta
```
public MATMeta getMeta()
```
    获取注释信息
    
    返回:
    
    注释信息
  - iterator
```
public final java.util.Iterator<IRecord> iterator()
```
    指定者:
    
    iterator 在接口中 java.lang.Iterable<IRecord>
  - isClosed
```
public boolean isClosed()
```
    文件是否已关闭
    
    返回:
    
    文件是否已关闭
  - close
```
public void close()
           throws java.io.IOException
```
    关闭解码器
    
    指定者:
    
    close 在接口中 java.io.Closeable
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - iterator
```
public java.lang.Iterable<IRecord> iterator(java.util.Map<java.lang.Integer,edu.sysu.pmglab.container.array.IntArray> pairIndexes,
                                            java.util.function.Function<IRecord,java.lang.Boolean> filter)
```
    迭代读取满足条件的所有记录
    
    参数:
    
    pairIndexes - 行列索引信息
    
    filter - 过滤器
    
    返回:
    
    迭代器对象
  - iterator
```
public java.lang.Iterable<IRecord> iterator(java.util.function.Function<IRecord,java.lang.Boolean> filter)
```
    迭代读取满足条件的所有记录
    
    参数:
    
    filter - 过滤器
    
    返回:
    
    迭代器对象
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 MATDecoder

方法概要

从类继承的方法 java.lang.Object

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

方法详细资料

of

of

of

of

of

of

of

of

of

of

of

of

getRecord

read

read

readCoordinate

seek

seek

seek

seek

seek

seek

seek

seek

getFieldTypes

getFieldType

getFieldName

getFieldIndex

getFieldNum

containField

getMatrixType

getFilePath

getRecordNum

getColumnNum

getRowNum

tell

remaining

endOfFile

rowIndexOf

rowIndexOf

columnIndexOf

columnIndexOf

rowNameOf

columnNameOf

getMeta

iterator

isClosed

close

iterator

iterator

toString