| SSJ
    3.2.1
    Stochastic Simulation in Java | 
This class provides tools to create and manage curve plots. More...
| Public Member Functions | |
| XYLineChart () | |
| Initializes a new XYLineChartinstance with an empty data set. | |
| XYLineChart (String title, String XLabel, String YLabel, double[][]... data) | |
| Initializes a new XYLineChartinstance with sets of pointsdata.  More... | |
| XYLineChart (String title, String XLabel, String YLabel, double[][] data, int numPoints) | |
| Initializes a new XYLineChartinstance with sets of pointsdata.  More... | |
| XYLineChart (String title, String XLabel, String YLabel, double[][] data, int x, int y) | |
| Initializes a new XYLineChartinstance using subsets ofdata.  More... | |
| XYLineChart (String title, String XLabel, String YLabel, DoubleArrayList... data) | |
| Initializes a new XYLineChartinstance with datadata.  More... | |
| XYLineChart (String title, String XLabel, String YLabel, XYSeriesCollection data) | |
| Initializes a new XYLineChartinstance with datadata.  More... | |
| int | add (double[] x, double[] y, String name, String plotStyle) | 
| Adds a data series into the series collection.  More... | |
| int | add (double[] x, double[] y) | 
| Adds a data series into the series collection.  More... | |
| int | add (double[] x, double[] y, int numPoints) | 
| Adds a data series into the series collection.  More... | |
| int | add (double[][] data) | 
| Adds the new collection of data series datainto the series collection.  More... | |
| int | add (double[][] data, int numPoints) | 
| Adds the new collection of data series datainto the series collection.  More... | |
| XYListSeriesCollection | getSeriesCollection () | 
| Returns the chart’s dataset.  More... | |
| void | setSeriesCollection (XYListSeriesCollection dataset) | 
| Links a new dataset to the current chart.  More... | |
| void | setTicksSynchro (int s) | 
| Synchronizes \(X\)-axis ticks to the \(s\)-th series \(x\)-values.  More... | |
| JFrame | view (int width, int height) | 
| Displays chart on the screen using Swing.  More... | |
| JFrame | viewBar (int width, int height) | 
| Displays bar chart on the screen using Swing.  More... | |
| Latex-specific method | |
| String | toLatex (double width, double height) | 
|  Public Member Functions inherited from XYChart | |
| JFreeChart | getJFreeChart () | 
| Returns the JFreeChartobject associated with this chart.  More... | |
| Axis | getXAxis () | 
| Returns the chart’s domain axis ( \(x\)-axis) object.  More... | |
| Axis | getYAxis () | 
| Returns the chart’s range axis ( \(y\)-axis) object.  More... | |
| abstract JFrame | view (int width, int height) | 
| Displays chart on the screen using Swing. | |
| String | getTitle () | 
| Gets the current chart title.  More... | |
| void | setTitle (String title) | 
| Sets a title to this chart.  More... | |
| void | setprobFlag (boolean flag) | 
| Must be set truewhen plotting probabilities,falseotherwise.  More... | |
| void | setAutoRange () | 
| The \(x\) and the \(y\) ranges of the chart are set automatically. | |
| void | setAutoRange (boolean right, boolean top) | 
| The \(x\) and the \(y\) ranges of the chart are set automatically.  More... | |
| void | setAutoRange00 (boolean xZero, boolean yZero) | 
| The \(x\) and the \(y\) ranges of the chart are set automatically.  More... | |
| void | setManualRange (double[] range) | 
| Sets the \(x\) and \(y\) ranges of the chart using the format: range = [xmin, xmax, ymin, ymax].  More... | |
| void | setManualRange (double[] range, boolean right, boolean top) | 
| Sets the \(x\) and \(y\) ranges of the chart using the format: range = [xmin, xmax, ymin, ymax].  More... | |
| void | setManualRange00 (double[] range, boolean xZero, boolean yZero) | 
| Sets the \(x\) and \(y\) ranges of the chart using the format: range = [xmin, xmax, ymin, ymax].  More... | |
| double | getChartMargin () | 
| Returns the chart margin, which is the fraction by which the chart is enlarged on its borders.  More... | |
| void | setChartMargin (double margin) | 
| Sets the chart margin to margin.  More... | |
| abstract void | setTicksSynchro (int s) | 
| Synchronizes \(x\)-axis ticks to the \(s\)-th series \(x\)-values.  More... | |
| void | drawVerticalLine (double x, String name, double yfrac, boolean right) | 
| Draws a vertical line on the chart at \(x\)-coordinate x.  More... | |
| void | enableGrid (double xstep, double ystep) | 
| Puts a grid on the background.  More... | |
| void | disableGrid () | 
| Disables the background grid. | |
| abstract String | toLatex (double width, double height) | 
| Exports the chart to a LaTeX source code using PGF/TikZ.  More... | |
| void | toLatexFile (String fileName, double width, double height) | 
| Transforms the chart to LaTeX form and writes it in file fileName.  More... | |
| void | setLatexDocFlag (boolean flag) | 
| Flag to remove the \documentclass(and other) commands in the created LaTeX files.  More... | |
| Protected Member Functions | |
| void | init (String title, String XLabel, String YLabel) | 
| void | initAxis () | 
|  Protected Member Functions inherited from XYChart | |
| void | setAutoRange (boolean xZero, boolean yZero, boolean right, boolean top) | 
| void | setTick0Flags () | 
| double | computeXScale (double position) | 
| double | computeYScale (double position) | 
| double | computeScale (double[] bounds) | 
| Additional Inherited Members | |
|  Protected Attributes inherited from XYChart | |
| Axis | XAxis | 
| Axis | YAxis | 
| SSJXYSeriesCollection | dataset | 
| JFreeChart | chart | 
| boolean | latexDocFlag = true | 
| boolean | autoRange | 
| double [] | manualRange | 
| boolean | grid = false | 
| double | xstepGrid | 
| double | ystepGrid | 
| boolean | probFlag = false | 
| double | chartMargin = 0.02 | 
This class provides tools to create and manage curve plots.
Using the XYLineChart class is the simplest way to produce curve plots only. Each XYLineChart object is linked with a umontreal.ssj.charts.XYListSeriesCollection data set.
| XYLineChart | ( | String | title, | 
| String | XLabel, | ||
| String | YLabel, | ||
| double... | data[][] | ||
| ) | 
Initializes a new XYLineChart instance with sets of points data. 
title is a title, XLabel is a short description of the \(x\)-axis, and YLabel a short description of the \(y\)-axis. The input parameter data represents a set of plotting data.
For example, if one \(n\)-row matrix data1 is given as argument data, then the first row data1 \([0]\) represents the \(x\)-coordinate vector, and every other row data1 \([i], i=1,…, n-1\), represents a \(y\)-coordinate set for a curve. Therefore matrix data1 \([i][j]\), \(i=0,…, n-1\), corresponds to \(n-1\) curves, all with the same \(x\)-coordinates.
However, one may want to plot several curves with different \(x\)-coordinates. In that case, one should give the curves as matrices with two rows. For examples, if the argument data is made of three 2-row matrices data1, data2 and data3, then they represents three different curves, data* \([0]\) being the \(x\)-coordinates, and data* \([1]\) the \(y\)-coordinates of the curves. 
| title | chart title. | 
| XLabel | Label on \(x\)-axis. | 
| YLabel | Label on \(y\)-axis. | 
| data | series of point sets. | 
| XYLineChart | ( | String | title, | 
| String | XLabel, | ||
| String | YLabel, | ||
| double | data[][], | ||
| int | numPoints | ||
| ) | 
Initializes a new XYLineChart instance with sets of points data. 
title is a title, XLabel is a short description of the \(x\)-axis, and YLabel a short description of the \(y\)-axis. If data is a \(n\)-row matrix, then the first row data \([0]\) represents the \(x\)-coordinate vector, and every other row data \([i], i=1,…, n-1\), represents a \(y\)-coordinate set of points. Therefore matrix data \([i][ ]\), \(i=0,…, n-1\), corresponds to \(n-1\) curves, all with the same \(x\)-coordinates. However, only the first numPoints of data will be considered to plot each curve. 
| title | chart title. | 
| XLabel | Label on \(x\)-axis. | 
| YLabel | Label on \(y\)-axis. | 
| data | series of point sets. | 
| numPoints | Number of points to plot | 
| XYLineChart | ( | String | title, | 
| String | XLabel, | ||
| String | YLabel, | ||
| double | data[][], | ||
| int | x, | ||
| int | y | ||
| ) | 
Initializes a new XYLineChart instance using subsets of data. 
data[x][.] will form the \(x\)-coordinates and data[y][.] will form the \(y\)-coordinates of the chart. title sets a title, XLabel is a short description of the \(x\)-axis, and YLabel is a short description of the \(y\)-axis. Warning: if the new \(x\)-axis coordinates are not monotone increasing, then they will automatically be sorted in increasing order so the points will be reordered, but the original data is not changed. 
| title | chart title. | 
| XLabel | Label on \(x\)-axis. | 
| YLabel | Label on \(y\)-axis. | 
| data | series of point sets. | 
| x | Index of data forming the \(x\)-coordinates | 
| y | Index of data forming the \(y\)-coordinates | 
| XYLineChart | ( | String | title, | 
| String | XLabel, | ||
| String | YLabel, | ||
| DoubleArrayList... | data | ||
| ) | 
Initializes a new XYLineChart instance with data data. 
The input parameter data represents a set of plotting data. A DoubleArrayList from the Colt library is used to store the data. The description is similar to the constructor YListChart with double[]... data. 
| title | chart title. | 
| XLabel | Label on \(x\)-axis. | 
| YLabel | Label on \(y\)-axis. | 
| data | series of point sets. | 
| XYLineChart | ( | String | title, | 
| String | XLabel, | ||
| String | YLabel, | ||
| XYSeriesCollection | data | ||
| ) | 
Initializes a new XYLineChart instance with data data. 
The input parameter data represents a set of plotting data. org.jfree.data.xy.XYSeriesCollection is a JFreeChart container class to store \(XY\) plots. 
| title | chart title. | 
| XLabel | Label on \(x\)-axis. | 
| YLabel | Label on \(y\)-axis. | 
| data | series collection. | 
| int add | ( | double [] | x, | 
| double [] | y, | ||
| String | name, | ||
| String | plotStyle | ||
| ) | 
Adds a data series into the series collection.
Vector x represents the \(x\)-coordinates and vector y represents the \(y\)-coordinates of the series. name and plotStyle are the name and the plot style associated to the series. 
| x | \(x_i\) coordinates. | 
| y | \(y_i\) coordinates. | 
| name | Name of the series. | 
| plotStyle | Plot style of the series. | 
XYSeriesCollection object. | int add | ( | double [] | x, | 
| double [] | y | ||
| ) | 
Adds a data series into the series collection.
Vector x represents the \(x\)-coordinates and vector y represents the \(y\)-coordinates of the series. 
| x | \(x_i\) coordinates. | 
| y | \(y_i\) coordinates. | 
XYSeriesCollection object. | int add | ( | double [] | x, | 
| double [] | y, | ||
| int | numPoints | ||
| ) | 
Adds a data series into the series collection.
Vector x represents the \(x\)-coordinates and vector y represents the \(y\)-coordinates of the series. Only the first numPoints of x and y will be taken into account for the new series. 
| x | \(x_i\) coordinates. | 
| y | \(y_i\) coordinates. | 
| numPoints | Number of points to add | 
XYSeriesCollection object. | int add | ( | double | data[][] | ) | 
Adds the new collection of data series data into the series collection. 
If data is a \(n\)-row matrix, then the first row data \([0]\) represents the \(x\)-coordinate vector, and every other row data \([i], i=1,…, n-1\), represents a \(y\)-coordinate set of points. Therefore matrix data \([i][ ]\), \(i=0,…, n-1\), corresponds to \(n-1\) curves, all with the same \(x\)-coordinates. 
| data | series of point sets. | 
| int add | ( | double | data[][], | 
| int | numPoints | ||
| ) | 
Adds the new collection of data series data into the series collection. 
If data is a \(n\)-row matrix, then the first row data \([0]\) represents the \(x\)-coordinate vector, and every other row data \([i], i=1,…, n-1\), represents a \(y\)-coordinate set of points. Therefore matrix data \([i][ ]\), \(i=0,…, n-1\), corresponds to \(n-1\) curves, all with the same \(x\)-coordinates. However, only the first numPoints of data will be taken into account for the new series. 
| data | series of point sets. | 
| numPoints | Number of points to plot | 
| XYListSeriesCollection getSeriesCollection | ( | ) | 
Returns the chart’s dataset.
| void setSeriesCollection | ( | XYListSeriesCollection | dataset | ) | 
Links a new dataset to the current chart.
| dataset | new dataset. | 
| void setTicksSynchro | ( | int | s | ) | 
Synchronizes \(X\)-axis ticks to the \(s\)-th series \(x\)-values.
| s | series used to define ticks. | 
| JFrame view | ( | int | width, | 
| int | height | ||
| ) | 
Displays chart on the screen using Swing.
This method creates an application containing a chart panel displaying the chart. The created frame is positioned on-screen, and displayed before it is returned. The width and the height of the chart are measured in pixels. 
| width | frame width in pixels. | 
| height | frame height in pixels. | 
;
| JFrame viewBar | ( | int | width, | 
| int | height | ||
| ) | 
Displays bar chart on the screen using Swing.
This method creates an application containing a bar chart panel displaying the chart. The created frame is positioned on-screen, and displayed before it is returned. The width and the height of the chart are measured in pixels. 
| width | frame width in pixels. | 
| height | frame height in pixels. | 
;
 1.8.14
 1.8.14