de.jtem.function.integer

Class IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers

java.lang.Object

de.jtem.function.integer.IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers

All Implemented Interfaces:

Domain.DoublyPeriodicOnIntegersCrossIntegersCrossIntegers, Domain.DoublyPeriodicOnNonNegativeIntegersCrossIntegersCrossIntegers, Domain.OnIntegersCrossIntegersCrossIntegers, Domain.OnNonNegativeIntegersCrossIntegersCrossIntegers, Domain.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers, IntegerFunction.DoublyPeriodicOnIntegersCrossIntegersCrossIntegers, IntegerFunction.OnIntegersCrossIntegersCrossIntegers, IntegerFunction.OnNonNegativeIntegersCrossIntegersCrossIntegers, IntegerFunction.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers

public class IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers
extends Object
implements IntegerFunction.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers

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

Method Summary

Modifier and Type	Method and Description
void	assign(IntegerFunction.OnIndexCrossIndexCrossIndex c) Become a copy of the triply periodic extension of c
void	assign(IntegerFunction.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers c) Become a copy 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	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.
int	getThirdPeriod() Returns the third period of this function (a positive integer), refering to the behaviour in the first coordinate.
void	setSize(int k, int m, int n) Do nothing if k is equal to the current third period, m is equal to the current second period and n is equal to the current period.
void	setValueAt(int h, int i, int j, int z) Sets the value at index h,i,j to z.
int	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

IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers

public IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers()

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

IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers

public IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers(IntegerFunction.OnIndexCrossIndexCrossIndex c)

Creates a copy of the triply periodic extension of c.

IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers

public IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers(IntegerFunction.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers c)

Creates a copy of the function c

IntegerFunctionTriplyPeriodicOnIntegersCrossIntegersCrossIntegers

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

Creates a grid with k layers, m periodic rows, , n periodic columns and all values zero.

Parameters:

k - must be at least one.

m - must be at least one.

n - must be at least one.

Method Detail

assign

public void assign(IntegerFunction.OnIndexCrossIndexCrossIndex c)

Become a copy of the triply periodic extension of c

assign

public void assign(IntegerFunction.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers c)

Become a copy 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.

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.

getThirdPeriod

public int getThirdPeriod()

Description copied from interface: Domain.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers

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

Specified by:

getThirdPeriod in interface Domain.TriplyPeriodicOnIntegersCrossIntegersCrossIntegers

setSize

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

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

Parameters:

k - must be at least one.

m - must be at least one.

n - must be at least one.

setValueAt

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

Sets the value at index h,i,j to z.

valueAt

public int valueAt(int h,
                   int i,
                   int j)

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