Package net.algart.math.functions

Class RectangularFunc

java.lang.Object

net.algart.math.functions.RectangularFunc

All Implemented Interfaces:

Func

public final class RectangularFunc
extends Object
implements Func

Absolute value function: f(x₀) = in if min<=x₀<=max and f(x₀) = out in other case, where min, max, in, out are parameters of this function. The get(double...) 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

Nested Class Summary

Nested classes/interfaces inherited from interface net.algart.math.functions.Func

Func.Updatable

Field Summary

Fields inherited from interface net.algart.math.functions.Func

ABS, ABS_DIFF, HALF_X_MINUS_Y, HALF_X_PLUS_Y, HALF_Y_MINUS_X, IDENTITY, MAX, MIN, POSITIVE_DIFF, REVERSE, SELECT, SELECT_FROM_8_DIRECTIONS_2D, SELECT_IF_GREATER, SELECT_IF_GREATER_OR_EQUAL, SHIFTS_ALONG_8_DIRECTIONS_2D, UPDATABLE_IDENTITY, X_MINUS_Y, X_PLUS_Y, Y_MINUS_X

Method Summary

Modifier and Type	Method	Description
double	get()	Equivalent to get(new double[0]).
double	get(double x0)	Equivalent to get(new double[] {x0}).
double	get(double... x)	Returns the result of this function for the given arguments: f(x0, x1, ..., xx.length-1).
double	get(double x0, double x1)	Equivalent to get(new double[] {x0, x1}).
double	get(double x0, double x1, double x2)	Equivalent to get(new double[] {x0, x1, x2}).
double	get(double x0, double x1, double x2, double x3)	Equivalent to get(new double[] {x0, x1, x2, x3}).
static RectangularFunc	getInstance(double min, double max, double in, double out)	Returns an instance of this class describing the rectangular function with the passed parameters.
static RectangularFunc	getInstance(Range range, double in, double out)	Returns an instance of this class describing the rectangular function with the following parameters: range.min(), range.max(), in, out.
double	in()	Returns the value, which is returned by this function inside min..max range.
double	out()	Returns the value, which is returned by this function outside min..max range.
Range	range()	Returns min..max range, inside which this function returns in value.
String	toString()	Returns a brief string description of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getInstance

public static RectangularFunc getInstance(Range range,
 double in,
 double out)

Returns an instance of this class describing the rectangular function with the following parameters: range.min(), range.max(), in, out. The get method of the function will return in if range.contains(x₀) and out otherwise.

Parameters:

range - the min and max parameters of this function.

in - the value returned inside the range.

out - the value returned outside the range.

Returns:

an instance of this class with the passed parameters.

Throws:

NullPointerException - if range is null.

getInstance

public static RectangularFunc getInstance(double min,
 double max,
 double in,
 double out)

Returns an instance of this class describing the rectangular function with the passed parameters. The get method of the function will return in if min<=x₀<=max and out otherwise.

Parameters:

min - the minimum number in the range, inclusive.

max - the maximum number in the range, inclusive.

in - the value returned inside the range.

out - the value returned outside the range.

Returns:

an instance of this class with the passed parameters.

Throws:

IllegalArgumentException - if min > max, min is NaN or max is NaN.

range

public Range range()

Returns min..max range, inside which this function returns in value.

Returns:

min..max range, specified while creating this instance.

in

public double in()

Returns the value, which is returned by this function inside min..max range.

Returns:

in value, specified while creating this instance.

out

public double out()

Returns the value, which is returned by this function outside min..max range.

Returns:

out value, specified while creating this instance.

get

public double get(double... x)

Description copied from interface: Func

Returns the result of this function for the given arguments: f(x₀, x₁, ..., x_x.length-1).

This method must not change the values of x elements!

Specified by:

get in interface Func

Parameters:

x - the function arguments.

Returns:

the function result.

get

public double get()

Description copied from interface: Func

Equivalent to get(new double[0]). Provides better performance because it does not require Java array creation.

Specified by:

get in interface Func

Returns:

the function result.

get

public double get(double x0)

Description copied from interface: Func

Equivalent to get(new double[] {x0}). Provides better performance because it does not require Java array creation.

Specified by:

get in interface Func

Parameters:

x0 - the function argument.

Returns:

the function result.

get

public double get(double x0,
 double x1)

Description copied from interface: Func

Equivalent to get(new double[] {x0, x1}). Provides better performance because it does not require Java array creation.

Specified by:

get in interface Func

Parameters:

x0 - the first function argument.

x1 - the second function argument.

Returns:

the function result.

get

public double get(double x0,
 double x1,
 double x2)

Description copied from interface: Func

Equivalent to get(new double[] {x0, x1, x2}). Provides better performance because it does not require Java array creation.

Specified by:

get in interface Func

Parameters:

x0 - the first function argument.

x1 - the second function argument.

x2 - the third function argument.

Returns:

the function result.

get

public double get(double x0,
 double x1,
 double x2,
 double x3)

Description copied from interface: Func

Equivalent to get(new double[] {x0, x1, x2, x3}). Provides better performance because it does not require Java array creation.

Specified by:

get in interface Func

Parameters:

x0 - the first function argument.

x1 - the second function argument.

x2 - the third function argument.

x3 - the fourth function argument.

Returns:

the function result.

toString

public String toString()

Returns a brief string description of this object.

Overrides:

toString in class Object

Returns:

a brief string description of this object.