1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
|
//******************************************************************************
//
// File: SampledXYSeries.java
// Package: edu.rit.numeric
// Unit: Class edu.rit.numeric.SampledXYSeries
//
// 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 SampledXYSeries provides a series of (<I>x,y</I>) pairs of real values
* (type <TT>double</TT>) where the Y values are computed by sampling a
* {@linkplain Function} for a series of X values.
* <P>
* Class SampledXYSeries is implemented to minimize space rather than time. Each
* time <TT>x()</TT> is called, the <I>x</I> value is computed anew. Each time
* <TT>y()</TT> is called, the <I>x</I> value is computed anew, then the
* <I>y</I> value is computed anew by evaluating the function at <I>x</I>.
*
* @author Alan Kaminsky
* @version 06-Jul-2007
*/
public class SampledXYSeries
extends XYSeries
{
// Hidden data members.
private Function myFunction;
private double myXinit;
private double myDelta;
private int myLength;
// Exported constructors.
/**
* Construct a new sampled series sampling values of the given function. The
* <I>y</I> values at indexes 0, 1, 2, ... <TT>len-1</TT> are computed by
* evaluating <TT>theFunction</TT> at the <I>x</I> values <TT>xinit</TT>,
* <TT>xinit+delta</TT>, <TT>xinit+2*delta</TT>, ...
* <TT>xinit+(len-1)*delta</TT>.
*
* @param theFunction Function to sample.
* @param xinit Initial <I>x</I> value.
* @param delta Difference between successive <I>x</I> values.
* @param len Length (number of (<I>x,y</I>) pairs).
*
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>theFunction</TT> is null.
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>len</TT> is less than 0.
*/
public SampledXYSeries
(Function theFunction,
double xinit,
double delta,
int len)
{
super();
if (theFunction == null)
{
throw new NullPointerException
("SampledXYSeries(): theFunction is null");
}
if (len < 0)
{
throw new IllegalArgumentException
("SampledXYSeries(): len = " + len + " illegal");
}
myFunction = theFunction;
myXinit = xinit;
myDelta = delta;
myLength = len;
}
// 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)
{
return myXinit + i * myDelta;
}
/**
* 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 myFunction.f (x (i));
}
}
|