edu.stanford.math.plex4.io

Class MatlabWriter

java.lang.Object

edu.stanford.math.plex4.io.MatlabWriter

public class MatlabWriter
extends java.lang.Object

This class encapsulates writing to Matlab files. It contains functions for basic output (e.g. comments), as well as the output of numerous mathematical objects. Important Note: The user must call close in order to flush the output to the file.

Author:

Andrew Tausz

Constructor Summary

Constructors

Constructor and Description
MatlabWriter(java.lang.String filename) This constructor initializes the class to be ready to write to the file with the filename provided.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignValue(java.lang.String varName, double value)
void	assignValue(java.lang.String varName, int value)
void	close() This function flushes the output stream and closes it.
java.lang.String	getColorCode(int index)
java.lang.String	getLineStyle(int index)
java.lang.String	getMarkerStyle(int index)
java.lang.String	getNextColor()
java.lang.String	getNextLineStyle()
java.lang.String	getNextMarker()
void	gridOff()
void	gridOn()
void	holdOff()
void	holdOn()
protected java.lang.String	insertComments(java.lang.String input) This function modifies the input string so that it will be properly printed as a comment in Matlab.
void	newLine() This function outputs a new line to the file.
void	newPlotWindow()
void	startNewCell(java.lang.String label) This function begins a new cell in the Matlab file.
static java.lang.String	toColumnVector(double[] array)
static java.lang.String	toColumnVector(double[] array, java.lang.String name)
static java.lang.String	toColumnVector(cern.colt.matrix.DoubleMatrix1D array)
static java.lang.String	toColumnVector(cern.colt.matrix.DoubleMatrix1D array, java.lang.String name)
static java.lang.String	toColumnVector(int[] array)
static java.lang.String	toColumnVector(int[] array, java.lang.String name)
static <T> java.lang.String	toColumnVector(java.lang.Iterable<T> collection)
static <T> java.lang.String	toColumnVector(java.lang.Iterable<T> collection, java.lang.String name)
static java.lang.String	toMatrix(double[][] matrix)
static java.lang.String	toMatrix(double[][] matrix, java.lang.String name)
static java.lang.String	toMatrix(cern.colt.matrix.DoubleMatrix2D matrix)
static java.lang.String	toMatrix(cern.colt.matrix.DoubleMatrix2D matrix, java.lang.String name)
static java.lang.String	toMatrix(int[][] matrix)
static java.lang.String	toMatrix(int[][] matrix, java.lang.String name)
static java.lang.String	toRowVector(double[] array)
static java.lang.String	toRowVector(double[] array, java.lang.String name)
static java.lang.String	toRowVector(cern.colt.matrix.DoubleMatrix1D array)
static java.lang.String	toRowVector(cern.colt.matrix.DoubleMatrix1D array, java.lang.String name)
static java.lang.String	toRowVector(int[] array)
static java.lang.String	toRowVector(int[] array, java.lang.String name)
static <T> java.lang.String	toRowVector(java.lang.Iterable<T> collection)
static <T> java.lang.String	toRowVector(java.lang.Iterable<T> collection, java.lang.String name)
static java.lang.String	toStringList(java.util.List<java.lang.String> array)
void	turnOffCommentMode() This function turns off the comment mode.
void	turnOnCommentMode() This function turns on the comment mode, meaning that any output will be written as a comment and not Matlab code.
void	write(java.lang.String string) This function writes a string to the file.
void	writeClearAll()
void	writeColumnVector(double[] array)
void	writeColumnVector(double[] array, java.lang.String name)
void	writeColumnVector(cern.colt.matrix.DoubleMatrix1D array)
void	writeColumnVector(cern.colt.matrix.DoubleMatrix1D array, java.lang.String name)
void	writeColumnVector(int[] array)
void	writeColumnVector(int[] array, java.lang.String name)
<T> void	writeColumnVector(java.lang.Iterable<T> collection)
<T> void	writeColumnVector(java.lang.Iterable<T> collection, java.lang.String name)
void	writeLine(java.lang.String string)
void	writeMatrix(double[][] matrix)
void	writeMatrix(double[][] matrix, java.lang.String name)
void	writeMatrix(cern.colt.matrix.DoubleMatrix2D matrix)
void	writeMatrix(cern.colt.matrix.DoubleMatrix2D matrix, java.lang.String name)
void	writeMatrix(int[][] matrix)
void	writeMatrix(int[][] matrix, java.lang.String name)
void	writeRowVector(double[] array)
void	writeRowVector(double[] array, java.lang.String name)
void	writeRowVector(cern.colt.matrix.DoubleMatrix1D array)
void	writeRowVector(cern.colt.matrix.DoubleMatrix1D array, java.lang.String name)
void	writeRowVector(int[] array)
void	writeRowVector(int[] array, java.lang.String name)
<T> void	writeRowVector(java.lang.Iterable<T> collection)
<T> void	writeRowVector(java.lang.Iterable<T> collection, java.lang.String name)
void	writeSparseMatrix(double[][] matrix, java.lang.String name)
void	writeSparseVector(double[] matrix, java.lang.String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MatlabWriter

public MatlabWriter(java.lang.String filename)
             throws java.io.IOException

This constructor initializes the class to be ready to write to the file with the filename provided.

Parameters:

filename - the file to write to

Throws:

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

This function flushes the output stream and closes it.

Throws:

java.io.IOException

turnOnCommentMode

public void turnOnCommentMode()

This function turns on the comment mode, meaning that any output will be written as a comment and not Matlab code.

turnOffCommentMode

public void turnOffCommentMode()

This function turns off the comment mode. Thus any output will be written as actual Matlab code.

insertComments

protected java.lang.String insertComments(java.lang.String input)
                                   throws java.io.IOException

This function modifies the input string so that it will be properly printed as a comment in Matlab.

Parameters:

input -

Throws:

java.io.IOException

writeClearAll

public void writeClearAll()
                   throws java.io.IOException

Throws:

java.io.IOException

assignValue

public void assignValue(java.lang.String varName,
               double value)
                 throws java.io.IOException

Throws:

java.io.IOException

assignValue

public void assignValue(java.lang.String varName,
               int value)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public void write(java.lang.String string)
           throws java.io.IOException

This function writes a string to the file. If comment mode is turned on, then the string is written as a comment.

Parameters:

string - the string to output

Throws:

java.io.IOException

writeLine

public void writeLine(java.lang.String string)
               throws java.io.IOException

Throws:

java.io.IOException

newLine

public void newLine()
             throws java.io.IOException

This function outputs a new line to the file.

Throws:

java.io.IOException

startNewCell

public void startNewCell(java.lang.String label)
                  throws java.io.IOException

This function begins a new cell in the Matlab file.

Parameters:

label - the label of the cell

Throws:

java.io.IOException

newPlotWindow

public void newPlotWindow()
                   throws java.io.IOException

Throws:

java.io.IOException

holdOn

public void holdOn()
            throws java.io.IOException

Throws:

java.io.IOException

holdOff

public void holdOff()
             throws java.io.IOException

Throws:

java.io.IOException

gridOn

public void gridOn()
            throws java.io.IOException

Throws:

java.io.IOException

gridOff

public void gridOff()
             throws java.io.IOException

Throws:

java.io.IOException

getMarkerStyle

public java.lang.String getMarkerStyle(int index)

getColorCode

public java.lang.String getColorCode(int index)

getLineStyle

public java.lang.String getLineStyle(int index)

getNextMarker

public java.lang.String getNextMarker()

getNextColor

public java.lang.String getNextColor()

getNextLineStyle

public java.lang.String getNextLineStyle()

writeRowVector

public void writeRowVector(cern.colt.matrix.DoubleMatrix1D array,
                  java.lang.String name)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public void writeColumnVector(cern.colt.matrix.DoubleMatrix1D array,
                     java.lang.String name)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRowVector

public void writeRowVector(cern.colt.matrix.DoubleMatrix1D array)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public void writeColumnVector(cern.colt.matrix.DoubleMatrix1D array)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRowVector

public void writeRowVector(double[] array,
                  java.lang.String name)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public void writeColumnVector(double[] array,
                     java.lang.String name)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRowVector

public void writeRowVector(double[] array)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public void writeColumnVector(double[] array)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRowVector

public void writeRowVector(int[] array,
                  java.lang.String name)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public void writeColumnVector(int[] array,
                     java.lang.String name)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRowVector

public void writeRowVector(int[] array)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public void writeColumnVector(int[] array)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRowVector

public <T> void writeRowVector(java.lang.Iterable<T> collection)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public <T> void writeColumnVector(java.lang.Iterable<T> collection)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRowVector

public <T> void writeRowVector(java.lang.Iterable<T> collection,
                      java.lang.String name)
                    throws java.io.IOException

Throws:

java.io.IOException

writeColumnVector

public <T> void writeColumnVector(java.lang.Iterable<T> collection,
                         java.lang.String name)
                       throws java.io.IOException

Throws:

java.io.IOException

writeMatrix

public void writeMatrix(cern.colt.matrix.DoubleMatrix2D matrix,
               java.lang.String name)
                 throws java.io.IOException

Throws:

java.io.IOException

writeMatrix

public void writeMatrix(cern.colt.matrix.DoubleMatrix2D matrix)
                 throws java.io.IOException

Throws:

java.io.IOException

writeSparseMatrix

public void writeSparseMatrix(double[][] matrix,
                     java.lang.String name)
                       throws java.io.IOException

Throws:

java.io.IOException

writeSparseVector

public void writeSparseVector(double[] matrix,
                     java.lang.String name)
                       throws java.io.IOException

Throws:

java.io.IOException

writeMatrix

public void writeMatrix(double[][] matrix,
               java.lang.String name)
                 throws java.io.IOException

Throws:

java.io.IOException

writeMatrix

public void writeMatrix(double[][] matrix)
                 throws java.io.IOException

Throws:

java.io.IOException

writeMatrix

public void writeMatrix(int[][] matrix,
               java.lang.String name)
                 throws java.io.IOException

Throws:

java.io.IOException

writeMatrix

public void writeMatrix(int[][] matrix)
                 throws java.io.IOException

Throws:

java.io.IOException

toRowVector

public static java.lang.String toRowVector(cern.colt.matrix.DoubleMatrix1D array,
                           java.lang.String name)

toColumnVector

public static java.lang.String toColumnVector(cern.colt.matrix.DoubleMatrix1D array,
                              java.lang.String name)

toRowVector

public static java.lang.String toRowVector(cern.colt.matrix.DoubleMatrix1D array)

toColumnVector

public static java.lang.String toColumnVector(cern.colt.matrix.DoubleMatrix1D array)

toRowVector

public static java.lang.String toRowVector(int[] array,
                           java.lang.String name)

toColumnVector

public static java.lang.String toColumnVector(int[] array,
                              java.lang.String name)

toRowVector

public static java.lang.String toRowVector(int[] array)

toColumnVector

public static java.lang.String toColumnVector(int[] array)

toRowVector

public static java.lang.String toRowVector(double[] array,
                           java.lang.String name)

toColumnVector

public static java.lang.String toColumnVector(double[] array,
                              java.lang.String name)

toRowVector

public static java.lang.String toRowVector(double[] array)

toColumnVector

public static java.lang.String toColumnVector(double[] array)

toRowVector

public static <T> java.lang.String toRowVector(java.lang.Iterable<T> collection,
                               java.lang.String name)

toColumnVector

public static <T> java.lang.String toColumnVector(java.lang.Iterable<T> collection,
                                  java.lang.String name)

toRowVector

public static <T> java.lang.String toRowVector(java.lang.Iterable<T> collection)

toColumnVector

public static <T> java.lang.String toColumnVector(java.lang.Iterable<T> collection)

toMatrix

public static java.lang.String toMatrix(cern.colt.matrix.DoubleMatrix2D matrix,
                        java.lang.String name)

toMatrix

public static java.lang.String toMatrix(double[][] matrix,
                        java.lang.String name)

toMatrix

public static java.lang.String toMatrix(int[][] matrix,
                        java.lang.String name)

toMatrix

public static java.lang.String toMatrix(cern.colt.matrix.DoubleMatrix2D matrix)

toMatrix

public static java.lang.String toMatrix(double[][] matrix)

toMatrix

public static java.lang.String toMatrix(int[][] matrix)

toStringList

public static java.lang.String toStringList(java.util.List<java.lang.String> array)