net.algart.math.functions.RectangularFunc Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of algart Show documentation
Show all versions of algart Show documentation
Open-source Java libraries, supporting generalized smart arrays and matrices with elements
of any types, including a wide set of 2D-, 3D- and multidimensional image processing
and other algorithms, working with arrays and matrices.
/*
* The MIT License (MIT)
*
* Copyright (c) 2007-2024 Daniel Alievsky, AlgART Laboratory (http://algart.net)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.algart.math.functions;
import net.algart.math.Range;
/**
* Absolute value function:
* f(x0) = in
* if min<=x0<=max and
* f(x0) = out
* in other case, where min, max, in, out
* are parameters of this function.
* The {@link #get} method of the instance of this class requires at least 1 argument
* and throws IndexOutOfBoundsException if the number of arguments is 0.
*
* This class is immutable and thread-safe:
* there are no ways to modify settings of the created instance.
*
* @author Daniel Alievsky
*/
public final class RectangularFunc implements Func {
final Range range;
final double min;
final double max;
final double in;
final double out;
private RectangularFunc(Range range, double in, double out) {
this.range = range;
this.min = range.min();
this.max = range.max();
this.in = in;
this.out = out;
}
/**
* Returns an instance of this class describing the rectangular function with the following parameters:
* range.{@link Range#min() min()},
* range.{@link Range#max() max()},
* in, out.
* The {@link #get get} method of the function will return in if
* range.{@link Range#contains(double) contains}(x0)
* and out otherwise.
*
* @param range the min and max parameters of this function.
* @param in the value returned inside the range.
* @param out the value returned outside the range.
* @return an instance of this class with the passed parameters.
* @throws NullPointerException if range is {@code null}.
*/
public static RectangularFunc getInstance(Range range, double in, double out) {
return new RectangularFunc(range, in, out);
}
/**
* Returns an instance of this class describing the rectangular function with the passed parameters.
* The {@link #get get} method of the function will return in if
* min<=x0<=max
* and out otherwise.
*
* @param min the minimum number in the range, inclusive.
* @param max the maximum number in the range, inclusive.
* @param in the value returned inside the range.
* @param out the value returned outside the range.
* @return an instance of this class with the passed parameters.
* @throws IllegalArgumentException if min > max, min is NaN or
* max is NaN.
*/
public static RectangularFunc getInstance(double min, double max, double in, double out) {
return new RectangularFunc(Range.valueOf(min, max), in, out);
}
/**
* Returns min..max range, inside which this function returns in value.
*
* @return min..max range, specified while creating this instance.
*/
public Range range() {
return this.range;
}
/**
* Returns the value, which is returned by this function inside min..max range.
*
* @return in value, specified while creating this instance.
*/
public double in() {
return this.in;
}
/**
* Returns the value, which is returned by this function outside min..max range.
*
* @return out value, specified while creating this instance.
*/
public double out() {
return this.out;
}
public double get(double... x) {
return x[0] >= min && x[0] <= max ? in : out;
}
public double get() {
throw new IndexOutOfBoundsException("At least 1 argument required");
}
public double get(double x0) {
return x0 >= min && x0 <= max ? in : out;
}
public double get(double x0, double x1) {
return x0 >= min && x0 <= max ? in : out;
}
public double get(double x0, double x1, double x2) {
return x0 >= min && x0 <= max ? in : out;
}
public double get(double x0, double x1, double x2, double x3) {
return x0 >= min && x0 <= max ? in : out;
}
/**
* Returns a brief string description of this object.
*
* @return a brief string description of this object.
*/
public String toString() {
return "rectangular function f(x)=" + min + "<=x<=" + max + "?" + in + ":" + out;
}
}