edu.mines.jtk.util

Class SimpleFloat3

java.lang.Object

edu.mines.jtk.util.SimpleFloat3

All Implemented Interfaces:

Float3

public class SimpleFloat3
extends java.lang.Object
implements Float3

A simple 3-D array of floats. Implements the generic interface Float3 using a straightforward Java 3-D array of floats.

Constructor Summary

Constructors

Constructor and Description
SimpleFloat3(float[][][] a) Constructs an array of elements for the specified array.
SimpleFloat3(int n1, int n2, int n3) Constructs an array of elements initialized to zero.

Method Summary

Methods

Modifier and Type	Method and Description
void	get1(int m1, int j1, int j2, int j3, float[] s) Gets the specified subarray of elements into the specified 1-D array.
void	get12(int m1, int m2, int j1, int j2, int j3, float[][] s) Gets the specified subarray of elements into the specified 2-D array.
void	get123(int m1, int m2, int m3, int j1, int j2, int j3, float[] s) Gets the specified subarray of elements into the specified 1-D array.
void	get123(int m1, int m2, int m3, int j1, int j2, int j3, float[][][] s) Gets the specified subarray of elements into the specified 3-D array.
void	get13(int m1, int m3, int j1, int j2, int j3, float[][] s) Gets the specified subarray of elements into the specified 2-D array.
void	get2(int m2, int j1, int j2, int j3, float[] s) Gets the specified subarray of elements into the specified 1-D array.
void	get23(int m2, int m3, int j1, int j2, int j3, float[][] s) Gets the specified subarray of elements into the specified 2-D array.
void	get3(int m3, int j1, int j2, int j3, float[] s) Gets the specified subarray of elements into the specified 1-D array.
int	getN1() Gets the number of elements in 1st dimension of this array.
int	getN2() Gets the number of elements in 2nd dimension of this array.
int	getN3() Gets the number of elements in 3rd dimension of this array.
void	set1(int m1, int j1, int j2, int j3, float[] s) Sets the specified subarray of elements from the specified 1-D array.
void	set12(int m1, int m2, int j1, int j2, int j3, float[][] s) Sets the specified subarray of elements from the specified 2-D array.
void	set123(int m1, int m2, int m3, int j1, int j2, int j3, float[] s) Sets the specified subarray of elements from the specified 1-D array.
void	set123(int m1, int m2, int m3, int j1, int j2, int j3, float[][][] s) Sets the specified subarray of elements from the specified 3-D array.
void	set13(int m1, int m3, int j1, int j2, int j3, float[][] s) Sets the specified subarray of elements from the specified 2-D array.
void	set2(int m2, int j1, int j2, int j3, float[] s) Sets the specified subarray of elements from the specified 1-D array.
void	set23(int m2, int m3, int j1, int j2, int j3, float[][] s) Sets the specified subarray of elements from the specified 2-D array.
void	set3(int m3, int j1, int j2, int j3, float[] s) Sets the specified subarray of elements from the specified 1-D array.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleFloat3

public SimpleFloat3(int n1,
            int n2,
            int n3)

Constructs an array of elements initialized to zero.

Parameters:

n1 - the 1st dimension of the array[n3][n2][n1].

n2 - the 2nd dimension of the array[n3][n2][n1].

n3 - the 3rd dimension of the array[n3][n2][n1].

SimpleFloat3

public SimpleFloat3(float[][][] a)

Constructs an array of elements for the specified array. References (does not copy) elements from the specified array.

Parameters:

a - array[n3][n2][n1] of elements to be referenced.

Method Detail

getN1

public int getN1()

Description copied from interface: Float3

Gets the number of elements in 1st dimension of this array.

Specified by:

getN1 in interface Float3

Returns:

the number of elements in 1st dimension.

getN2

public int getN2()

Description copied from interface: Float3

Gets the number of elements in 2nd dimension of this array.

Specified by:

getN2 in interface Float3

Returns:

the number of elements in 2nd dimension.

getN3

public int getN3()

Description copied from interface: Float3

Gets the number of elements in 3rd dimension of this array.

Specified by:

getN3 in interface Float3

Returns:

the number of elements in 3rd dimension.

get1

public void get1(int m1,
        int j1,
        int j2,
        int j3,
        float[] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 1-D array.

Specified by:

get1 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m1] of elements of the specified subarray.

get2

public void get2(int m2,
        int j1,
        int j2,
        int j3,
        float[] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 1-D array.

Specified by:

get2 in interface Float3

Parameters:

m2 - number of elements in 2nd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m2] of elements of the specified subarray.

get3

public void get3(int m3,
        int j1,
        int j2,
        int j3,
        float[] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 1-D array.

Specified by:

get3 in interface Float3

Parameters:

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3] of elements of the specified subarray.

get12

public void get12(int m1,
         int m2,
         int j1,
         int j2,
         int j3,
         float[][] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 2-D array.

Specified by:

get12 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m2 - number of elements in 2nd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m2][m1] of elements of the specified subarray.

get13

public void get13(int m1,
         int m3,
         int j1,
         int j2,
         int j3,
         float[][] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 2-D array.

Specified by:

get13 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3][m1] of elements of the specified subarray.

get23

public void get23(int m2,
         int m3,
         int j1,
         int j2,
         int j3,
         float[][] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 2-D array.

Specified by:

get23 in interface Float3

Parameters:

m2 - number of elements in 2nd dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3][m2] of elements of the specified subarray.

get123

public void get123(int m1,
          int m2,
          int m3,
          int j1,
          int j2,
          int j3,
          float[][][] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 3-D array.

Specified by:

get123 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m2 - number of elements in 2nd dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3][m2][m1] of elements of the specified subarray.

get123

public void get123(int m1,
          int m2,
          int m3,
          int j1,
          int j2,
          int j3,
          float[] s)

Description copied from interface: Float3

Gets the specified subarray of elements into the specified 1-D array. The length of the array must be at least m1*m2*m3.

Specified by:

get123 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m2 - number of elements in 2nd dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m1*m2*m3] of elements of the specified subarray.

set1

public void set1(int m1,
        int j1,
        int j2,
        int j3,
        float[] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 1-D array.

Specified by:

set1 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m1] of elements of the specified subarray.

set2

public void set2(int m2,
        int j1,
        int j2,
        int j3,
        float[] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 1-D array.

Specified by:

set2 in interface Float3

Parameters:

m2 - number of elements in 2nd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m2] of elements of the specified subarray.

set3

public void set3(int m3,
        int j1,
        int j2,
        int j3,
        float[] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 1-D array.

Specified by:

set3 in interface Float3

Parameters:

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3] of elements of the specified subarray.

set12

public void set12(int m1,
         int m2,
         int j1,
         int j2,
         int j3,
         float[][] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 2-D array.

Specified by:

set12 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m2 - number of elements in 2nd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m2][m1] of elements of the specified subarray.

set13

public void set13(int m1,
         int m3,
         int j1,
         int j2,
         int j3,
         float[][] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 2-D array.

Specified by:

set13 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3][m1] of elements of the specified subarray.

set23

public void set23(int m2,
         int m3,
         int j1,
         int j2,
         int j3,
         float[][] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 2-D array.

Specified by:

set23 in interface Float3

Parameters:

m2 - number of elements in 2nd dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3][m2] of elements of the specified subarray.

set123

public void set123(int m1,
          int m2,
          int m3,
          int j1,
          int j2,
          int j3,
          float[][][] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 3-D array.

Specified by:

set123 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m2 - number of elements in 2nd dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m3][m2][m1] of elements of the specified subarray.

set123

public void set123(int m1,
          int m2,
          int m3,
          int j1,
          int j2,
          int j3,
          float[] s)

Description copied from interface: Float3

Sets the specified subarray of elements from the specified 1-D array. The length of the array must be at least m1*m2*m3.

Specified by:

set123 in interface Float3

Parameters:

m1 - number of elements in 1st dimension of subarray.

m2 - number of elements in 2nd dimension of subarray.

m3 - number of elements in 3rd dimension of subarray.

j1 - index of first element in 1st dimension of subarray.

j2 - index of first element in 2nd dimension of subarray.

j3 - index of first element in 3rd dimension of subarray.

s - array[m1*m2*m3] of elements of the specified subarray.