cz.cuni.jagrlib.iface
Interface RealFunction

All Superinterfaces:
Property
All Known Implementing Classes:
DefaultRealFunction, FunctionSamples, ImageCompare, ImageTransition.CutoffTransition, ImageTransition.LinearTransition, ImageTransition.RampField, ImageTransition.RandomField, ImageTransition.SigmaTransition, SimpleNoise

public interface RealFunction
extends Property

General mappings to scalar R range.

See Also:
RealFunction.java

Field Summary
static java.lang.String AMPLITUDE
          Property name: amplitude.
static java.lang.String FREQUENCY
          Property name: global frequency.
static java.lang.String FREQUENCY_X
          Property name: frequency in the X coordinate.
static java.lang.String FREQUENCY_Y
          Property name: frequency in the Y coordinate.
static java.lang.String VARIATION
          Property name: variation of the function (used in noise functions).
 
Fields inherited from interface cz.cuni.jagrlib.iface.Property
LOGGING, STATISTICS, TEXT_DESCRIPTION
 
Method Summary
 double df(double x)
          Compute erivative: df(x)/dx.
 boolean df(double[] arg, double[] d)
          Compute partial derivatives: {@code df(x1,..)
 boolean df(double x, double y, double[] d)
          Compute partial derivatives: df(x,y)/dx and df(x,y)/dy.
 boolean df(double x, double y, double z, double[] d)
          Compute partial derivatives: df(x,y,z)/dx, df(x,y,z)/dy and df(x,y,z)/dz.
 double f(double x)
          Compute the mapping: double -> double.
 double f(double[] arg)
          Compute the mapping: double[] -> double.
 double f(double x, double y)
          Compute the mapping: double[2] -> double.
 double f(double x, double y, double z)
          Compute the mapping: double[3] -> double.
 double f(int x)
          Compute the mapping: int -> double.
 double f(int[] arg)
          Compute the mapping: int[] -> double.
 double f(int x, int y)
          Compute the mapping: int[2] -> double.
 double f(int x, int y, int z)
          Compute the mapping: int[3] -> double.
 double[] getDomain(double[] dom)
          Returns domain of the mapping.
 int[] getDomain(int[] dom)
          Returns domain of the mapping.
 
Methods inherited from interface cz.cuni.jagrlib.iface.Property
commit, get, set
 

Field Detail

AMPLITUDE

static final java.lang.String AMPLITUDE
Property name: amplitude.

See Also:
Constant Field Values

FREQUENCY

static final java.lang.String FREQUENCY
Property name: global frequency.

See Also:
Constant Field Values

FREQUENCY_X

static final java.lang.String FREQUENCY_X
Property name: frequency in the X coordinate.

See Also:
Constant Field Values

FREQUENCY_Y

static final java.lang.String FREQUENCY_Y
Property name: frequency in the Y coordinate.

See Also:
Constant Field Values

VARIATION

static final java.lang.String VARIATION
Property name: variation of the function (used in noise functions).

See Also:
Constant Field Values
Method Detail

f

double f(double x)
Compute the mapping: double -> double.


f

double f(int x)
Compute the mapping: int -> double.


f

double f(double x,
         double y)
Compute the mapping: double[2] -> double.


f

double f(int x,
         int y)
Compute the mapping: int[2] -> double.


f

double f(double x,
         double y,
         double z)
Compute the mapping: double[3] -> double.


f

double f(int x,
         int y,
         int z)
Compute the mapping: int[3] -> double.


f

double f(double[] arg)
Compute the mapping: double[] -> double.


f

double f(int[] arg)
Compute the mapping: int[] -> double.


df

double df(double x)
Compute erivative: df(x)/dx. Non-mandatory.

Parameters:
x - Function argument.
Returns:
Function derivative or 0.0 if not implemented.

df

boolean df(double x,
           double y,
           double[] d)
Compute partial derivatives: df(x,y)/dx and df(x,y)/dy. Non-mandatory.

Parameters:
x - X coordinate (1st argument).
y - Y coordinate (2nd argument).
d - Array to hold results (d[0] = df(x,y)/dx, d[1] = df(x,y)/dy).
Returns:
true if this service is implemented.

df

boolean df(double x,
           double y,
           double z,
           double[] d)
Compute partial derivatives: df(x,y,z)/dx, df(x,y,z)/dy and df(x,y,z)/dz. Non-mandatory.

Parameters:
x - X coordinate (1st argument).
y - Y coordinate (2nd argument).
z - Z coordinate (3rd argument).
d - Array to hold results (d[0] = df(x,y,z)/dx, d[1] = df(x,y,z)/dy, d[2] = df(x,y,z)/dz).
Returns:
true if this service is implemented.

df

boolean df(double[] arg,
           double[] d)
Compute partial derivatives: df(x1,..)/dx1, ... Non-mandatory.

Parameters:
arg - Coordinate array.
d - Array to hold results (d[0] = df(x1,...)/dx1, ...).
Returns:
true if this service is implemented.

getDomain

double[] getDomain(double[] dom)
Returns domain of the mapping.

Parameters:
dom - Domain array (dom[0] = Xmin, dom[1] = Xmax, etc.).
Returns:
null if this service is not implemented.

getDomain

int[] getDomain(int[] dom)
Returns domain of the mapping.

Parameters:
dom - Domain array (dom[0] = Xmin, dom[1] = Xmax, etc.).
Returns:
null if this service is not implemented.