452 lines
12 KiB
Java
452 lines
12 KiB
Java
//******************************************************************************
|
|
//
|
|
// File: ListXYZSeries.java
|
|
// Package: edu.rit.numeric
|
|
// Unit: Class edu.rit.numeric.ListXYZSeries
|
|
//
|
|
// This Java source file is copyright (C) 2013 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 2 Library ("PJ2"). PJ2 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.
|
|
//
|
|
// PJ2 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.
|
|
//
|
|
// 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;
|
|
|
|
import java.io.Externalizable;
|
|
import java.io.IOException;
|
|
import java.io.ObjectInput;
|
|
import java.io.ObjectOutput;
|
|
|
|
import java.util.Scanner;
|
|
|
|
/**
|
|
* Class ListXYZSeries provides a series of (<I>x,y,z</I>) triples of real
|
|
* values (type <TT>double</TT>); the series is variable-length.
|
|
*
|
|
* @author Alan Kaminsky
|
|
* @version 22-Jul-2007
|
|
*/
|
|
public class ListXYZSeries
|
|
extends XYZSeries
|
|
implements Externalizable
|
|
{
|
|
|
|
// Hidden data members.
|
|
|
|
private static final long serialVersionUID = -6171759304132178882L;
|
|
|
|
private static final int INCR = 16;
|
|
|
|
private double[] xArray = new double [INCR];
|
|
private double[] yArray = new double [INCR];
|
|
private double[] zArray = new double [INCR];
|
|
private int myLength = 0;
|
|
|
|
// Exported constructors.
|
|
|
|
/**
|
|
* Construct a new zero-length XYZ series.
|
|
*/
|
|
public ListXYZSeries()
|
|
{
|
|
}
|
|
|
|
// Exported operations.
|
|
|
|
/**
|
|
* Returns the number of values in this series.
|
|
*
|
|
* @return Length.
|
|
*/
|
|
public int length()
|
|
{
|
|
return myLength;
|
|
}
|
|
|
|
/**
|
|
* 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)
|
|
{
|
|
if (0 > i || i >= myLength)
|
|
{
|
|
throw new ArrayIndexOutOfBoundsException
|
|
("ListXYZSeries.x(): Index = " + i + " out of bounds");
|
|
}
|
|
return xArray[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)
|
|
{
|
|
if (0 > i || i >= myLength)
|
|
{
|
|
throw new ArrayIndexOutOfBoundsException
|
|
("ListXYZSeries.y(): Index = " + i + " out of bounds");
|
|
}
|
|
return yArray[i];
|
|
}
|
|
|
|
/**
|
|
* Returns the given Z value in this series.
|
|
*
|
|
* @param i Index.
|
|
*
|
|
* @return The Z 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 z
|
|
(int i)
|
|
{
|
|
if (0 > i || i >= myLength)
|
|
{
|
|
throw new ArrayIndexOutOfBoundsException
|
|
("ListXYZSeries.z(): Index = " + i + " out of bounds");
|
|
}
|
|
return zArray[i];
|
|
}
|
|
|
|
/**
|
|
* Clear this series.
|
|
*
|
|
* @return This series.
|
|
*/
|
|
public ListXYZSeries clear()
|
|
{
|
|
myLength = 0;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Add the given data to this series.
|
|
*
|
|
* @param x X value.
|
|
* @param y Y value.
|
|
* @param z Z value.
|
|
*
|
|
* @return This series.
|
|
*/
|
|
public ListXYZSeries add
|
|
(double x,
|
|
double y,
|
|
double z)
|
|
{
|
|
allocate (1, INCR);
|
|
xArray[myLength] = x;
|
|
yArray[myLength] = y;
|
|
zArray[myLength] = z;
|
|
++ myLength;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Add the given data to this series. The data values are grouped into
|
|
* triples, where the first data value is the X value, the second data value
|
|
* is the Y value, and the third data value is the Z value. Each triple of
|
|
* data values is added to this series as though by the
|
|
* <TT>add(double,double,double)</TT> method. It is assumed that the number
|
|
* of data values is a multiple of 3.
|
|
*
|
|
* @param data Data values.
|
|
*
|
|
* @return This series.
|
|
*/
|
|
public ListXYZSeries add
|
|
(double... data)
|
|
{
|
|
int len = data.length / 3;
|
|
allocate (len, len);
|
|
for (int i = 0; i < len; ++ i)
|
|
{
|
|
xArray[myLength] = data[3*i];
|
|
yArray[myLength] = data[3*i+1];
|
|
zArray[myLength] = data[3*i+2];
|
|
++ myLength;
|
|
}
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Add the given data arrays to this series. Each element of <TT>x</TT>,
|
|
* <TT>y</TT>, and <TT>z</TT> is added to this series as though by the
|
|
* <TT>add(double,double,double)</TT> method. It is assumed that <TT>x</TT>,
|
|
* <TT>y</TT>, and <TT>z</TT> are the same length.
|
|
*
|
|
* @param x Array of X values.
|
|
* @param y Array of Y values.
|
|
* @param z Array of Z values.
|
|
*
|
|
* @return This series.
|
|
*
|
|
* @exception NullPointerException
|
|
* (unchecked exception) Thrown if <TT>x</TT>, <TT>y</TT>, or <TT>z</TT>
|
|
* is null.
|
|
*/
|
|
public ListXYZSeries add
|
|
(double[] x,
|
|
double[] y,
|
|
double[] z)
|
|
{
|
|
return add (x, y, z, 0, x.length);
|
|
}
|
|
|
|
/**
|
|
* Add a portion of the given data arrays to this series. Each element of
|
|
* <TT>x</TT>, <TT>y</TT>, and <TT>z</TT> from index <TT>off</TT> through
|
|
* index <TT>off+len-1</TT> inclusive is added to this series as though by
|
|
* the <TT>add(double,double,double)</TT> method.
|
|
*
|
|
* @param x Array of X values.
|
|
* @param y Array of Y values.
|
|
* @param z Array of Z values.
|
|
* @param off Index of first element to add.
|
|
* @param len Number of elements to add.
|
|
*
|
|
* @return This series.
|
|
*
|
|
* @exception NullPointerException
|
|
* (unchecked exception) Thrown if <TT>x</TT>, <TT>y</TT>, or <TT>z</TT>
|
|
* is null.
|
|
* @exception IndexOutOfBoundsException
|
|
* (unchecked exception) Thrown if <TT>off</TT> < 0, <TT>len</TT>
|
|
* < 0, <TT>off+len</TT> > <TT>x.length</TT>, <TT>off+len</TT>
|
|
* > <TT>y.length</TT>, or <TT>off+len</TT> > <TT>z.length</TT>.
|
|
*/
|
|
public ListXYZSeries add
|
|
(double[] x,
|
|
double[] y,
|
|
double[] z,
|
|
int off,
|
|
int len)
|
|
{
|
|
if (off < 0 || len < 0 || off + len > x.length ||
|
|
off + len > y.length || off + len > z.length)
|
|
{
|
|
throw new IndexOutOfBoundsException();
|
|
}
|
|
if (myLength + len > xArray.length)
|
|
{
|
|
double[] newxArray = new double [myLength + len];
|
|
System.arraycopy (xArray, 0, newxArray, 0, myLength);
|
|
xArray = newxArray;
|
|
double[] newyArray = new double [myLength + len];
|
|
System.arraycopy (yArray, 0, newyArray, 0, myLength);
|
|
yArray = newyArray;
|
|
double[] newzArray = new double [myLength + len];
|
|
System.arraycopy (zArray, 0, newzArray, 0, myLength);
|
|
zArray = newzArray;
|
|
}
|
|
System.arraycopy (x, off, xArray, myLength, len);
|
|
System.arraycopy (y, off, yArray, myLength, len);
|
|
System.arraycopy (z, off, zArray, myLength, len);
|
|
myLength += len;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Add the given {@linkplain XYZSeries} to this series. Each corresponding
|
|
* X, Y, and Z value in the given X-Y-Z series is added to this series as
|
|
* though by the <TT>add(double,double,double)</TT> method.
|
|
*
|
|
* @param theSeries X-Y-Z series.
|
|
*
|
|
* @return This series.
|
|
*
|
|
* @exception NullPointerException
|
|
* (unchecked exception) Thrown if <TT>theSeries</TT> is null.
|
|
*/
|
|
public ListXYZSeries add
|
|
(XYZSeries theSeries)
|
|
{
|
|
return add (theSeries, 0, theSeries.length());
|
|
}
|
|
|
|
/**
|
|
* Add a portion of the given {@linkplain XYZSeries} to this series. Each
|
|
* corresponding X, Y, and Z value in the given X-Y-Z series from index
|
|
* <TT>off</TT> through index <TT>off+len-1</TT> inclusive is added to this
|
|
* series as though by the <TT>add(double,double,double)</TT> method.
|
|
*
|
|
* @param theSeries X-Y-Z series.
|
|
* @param off Index of first element to add.
|
|
* @param len Number of elements to add.
|
|
*
|
|
* @return This series.
|
|
*
|
|
* @exception NullPointerException
|
|
* (unchecked exception) Thrown if <TT>theSeries</TT> is null.
|
|
* @exception IndexOutOfBoundsException
|
|
* (unchecked exception) Thrown if <TT>off</TT> < 0, <TT>len</TT>
|
|
* < 0, or <TT>off+len</TT> > <TT>theSeries.length()</TT>.
|
|
*/
|
|
public ListXYZSeries add
|
|
(XYZSeries theSeries,
|
|
int off,
|
|
int len)
|
|
{
|
|
if (off < 0 || len < 0 || off + len > theSeries.length())
|
|
{
|
|
throw new IndexOutOfBoundsException();
|
|
}
|
|
allocate (len, len);
|
|
while (len > 0)
|
|
{
|
|
xArray[myLength] = theSeries.x (off);
|
|
yArray[myLength] = theSeries.y (off);
|
|
zArray[myLength] = theSeries.z (off);
|
|
++ myLength;
|
|
++ off;
|
|
-- len;
|
|
}
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Add data read from the given scanner to this series. Double values are
|
|
* read from the scanner until there are no more. Each triple of consecutive
|
|
* double values is added to this series as though by the
|
|
* <TT>add(double,double,double)</TT> method. Any leftover double values are
|
|
* discarded. The <TT>add()</TT> method does <I>not</I> close the scanner
|
|
* when finished.
|
|
* <P>
|
|
* To read data from a file, pass a scanner constructed on top of the file;
|
|
* to read data from an input stream, pass a scanner constructed on top of
|
|
* the input stream; and so on.
|
|
*
|
|
* @param scanner Scanner.
|
|
*
|
|
* @return This series.
|
|
*
|
|
* @exception NullPointerException
|
|
* (unchecked exception) Thrown if <TT>scanner</TT> is null.
|
|
*/
|
|
public ListXYZSeries add
|
|
(Scanner scanner)
|
|
{
|
|
while (scanner.hasNextDouble())
|
|
{
|
|
double x = scanner.nextDouble();
|
|
if (scanner.hasNextDouble())
|
|
{
|
|
double y = scanner.nextDouble();
|
|
if (scanner.hasNextDouble())
|
|
{
|
|
double z = scanner.nextDouble();
|
|
add (x, y, z);
|
|
}
|
|
}
|
|
}
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Write this series to the given object output stream.
|
|
*
|
|
* @param out Object output stream.
|
|
*
|
|
* @exception IOException
|
|
* Thrown if an I/O error occurred.
|
|
*/
|
|
public void writeExternal
|
|
(ObjectOutput out)
|
|
throws IOException
|
|
{
|
|
int n = myLength;
|
|
out.writeInt (n);
|
|
for (int i = 0; i < n; ++ i)
|
|
{
|
|
out.writeDouble (xArray[i]);
|
|
out.writeDouble (yArray[i]);
|
|
out.writeDouble (zArray[i]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Read this series from the given object input stream.
|
|
*
|
|
* @param in Object input stream.
|
|
*
|
|
* @exception IOException
|
|
* Thrown if an I/O error occurred.
|
|
*/
|
|
public void readExternal
|
|
(ObjectInput in)
|
|
throws IOException
|
|
{
|
|
int n = in.readInt();
|
|
xArray = new double [n];
|
|
yArray = new double [n];
|
|
zArray = new double [n];
|
|
myLength = n;
|
|
for (int i = 0; i < n; ++ i)
|
|
{
|
|
xArray[i] = in.readDouble();
|
|
yArray[i] = in.readDouble();
|
|
zArray[i] = in.readDouble();
|
|
}
|
|
}
|
|
|
|
// Hidden operations.
|
|
|
|
/**
|
|
* Increase the storage allocation for this list XYZ series if necessary.
|
|
*
|
|
* @param len Number of items to be added.
|
|
* @param incr Amount to increase allocation.
|
|
*/
|
|
private void allocate
|
|
(int len,
|
|
int incr)
|
|
{
|
|
if (myLength + len > xArray.length)
|
|
{
|
|
double[] newxArray = new double [myLength + incr];
|
|
System.arraycopy (xArray, 0, newxArray, 0, myLength);
|
|
xArray = newxArray;
|
|
double[] newyArray = new double [myLength + incr];
|
|
System.arraycopy (yArray, 0, newyArray, 0, myLength);
|
|
yArray = newyArray;
|
|
double[] newzArray = new double [myLength + incr];
|
|
System.arraycopy (zArray, 0, newzArray, 0, myLength);
|
|
zArray = newzArray;
|
|
}
|
|
}
|
|
|
|
}
|