de.jtem.function.real

Class RealFunctionPeriodicOnIndexCrossIntegers

java.lang.Object

de.jtem.function.real.RealFunctionPeriodicOnIndexCrossIntegers

All Implemented Interfaces:

Domain.OnIndexCrossIntegers, Domain.PeriodicOnIndexCrossIntegers, RealFunction.PeriodicOnIndexCrossIntegers

public class RealFunctionPeriodicOnIndexCrossIntegers
extends Object
implements RealFunction.PeriodicOnIndexCrossIntegers

An implementation of the interface RealFunction.PeriodicOnIndexCrossIntegers. Function values are stored internally, so using this class to make a copy of a RealFunction.PeriodicOnIndexCrossIntegers c (by the corresponding constructor or the assign method) will make a snapshot of the current state of c. No reference to c itself is retained.

Constructor Summary

Constructors

Constructor and Description
RealFunctionPeriodicOnIndexCrossIntegers() Creates a grid with 1 row and no columns.
RealFunctionPeriodicOnIndexCrossIntegers(int m, int n) Creates a grid with m rows, period n and all values zero.
RealFunctionPeriodicOnIndexCrossIntegers(RealFunction.PeriodicOnIndexCrossIntegers c) Creates a copy of the function c

Method Summary

Modifier and Type	Method and Description
void	assign(RealFunction.OnIndexCrossIndex c) Become a copy of the periodic extension of c
void	assign(RealFunction.PeriodicOnIndexCrossIntegers c) Become a copy of c
void	assignZero() Keep the number of rows and the period but set all values to zero.
void	assignZero(int m, int n) Become a matrix with m periodic rows of period n and all values zero.
int	getNumRows() Returns the number of rows (the range of the first variable of this function).
int	getPeriod() Returns the period of this function (a positive integer), refering to the behaviour in the last coordinate.
void	setSize(int m, int n) Do nothing if m is equal to the current number of rows and n is equal to the current period, become a matrix with m periodic rows of period code>n and all values zero otherwise.
void	setValueAt(int i, int j, double z) Sets the value at index i,j to z.
double	valueAt(int i, int j) returns the value of this function at i,j.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealFunctionPeriodicOnIndexCrossIntegers

public RealFunctionPeriodicOnIndexCrossIntegers()

Creates a grid with 1 row and no columns.

RealFunctionPeriodicOnIndexCrossIntegers

public RealFunctionPeriodicOnIndexCrossIntegers(int m,
                                                int n)

Creates a grid with m rows, period n and all values zero.

RealFunctionPeriodicOnIndexCrossIntegers

public RealFunctionPeriodicOnIndexCrossIntegers(RealFunction.PeriodicOnIndexCrossIntegers c)

Creates a copy of the function c

Method Detail

assign

public void assign(RealFunction.OnIndexCrossIndex c)

Become a copy of the periodic extension of c

assign

public void assign(RealFunction.PeriodicOnIndexCrossIntegers c)

Become a copy of c

assignZero

public void assignZero()

Keep the number of rows and the period but set all values to zero.

assignZero

public void assignZero(int m,
                       int n)

Become a matrix with m periodic rows of period n and all values zero.

Parameters:

m - must be at least one.

n - must be at least one.

getNumRows

public int getNumRows()

Returns the number of rows (the range of the first variable of this function).

getPeriod

public int getPeriod()

Returns the period of this function (a positive integer), refering to the behaviour in the last coordinate.

setSize

public void setSize(int m,
                    int n)

Do nothing if m is equal to the current number of rows and n is equal to the current period, become a matrix with m periodic rows of period code>n and all values zero otherwise.

Parameters:

m - must be at least one.

n - must be at least one.

setValueAt

public void setValueAt(int i,
                       int j,
                       double z)

Sets the value at index i,j to z.

Parameters:

i - must be non-negative and less than getNumRows().

valueAt

public double valueAt(int i,
                      int j)

returns the value of this function at i,j.