edu.rit.numeric

Class AggregateXYZSeries

java.lang.Object

edu.rit.numeric.XYZSeries

edu.rit.numeric.AggregateXYZSeries

public class AggregateXYZSeries
extends XYZSeries

Class AggregateXYZSeries provides an XYZSeries formed by aggregating three Series together.

Nested Class Summary

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

XYZSeries.Regression

Constructor Summary

Constructors

Constructor and Description
AggregateXYZSeries(Series x, Series y, Series z) Construct a new aggregate XYZ series.

Method Summary

Modifier and Type	Method and Description
int	length() Returns the number of values in this series.
double	x(int i) Returns the given X value in this series.
double	y(int i) Returns the given Y value in this series.
double	z(int i) Returns the given Z value in this series.

Methods inherited from class edu.rit.numeric.XYZSeries

isEmpty, linearRegression, maxX, maxY, maxZ, minX, minY, minZ, print, print, print, xSeries, xySeries, ySeries, zSeries

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateXYZSeries

public AggregateXYZSeries(Series x,
                          Series y,
                          Series z)

Construct a new aggregate XYZ series. It is assumed that the x, y, and z series are the same length.

Note: This series object stores references to x, y, and z. Changing the contents of x, y, or z will change the contents of this series.

Parameters:

x - Series of X values.

y - Series of Y values.

z - Series of Z values.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if x, y, or z is null.

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.