Package net.algart.math.functions

Class WeightedMeanFunc

java.lang.Object

net.algart.math.functions.WeightedMeanFunc

All Implemented Interfaces:

Func

public final class WeightedMeanFunc
extends Object
implements Func

Weighted mean of 2 numbers: f(x₀, x₁, x₂) = scale*x₀x₁ + (1-scale*x₀)x₂, where scale is a constant, passed to getInstance(double) method. The get(double...) method of the instance of this class requires at least 3 arguments and throws IndexOutOfBoundsException if the number of arguments is 0, 1 or 2.

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 WeightedMeanFunc	getInstance(double scale)	Returns an instance of this class.
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 WeightedMeanFunc getInstance(double scale)

Returns an instance of this class.

Parameters:

scale - the scale for the weight.

Returns:

an instance of this class.

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.