de.jtem.function.complex

Class ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers

java.lang.Object

de.jtem.function.complex.ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers

All Implemented Interfaces:

ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers, Domain.DoublyPeriodicOnIndexCrossIntegersCrossIntegers

public class ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers
extends Object
implements ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers

An implementation of the interface ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers. Function values are stored internally, so using this class to make a copy of a ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers 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
ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers() Creates a grid with 1 layer, 1 row and 1 column and value zero.
ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers(ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers c) Creates a copy of the function c
ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers(ComplexFunctionOnIndexCrossIndexCrossIndex c) Creates a doubly periodic extension of c.
ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers(int k, int m, int n) Creates a grid with m layers, columns of period m, rows of period n and all values zero.

Method Summary

Modifier and Type	Method and Description
void	assign(ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers c) Become a copy of c
void	assign(ComplexFunction.OnIndexCrossIndexCrossIndex c) Become a copy of the doubly periodic extension of c
void	assignZero() Keep the number of layers and the periods but set all values to zero.
void	assignZero(int k, int m, int n) Become a matrix with m layers, m periodic rows of period n, periodic columns of period m and all values zero.
int	getNumLayers() Returns the number of layers (the range of the third variable of this function).
int	getPeriod() Returns the period of this function (a positive integer), refering to the behaviour in the last coordinate.
int	getSecondPeriod() Returns the second period of this function (a positive integer), refering to the behaviour in the last but one coordinate.
void	setSize(int k, int m, int n) Do nothing if k is equal to the current number of layers, m is equal to the current second period and n is equal to the current period.
void	setValueAt(int h, int i, int j, de.jtem.mfc.field.Complex z) Sets the value at index i,j to z.
de.jtem.mfc.field.Complex	valueAt(int h, int i, int j) returns the value of this function at i,j,k.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers

public ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers()

Creates a grid with 1 layer, 1 row and 1 column and value zero.

ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers

public ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers(ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers c)

Creates a copy of the function c

ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers

public ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers(ComplexFunctionOnIndexCrossIndexCrossIndex c)

Creates a doubly periodic extension of c.

ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers

public ComplexFunctionDoublyPeriodicOnIndexCrossIntegersCrossIntegers(int k,
                                                                      int m,
                                                                      int n)

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

Method Detail

assign

public void assign(ComplexFunction.DoublyPeriodicOnIndexCrossIntegersCrossIntegers c)

Become a copy of c

assign

public void assign(ComplexFunction.OnIndexCrossIndexCrossIndex c)

Become a copy of the doubly periodic extension of c

assignZero

public void assignZero()

Keep the number of layers and the periods but set all values to zero.

assignZero

public void assignZero(int k,
                       int m,
                       int n)

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

Parameters:

k - must be at least one.

m - must be at least one.

n - must be at least one.

getNumLayers

public int getNumLayers()

Returns the number of layers (the range of the third 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.

getSecondPeriod

public int getSecondPeriod()

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

setSize

public void setSize(int k,
                    int m,
                    int n)

Do nothing if k is equal to the current number of layers, m is equal to the current second period and n is equal to the current period. Otherwise become a doubly periodic matrix with k layers, m rows, n columns and all values zero.

Parameters:

m - must be at least one.

n - must be at least one.

setValueAt

public void setValueAt(int h,
                       int i,
                       int j,
                       de.jtem.mfc.field.Complex z)

Sets the value at index i,j to z.

Parameters:

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

valueAt

public de.jtem.mfc.field.Complex valueAt(int h,
                                         int i,
                                         int j)

returns the value of this function at i,j,k.