Overview  Package   Class  Tree  Deprecated  Index  Help 
AlgART Home
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.algart.math.functions
Class LinearFunc.Updatable

java.lang.Object
  extended by net.algart.math.functions.LinearFunc
      extended by net.algart.math.functions.LinearFunc.Updatable
All Implemented Interfaces:
Func, Func.Updatable
Enclosing class:
LinearFunc
public static class LinearFunc.Updatable
extends LinearFunc
implements Func.Updatable

Updatable extension of the linear function with one argument.

Nested Class Summary
Modifier and Type Class and Description
 
Nested classes/interfaces inherited from class net.algart.math.functions.LinearFunc
LinearFunc.Updatable
 
Nested classes/interfaces inherited from interface net.algart.math.functions.Func
Func.Updatable
 
Field Summary
Modifier and Type Field and Description
 
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 and Description
 double get()
          Equivalent to get(new double[0]).
 double get(double... x)
          Returns the result of this function for the given arguments: f(x0, x1, ..., xx.length-1).
 double get(double x0)
          Equivalent to get(new double[] {x0}).
 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}).
 void set(double[] x, double newResult)
          Correct some of x arguments so that get(x) will be, as possible, equal to newResult.
 
Methods inherited from class net.algart.math.functions.LinearFunc
a, a, b, getAveragingInstance, getInstance, getInstance, getNonweightedInstance, getUpdatableInstance, isNonweighted, n, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

get

public double get(double... x)
Description copied from interface: Func
Returns the result of this function for the given arguments: f(x0, x1, ..., xx.length-1).

This method must not change the values of x elements!

Specified by:
get in interface Func
Specified by:
get in class LinearFunc
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
Specified by:
get in class LinearFunc
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
Specified by:
get in class LinearFunc
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
Specified by:
get in class LinearFunc
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
Specified by:
get in class LinearFunc
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
Specified by:
get in class LinearFunc
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.

set

public void set(double[] x,
                double newResult)
Description copied from interface: Func.Updatable
Correct some of x arguments so that get(x) will be, as possible, equal to newResult. For example, if this is one-argument function f(x), and its inverse function is g(y) (g(f(x))=x), then this method should assign x[0]=g(newResult).

This method does not guarantee the precise equality get(x)==newResult. (Usually, it is impossible due to limited precision of floating-point calculations.) But this method should try to provide this equality (after its call) with, as possible, maximal possible precision.

Specified by:
set in interface Func.Updatable
Parameters:
x - the function arguments.
newResult - the desired function result.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD