File: ParameterizedFunction.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 (83 lines) | stat: -rw-r--r-- 3,245 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
//******************************************************************************
//
// File:    ParameterizedFunction.java
// Package: edu.rit.numeric
// Unit:    Interface edu.rit.numeric.ParameterizedFunction
//
// 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;

/**
 * Interface ParameterizedFunction specifies the interface for a real-valued
 * function of a real-valued argument, with additional parameters.
 *
 * @author  Alan Kaminsky
 * @version 06-Oct-2010
 */
public interface ParameterizedFunction
	{

// Exported operations.

	/**
	 * Returns the number of parameters, <I>M</I>.
	 *
	 * @return  Number of parameters.
	 */
	public int parameterLength();

	/**
	 * Returns the value of this function evaluated at the given argument, using
	 * the given parameters.
	 *
	 * @param  x  Argument.
	 * @param  p  Array of <I>M</I> parameters.
	 *
	 * @return  <I>f</I> (<I>x</I>, parameters).
	 *
	 * @exception  DomainException
	 *     (unchecked exception) Thrown if the argument <TT>x</TT> or any
	 *     parameter in <TT>p</TT> is outside the allowed set of values for this
	 *     function.
	 * @exception  RangeException
	 *     (unchecked exception) Thrown if the result is outside the range of
	 *     type <TT>double</TT>.
	 */
	public double f
		(double x,
		 double[] p);

	}