Class FiniteDifferencePlotData2D

java.lang.Object

net.finmath.finitedifference.utilities.FiniteDifferencePlotData2D

public final class FiniteDifferencePlotData2D
extends Object

Dependency-free plot descriptor for a two-dimensional finite-difference surface.

The descriptor is compatible with plotting tools that consume a DoubleBinaryOperator, for example external plot extensions, without requiring this module to depend on those plotting libraries.

Author:

Alessandro Gnoatto

Constructor Summary

Constructors

Constructor	Description
FiniteDifferencePlotData2D(double xMin, double xMax, double yMin, double yMax, int numberOfPointsX, int numberOfPointsY, DoubleBinaryOperator function, String title, String xAxisLabel, String yAxisLabel, String zAxisLabel)	Creates a two-dimensional plot descriptor.

Method Summary

Modifier and Type	Method	Description
DoubleBinaryOperator	getFunction()	Returns the value.
int	getNumberOfPointsX()	Returns the value.
int	getNumberOfPointsY()	Returns the value.
String	getTitle()	Returns the value.
String	getXAxisLabel()	Returns the value.
double	getXMax()	Returns the value.
double	getXMin()	Returns the value.
String	getYAxisLabel()	Returns the value.
double	getYMax()	Returns the value.
double	getYMin()	Returns the value.
String	getZAxisLabel()	Returns the value.

Methods inherited from class Object

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

Constructor Details

FiniteDifferencePlotData2D

public FiniteDifferencePlotData2D(double xMin,
 double xMax,
 double yMin,
 double yMax,
 int numberOfPointsX,
 int numberOfPointsY,
 DoubleBinaryOperator function,
 String title,
 String xAxisLabel,
 String yAxisLabel,
 String zAxisLabel)

Creates a two-dimensional plot descriptor.

Parameters:

xMin - The lower x-axis bound.

xMax - The upper x-axis bound.

yMin - The lower y-axis bound.

yMax - The upper y-axis bound.

numberOfPointsX - The number of plot points in the x direction.

numberOfPointsY - The number of plot points in the y direction.

function - The function to plot.

title - The plot title.

xAxisLabel - The x-axis label.

yAxisLabel - The y-axis label.

zAxisLabel - The z-axis label.

Method Details

getXMin

public double getXMin()

Returns the value.

Returns:

The value.

getXMax

public double getXMax()

Returns the value.

Returns:

The value.

getYMin

public double getYMin()

Returns the value.

Returns:

The value.

getYMax

public double getYMax()

Returns the value.

Returns:

The value.

getNumberOfPointsX

public int getNumberOfPointsX()

Returns the value.

Returns:

The value.

getNumberOfPointsY

public int getNumberOfPointsY()

Returns the value.

Returns:

The value.

getFunction

public DoubleBinaryOperator getFunction()

Returns the value.

Returns:

The value.

getTitle

public String getTitle()

Returns the value.

Returns:

The value.

getXAxisLabel

public String getXAxisLabel()

Returns the value.

Returns:

The value.

getYAxisLabel

public String getYAxisLabel()

Returns the value.

Returns:

The value.

getZAxisLabel

public String getZAxisLabel()

Returns the value.

Returns:

The value.