//******************************************************************************
//
// File:    AggregateXYSeries.java
// Package: edu.rit.numeric
// Unit:    Class edu.rit.numeric.AggregateXYSeries
//
// This Java source file is copyright (C) 2007 by Alan Kaminsky. All rights
// reserved. For further information, contact the author, Alan Kaminsky, at
// ark@cs.rit.edu.
//
// This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
// software; you can redistribute it and/or modify it under the terms of the GNU
// General Public License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// PJ is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
// A PARTICULAR PURPOSE. See the GNU General Public License for more details.
//
// Linking this library statically or dynamically with other modules is making a
// combined work based on this library. Thus, the terms and conditions of the
// GNU General Public License cover the whole combination.
//
// As a special exception, the copyright holders of this library give you
// permission to link this library with independent modules to produce an
// executable, regardless of the license terms of these independent modules, and
// to copy and distribute the resulting executable under terms of your choice,
// provided that you also meet, for each linked independent module, the terms
// and conditions of the license of that module. An independent module is a
// module which is not derived from or based on this library. If you modify this
// library, you may extend this exception to your version of the library, but
// you are not obligated to do so. If you do not wish to do so, delete this
// exception statement from your version.
//
// A copy of the GNU General Public License is provided in the file gpl.txt. You
// may also obtain a copy of the GNU General Public License on the World Wide
// Web at http://www.gnu.org/licenses/gpl.html.
//
//******************************************************************************

package edu.rit.numeric;

/**
 * Class AggregateXYSeries provides an {@linkplain XYSeries} formed by
 * aggregating two {@linkplain Series} together.
 *
 * @author  Alan Kaminsky
 * @version 11-Jun-2007
 */
public class AggregateXYSeries
	extends XYSeries
	{

// Hidden data members.

	private Series myXSeries;
	private Series myYSeries;

// Exported constructors.

	/**
	 * Construct a new aggregate XY series. It is assumed that the <TT>x</TT>
	 * and <TT>y</TT> series are the same length.
	 * <P>
	 * <I>Note:</I> This series object stores <I>references</I> to <TT>x</TT>
	 * and <TT>y</TT>. Changing the contents of <TT>x</TT> or <TT>y</TT> will
	 * change the contents of this series.
	 *
	 * @param  x  Series of X values.
	 * @param  y  Series of Y values.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>x</TT> or <TT>y</TT> is null.
	 */
	public AggregateXYSeries
		(Series x,
		 Series y)
		{
		if (x == null || y == null)
			{
			throw new NullPointerException();
			}
		myXSeries = x;
		myYSeries = y;
		}

// Exported operations.

	/**
	 * Returns the number of values in this series.
	 *
	 * @return  Length.
	 */
	public int length()
		{
		return myXSeries.length();
		}

	/**
	 * Returns the given X value in this series.
	 *
	 * @param  i  Index.
	 *
	 * @return  The X value in this series at index <TT>i</TT>.
	 *
	 * @exception  ArrayIndexOutOfBoundsException
	 *     (unchecked exception) Thrown if <TT>i</TT> is not in the range
	 *     <TT>0</TT> .. <TT>length()-1</TT>.
	 */
	public double x
		(int i)
		{
		return myXSeries.x (i);
		}

	/**
	 * Returns the given Y value in this series.
	 *
	 * @param  i  Index.
	 *
	 * @return  The Y value in this series at index <TT>i</TT>.
	 *
	 * @exception  ArrayIndexOutOfBoundsException
	 *     (unchecked exception) Thrown if <TT>i</TT> is not in the range
	 *     <TT>0</TT> .. <TT>length()-1</TT>.
	 */
	public double y
		(int i)
		{
		return myYSeries.x (i);
		}

	}
