This class provides methods to format arrays and matrices into String s in different styles. More...

Static Public Attributes
Formating styles @{
static final int	PLAIN = 0
	Plain text matrix printing style.
static final int	MATHEMATICA = 1
	Mathematica matrix printing style.
static final int	MATLAB = 2
	Matlab matrix printing style.

Functions to convert arrays to <tt>String</tt> @{
static String	format (int V[], int n1, int n2, int k, int p)
	Formats a String containing the elements n1 to n2 (inclusive) of table V, k elements per line, p positions per element.
static String	format (double V[], int n1, int n2, int k, int p1, int p2, int p3)
	Similar to the previous method, but for an array of double’s.
static String	format (double[][] Mat, int i1, int i2, int j1, int j2, int w, int p, int style, String Name)
	Formats the submatrix with lines i1 \(\le i \le\) i2 and columns j1 \(\le j \le\) j2 of the matrix Mat, using the formatting style style.
static String	format (int[][] Mat, int i1, int i2, int j1, int j2, int w, int style, String Name)
	Similar to the previous method, but for a matrix of int’s.

Detailed Description

This class provides methods to format arrays and matrices into String s in different styles.

This could be useful for printing arrays and subarrays, or for putting them in files for further treatment by other softwares such as Mathematica, Matlab, etc.

Definition at line 35 of file TableFormat.java.

Member Function Documentation

◆ format() [1/4]

String umontreal.ssj.util.TableFormat.format	(	double	V[],
		int	n1,
		int	n2,
		int	k,
		int	p1,
		int	p2,
		int	p3 )

static

Similar to the previous method, but for an array of double’s.

Gives at least p1 positions per element, p2 digits after the decimal point, and at least p3 significant digits.

Parameters

V	array to be formated
n1	index of the first element being formated
n2	index of the last element being formated
k	number of elements per line
p1	number of positions per element
p2	number of digits after the decimal point
p3	number of significant digits

Returns: formated string repreenting the elements

Definition at line 113 of file TableFormat.java.

◆ format() [2/4]

String umontreal.ssj.util.TableFormat.format	(	double	Mat[][],
		int	i1,
		int	i2,
		int	j1,
		int	j2,
		int	w,
		int	p,
		int	style,
		String	Name )

static

Formats the submatrix with lines i1 \(\le i \le\) i2 and columns j1 \(\le j \le\) j2 of the matrix Mat, using the formatting style style.

The elements are formated in w positions each, with a precision of p digits. Name provides an identifier for the submatrix. To be treated by Matlab, the returned string must be copied to a file with extension .m. If the file is named poil.m, for example, it can be accessed by calling poil in Matlab. For Mathematica, if the file is named poil, it will be read using << poil;.

Parameters

Mat	matrix to be formated
i1	index of the first row being formated
i2	index of the last row being formated
j1	index of the first column being formated
j2	index of the last column being formated
w	number of positions for each element
p	number of digits after the decimal point of the elements
style	formating style of the submatrix, being one of MATHEMATICA, MATLAB, or PLAIN
Name	descriptive name of the submatrix

Returns: formated string representing the submatrix

Definition at line 205 of file TableFormat.java.

◆ format() [3/4]

String umontreal.ssj.util.TableFormat.format	(	int	V[],
		int	n1,
		int	n2,
		int	k,
		int	p )

static

Formats a String containing the elements n1 to n2 (inclusive) of table V, k elements per line, p positions per element.

If k = 1, the array index will also appear on the left of each element, i.e., each line i will have the form i V[i].

Parameters

V	array to be formated
n1	index of the first element being formated
n2	index of the last element being formated
k	number of elements per line
p	number of positions per element

Returns: formated string repreenting the elements

Definition at line 79 of file TableFormat.java.

◆ format() [4/4]

String umontreal.ssj.util.TableFormat.format	(	int	Mat[][],
		int	i1,
		int	i2,
		int	j1,
		int	j2,
		int	w,
		int	style,
		String	Name )

static

Similar to the previous method, but for a matrix of int’s.

Parameters

Mat	matrix to be formated
i1	index of the first row being formated
i2	index of the last row being formated
j1	index of the first column being formated
j2	index of the last column being formated
w	number of positions for each element
style	formating style of the submatrix, being one of MATHEMATICA, MATLAB, or PLAIN
Name	descriptive name of the submatrix

Returns: formated string representing the submatrix

Definition at line 265 of file TableFormat.java.

Member Data Documentation

◆ MATHEMATICA

final int umontreal.ssj.util.TableFormat.MATHEMATICA = 1

static

Mathematica matrix printing style.

Definition at line 51 of file TableFormat.java.

◆ MATLAB

final int umontreal.ssj.util.TableFormat.MATLAB = 2

static

Matlab matrix printing style.

Definition at line 56 of file TableFormat.java.

◆ PLAIN

final int umontreal.ssj.util.TableFormat.PLAIN = 0

static

Plain text matrix printing style.

Definition at line 46 of file TableFormat.java.

The documentation for this class was generated from the following file:

src/main/java/umontreal/ssj/util/TableFormat.java

SSJ API Documentation Stochastic Simulation in Java

Static Public Attributes

Functions to convert arrays to <tt>String</tt> @{

Detailed Description

Member Function Documentation

◆ format() [1/4]

◆ format() [2/4]

◆ format() [3/4]

◆ format() [4/4]

Member Data Documentation

◆ MATHEMATICA

◆ MATLAB

◆ PLAIN