edu.rit.numeric

Class ArrayXYZSeries

java.lang.Object

edu.rit.numeric.XYZSeries

edu.rit.numeric.ArrayXYZSeries

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class ArrayXYZSeries
extends XYZSeries
implements java.io.Externalizable

Class ArrayXYZSeries provides an XYZSeries view of values stored in arrays. Changing the contents of the arrays will change the ArrayXYZSeries.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.rit.numeric.XYZSeries

XYZSeries.Regression

Constructor Summary

Constructors

Constructor and Description
ArrayXYZSeries() Construct a new uninitialized array X-Y-Z series.
ArrayXYZSeries(double[] xarray, double[] yarray, double[] zarray) Construct a new array X-Y-Z series.

Method Summary

Modifier and Type	Method and Description
int	length() Returns the number of values in this series.
void	readExternal(java.io.ObjectInput in) Read this X-Y-Z series from the given object input stream.
void	writeExternal(java.io.ObjectOutput out) Write this X-Y-Z series to the given object output stream.
double	x(int i) Returns the given X value in this series.
Series	xSeries() Returns a Series view of the X values in this XYZ series.
double	y(int i) Returns the given Y value in this series.
Series	ySeries() Returns a Series view of the Y values in this XYZ series.
double	z(int i) Returns the given Z value in this series.
Series	zSeries() Returns a Series view of the Z values in this XY series.

Methods inherited from class edu.rit.numeric.XYZSeries

isEmpty, linearRegression, maxX, maxY, maxZ, minX, minY, minZ, print, print, print, xySeries

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayXYZSeries

public ArrayXYZSeries()

Construct a new uninitialized array X-Y-Z series. This constructor is for use only by object deserialization.

ArrayXYZSeries

public ArrayXYZSeries(double[] xarray,
                      double[] yarray,
                      double[] zarray)

Construct a new array X-Y-Z series.

Parameters:

xarray - Array of X values.

yarray - Array of Y values.

zarray - Array of Z values.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if xarray is null, yarray is null, or zarray is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if xarray, yarray, and zarray are not the same length.

Method Detail

length

public int length()

Returns the number of values in this series.

Specified by:

length in class XYZSeries

Returns:

Length.

x

public double x(int i)

Returns the given X value in this series.

Specified by:

x in class XYZSeries

Parameters:

i - Index.

Returns:

The X value in this series at index i.

Throws:

java.lang.ArrayIndexOutOfBoundsException - (unchecked exception) Thrown if i is not in the range 0 .. length()-1.

y

public double y(int i)

Returns the given Y value in this series.

Specified by:

y in class XYZSeries

Parameters:

i - Index.

Returns:

The Y value in this series at index i.

Throws:

java.lang.ArrayIndexOutOfBoundsException - (unchecked exception) Thrown if i is not in the range 0 .. length()-1.

z

public double z(int i)

Returns the given Z value in this series.

Specified by:

z in class XYZSeries

Parameters:

i - Index.

Returns:

The Z value in this series at index i.

Throws:

java.lang.ArrayIndexOutOfBoundsException - (unchecked exception) Thrown if i is not in the range 0 .. length()-1.

xSeries

public Series xSeries()

Returns a Series view of the X values in this XYZ series.

Note: The returned Series object is backed by this XYZ series object. Changing the contents of this XYZ series object will change the contents of the returned Series object.

Overrides:

xSeries in class XYZSeries

Returns:

Series of X values.

ySeries

public Series ySeries()

Returns a Series view of the Y values in this XYZ series.

Note: The returned Series object is backed by this XYZ series object. Changing the contents of this XYZ series object will change the contents of the returned Series object.

Overrides:

ySeries in class XYZSeries

Returns:

Series of Y values.

zSeries

public Series zSeries()

Returns a Series view of the Z values in this XY series.

Note: The returned Series object is backed by this XYZ series object. Changing the contents of this XYZ series object will change the contents of the returned Series object.

Overrides:

zSeries in class XYZSeries

Returns:

Series of Z values.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Write this X-Y-Z series to the given object output stream.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - Object output stream.

Throws:

java.io.IOException - Thrown if an I/O error occurred.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException

Read this X-Y-Z series from the given object input stream.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - Object input stream.

Throws:

java.io.IOException - Thrown if an I/O error occurred.