FixedWidthTextFile.ReadMatrix Method

Definition

Namespace: Extreme.Data.Text
Assembly: Extreme.Data (in Extreme.Data.dll) Version: 3.2.0

Overload List

ReadMatrix<T>(Stream, FixedWidthTextOptions) Reads a matrix from a stream in fixed-width text format.
ReadMatrix<T>(Stream, Int32[]) Reads a matrix from a stream in fixed-width text format.
ReadMatrix<T>(String, FixedWidthTextOptions) Reads a matrix from a file in fixed-width text format.
ReadMatrix<T>(String, Int32[]) Reads a matrix from a file in fixed-width text format.

ReadMatrix<T>(Stream, FixedWidthTextOptions)

Reads a matrix from a stream in fixed-width text format.
C#
public static Matrix<T> ReadMatrix<T>(
	Stream stream,
	FixedWidthTextOptions options
)

Parameters

stream  Stream
A stream.
options  FixedWidthTextOptions
A FixedWidthTextOptions object that specifies the options to use when reading the file.

Type Parameters

T
The element type of the matrix.

Return Value

Matrix<T>
The matrix that was read from the stream pointed to by stream.

Remarks

The element type of the stored matrix does not have to match the element type of the returned matrix. However, casting values from this type to type T must succeed.

ReadMatrix<T>(Stream, Int32[])

Reads a matrix from a stream in fixed-width text format.
C#
public static Matrix<T> ReadMatrix<T>(
	Stream stream,
	int[] columnBreaks
)

Parameters

stream  Stream
A stream.
columnBreaks  Int32[]
An integer array containing the zero-based indexes of the column breaks on each row.

Type Parameters

T
The element type of the matrix.

Return Value

Matrix<T>
The matrix that was read from the stream pointed to by stream.

Remarks

The element type of the stored matrix does not have to match the element type of the returned matrix. However, casting values from this type to type T must succeed.

ReadMatrix<T>(String, FixedWidthTextOptions)

Reads a matrix from a file in fixed-width text format.
C#
public static Matrix<T> ReadMatrix<T>(
	string path,
	FixedWidthTextOptions options
)

Parameters

path  String
The path to the file.
options  FixedWidthTextOptions
A FixedWidthTextOptions object that specifies the options to use when reading the file.

Type Parameters

T
The element type of the matrix.

Return Value

Matrix<T>
The data frame that was read from the file pointed to by path.

Remarks

The element type of the stored matrix does not have to match the element type of the returned matrix. However, casting values from this type to type T must succeed.

Exceptions

FileNotFoundException The specified file does not exist.

ReadMatrix<T>(String, Int32[])

Reads a matrix from a file in fixed-width text format.
C#
public static Matrix<T> ReadMatrix<T>(
	string path,
	int[] columnBreaks
)

Parameters

path  String
The path to the file.
columnBreaks  Int32[]
An integer array containing the zero-based indexes of the column breaks on each row.

Type Parameters

T
The element type of the matrix.

Return Value

Matrix<T>
The data frame that was read from the file pointed to by path.

Remarks

The element type of the stored matrix does not have to match the element type of the returned matrix. However, casting values from this type to type T must succeed.

Exceptions

FileNotFoundException The specified file does not exist.

See Also