- All Known Implementing Classes:
BezierPolynomial
,BicubicInterpolator
,BicubicTriangleInterp
,BSpline
,BSplineArray
,CubicBezierSpline1
,CubicSpline
,CubicSpline1
,CubicSpline2
,LeastSquaresFit
,LeastSquaresFit.BSpline
,LeastSquaresFit.FunctionBasis
,LeastSquaresFit.Linear
,LeastSquaresFit.NonLinear
,LeastSquaresFit.Polynomial
,NurbsArray
,Polynomial
,RealValuedFunction
,RealValuedFunctionThree
,RealValuedFunctionTwo
,RealValuedFunctionVA
,RealValuedFunctionVA.Linear
,VectorValuedFunction
,VectorValuedFunctionVA
public interface VADomainOps
Operations for function domains when there is a variable number of
arguments.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
domainMaxClosed
(int argIndex) Determine if the domain maximum for the ith argument, when the arguments are in the domain of the function, is in the function's domain.boolean
domainMinClosed
(int argIndex) Determine if the domain minimum for the ith argument, when the arguments are in the domain of the function, is in the function's domain.double
getDomainMax
(int argIndex) Get the least upper bound of the ith argument when the arguments are in the domain of the function.double
getDomainMin
(int argIndex) Get the greatest lower bound of the ith argument when the arguments are in the domain of the function implementing this interface.boolean
isInDomain
(double... args) Determine if a sequence of arguments represents arguments that are in the domain of the function implementing this interface.int
Get the maximum number of arguments allowed in calls to methods whose arguments are in the domain of a function implementing this interface.int
Get the minimum number of arguments allowed in calls to methods whose arguments are in the domain of a function implementing this interface.
-
Method Details
-
minArgLength
int minArgLength()Get the minimum number of arguments allowed in calls to methods whose arguments are in the domain of a function implementing this interface. A subclass must not return a value less than 1.- Returns:
- the minimum number of arguments
-
maxArgLength
int maxArgLength()Get the maximum number of arguments allowed in calls to methods whose arguments are in the domain of a function implementing this interface.- Returns:
- the maximum number of arguments
-
getDomainMin
Get the greatest lower bound of the ith argument when the arguments are in the domain of the function implementing this interface.- Parameters:
argIndex
- the index determining the argument for which this method applies (0th, 1st, ...)- Returns:
- the minimum value
- Throws:
IllegalArgumentException
- the argument is out of rangeIllegalStateException
- the function was not fully initialized.
-
getDomainMax
Get the least upper bound of the ith argument when the arguments are in the domain of the function.- Parameters:
argIndex
- the index determining the argument for which this method applies (0th, 1st, ...)- Returns:
- the maximum value
- Throws:
IllegalArgumentException
- the argument is out of rangeIllegalStateException
- the function was not fully initialized.
-
domainMinClosed
Determine if the domain minimum for the ith argument, when the arguments are in the domain of the function, is in the function's domain.- Parameters:
argIndex
- the index determining the argument for which this method applies (0th, 1st, ...)- Returns:
- true if the domain minimum is in the domain; false if it is the greatest lower bound for the domain
- Throws:
IllegalArgumentException
- the argument is out of rangeIllegalStateException
- the function was not fully initialized.
-
domainMaxClosed
Determine if the domain maximum for the ith argument, when the arguments are in the domain of the function, is in the function's domain.- Parameters:
argIndex
- the index determining the argument for which this method applies (0th, 1st, ...)- Returns:
- true if the domain maximum is in the domain; false if it is the least upper bound for the domain
- Throws:
IllegalArgumentException
- the argument is out of rangeIllegalStateException
- the function was not fully initialized.
-
isInDomain
boolean isInDomain(double... args) throws UnsupportedOperationException, IllegalArgumentException, IllegalStateException Determine if a sequence of arguments represents arguments that are in the domain of the function implementing this interface.- Parameters:
args
- the arguments (x0,x1,...) giving the coordinates of a point- Returns:
- true if the point (x0,x1,...) is in this function's domain; false otherwise
- Throws:
UnsupportedOperationException
- domain membership could not be determined.IllegalArgumentException
- an argument is out of rangeIllegalStateException
- the function was not fully initialized.
-