File: TransformedXYZSeries.java

package info (click to toggle)
libpj-java 0.0~20150107%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 13,396 kB
  • sloc: java: 99,543; ansic: 987; sh: 153; xml: 26; makefile: 10; sed: 4
file content (169 lines) | stat: -rw-r--r-- 5,688 bytes parent folder | download | duplicates (2)
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
//******************************************************************************
//
// File:    TransformedXYZSeries.java
// Package: edu.rit.numeric
// Unit:    Class edu.rit.numeric.TransformedXYZSeries
//
// 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 TransformedXYZSeries provides an {@linkplain XYZSeries} that is formed
 * by transforming the values in an underlying {@linkplain XYZSeries}. The
 * underlying series consists of a list of triples
 * (<I>x</I><SUB><I>i</I></SUB>,&nbsp;<I>y</I><SUB><I>i</I></SUB>,&nbsp;<I>z</I><SUB><I>i</I></SUB>).
 * The transformed series consists of a list of triples
 * (<I>f</I><SUB>1</SUB>(<I>x</I><SUB><I>i</I></SUB>),&nbsp;<I>f</I><SUB>2</SUB>(<I>y</I><SUB><I>i</I></SUB>),&nbsp;<I>f</I><SUB>3</SUB>(<I>z</I><SUB><I>i</I></SUB>)),
 * where each of <I>f</I><SUB>1</SUB>, <I>f</I><SUB>2</SUB>, and
 * <I>f</I><SUB>3</SUB> is computed by a {@link Function </CODE>Function<CODE>}.
 *
 * @author  Alan Kaminsky
 * @version 27-Jul-2007
 */
public class TransformedXYZSeries
	extends XYZSeries
	{

// Hidden data members.

	private XYZSeries mySeries;
	private Function myXFunction;
	private Function myYFunction;
	private Function myZFunction;

// Exported constructors.

	/**
	 * Construct a new transformed X-Y-Z series.
	 *
	 * @param  theSeries     Underlying X-Y-Z series.
	 * @param  theXFunction  Function for transforming the X values, or null not
	 *                       to transform the X values.
	 * @param  theYFunction  Function for transforming the Y values, or null not
	 *                       to transform the Y values.
	 * @param  theZFunction  Function for transforming the Z values, or null not
	 *                       to transform the Z values.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>theSeries</TT> is null.
	 */
	public TransformedXYZSeries
		(XYZSeries theSeries,
		 Function theXFunction,
		 Function theYFunction,
		 Function theZFunction)
		{
		if (theSeries == null)
			{
			throw new NullPointerException
				("TransformedXYZSeries(): theSeries is null");
			}
		mySeries = theSeries;
		myXFunction = theXFunction;
		myYFunction = theYFunction;
		myZFunction = theZFunction;
		}

// Exported operations.

	/**
	 * Returns the number of values in this series.
	 *
	 * @return  Length.
	 */
	public int length()
		{
		return mySeries.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)
		{
		double xval = mySeries.x(i);
		if (myXFunction != null) xval = myXFunction.f (xval);
		return xval;
		}

	/**
	 * 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)
		{
		double yval = mySeries.y(i);
		if (myYFunction != null) yval = myYFunction.f (yval);
		return yval;
		}

	/**
	 * 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)
		{
		double zval = mySeries.z(i);
		if (myZFunction != null) zval = myZFunction.f (zval);
		return zval;
		}

	}