BaseArrayToStream Method

Note: This API is now obsolete.

[ObsoleteAttribute("Use the classes in ILNumerics.IO.HDF5 or ILNumerics.ILMatFile instead!")]
public abstract void ToStream(
	Stream outStream,
	string format,
	ArrayStreamSerializationFlags method
)

<ObsoleteAttribute("Use the classes in ILNumerics.IO.HDF5 or ILNumerics.ILMatFile instead!")>
Public MustOverride Sub ToStream ( 
	outStream As Stream,
	format As String,
	method As ArrayStreamSerializationFlags
)

Dim instance As BaseArray
Dim outStream As Stream
Dim format As String
Dim method As ArrayStreamSerializationFlags

instance.ToStream(outStream, format, method)

Parameters

outStream

Type: System.IOStream
Stream to write the values into.

format

Type: SystemString
Format string to be used for output. See Format(String, Object) for a specification of valid formating expressions. This flag is only used, when 'method' is set to 'Serial'.

method

Type: ILNumericsArrayStreamSerializationFlags
A constant out of ArrayStreamSerializationFlags. Specifies the way the values will be serialized.

If method 'Formatted' is used, any occurences of NewLine character(s) will be replaced from the format string before applying to the elements. This is done to prevent the format from breaking the 'page' style for the output.

If 'method' is set to 'Matlab', the array will be written as Matfile version 5.0. No compression will be used. The internal 'Name' property will be used as the array name for writing. This array instance will be the only array in the mat file. If you want to write several arrays bundled into one mat file, use the MatFile class to create a collection of arrays and write the MatFile to stream. Or use the classes in the ILNumerics.IO.HDF5 namespace to create a HDF5 format file (recommended).

[ILNumerics Core Module]

Reference