edu.mines.jtk.util

Interface Float4

public interface Float4

A generic interface for a 4-D array of floats. This interface enables getting and setting 1-, 2-, 3- and 4-D subarrays (slices) of elements from any data structure that can be indexed like a 4-D array. Unlike a 4-D array, that data structure need not reside entirely in memory.

Logically, the 4-D array can be considered as float a[n4][n3][n2][n1], where n1 is the fastest array dimension, and n4 is the slowest.

Method Summary

Methods

Modifier and Type	Method and Description
void	get1(int m1, int j1, int j2, int j3, int j4, 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, int j4, 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, int j4, float[][][] s) Gets the specified subarray of elements into the specified 3-D array.
void	get1234(int m1, int m2, int m3, int m4, int j1, int j2, int j3, int j4, float[] s) Gets the specified subarray of elements into the specified 1-D array.
void	get1234(int m1, int m2, int m3, int m4, int j1, int j2, int j3, int j4, float[][][][] s) Gets the specified subarray of elements into the specified 4-D array.
void	get124(int m1, int m2, int m4, int j1, int j2, int j3, int j4, 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, int j4, float[][] s) Gets the specified subarray of elements into the specified 2-D array.
void	get134(int m1, int m3, int m4, int j1, int j2, int j3, int j4, float[][][] s) Gets the specified subarray of elements into the specified 3-D array.
void	get14(int m1, int m4, int j1, int j2, int j3, int j4, float[][] s) Gets the specified subarray of elements into the specified 2-D array.
void	get2(int m2, int j1, int j2, int j3, int j4, 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, int j4, float[][] s) Gets the specified subarray of elements into the specified 2-D array.
void	get234(int m2, int m3, int m4, int j1, int j2, int j3, int j4, float[][][] s) Gets the specified subarray of elements into the specified 3-D array.
void	get24(int m2, int m4, int j1, int j2, int j3, int j4, float[][] s) Gets the specified subarray of elements into the specified 2-D array.
void	get3(int m3, int j1, int j2, int j3, int j4, float[] s) Gets the specified subarray of elements into the specified 1-D array.
void	get4(int m4, int j1, int j2, int j3, int j4, 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.
int	getN4() Gets the number of elements in 4th dimension of this array.
void	set1(int m1, int j1, int j2, int j3, int j4, 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, int j4, 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, int j4, float[][][] s) Sets the specified subarray of elements from the specified 3-D array.
void	set1234(int m1, int m2, int m3, int m4, int j1, int j2, int j3, int j4, float[] s) Sets the specified subarray of elements from the specified 1-D array.
void	set1234(int m1, int m2, int m3, int m4, int j1, int j2, int j3, int j4, float[][][][] s) Sets the specified subarray of elements from the specified 4-D array.
void	set124(int m1, int m2, int m4, int j1, int j2, int j3, int j4, 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, int j4, float[][] s) Sets the specified subarray of elements from the specified 2-D array.
void	set134(int m1, int m3, int m4, int j1, int j2, int j3, int j4, float[][][] s) Sets the specified subarray of elements from the specified 3-D array.
void	set14(int m1, int m4, int j1, int j2, int j3, int j4, float[][] s) Sets the specified subarray of elements from the specified 2-D array.
void	set2(int m2, int j1, int j2, int j3, int j4, 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, int j4, float[][] s) Sets the specified subarray of elements from the specified 2-D array.
void	set234(int m2, int m3, int m4, int j1, int j2, int j3, int j4, float[][][] s) Sets the specified subarray of elements from the specified 3-D array.
void	set24(int m2, int m4, int j1, int j2, int j3, int j4, float[][] s) Sets the specified subarray of elements from the specified 2-D array.
void	set3(int m3, int j1, int j2, int j3, int j4, float[] s) Sets the specified subarray of elements from the specified 1-D array.
void	set4(int m4, int j1, int j2, int j3, int j4, float[] s) Sets the specified subarray of elements from the specified 1-D array.

Method Detail

getN1

int getN1()

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

Returns:

the number of elements in 1st dimension.

getN2

int getN2()

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

Returns:

the number of elements in 2nd dimension.

getN3

int getN3()

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

Returns:

the number of elements in 3rd dimension.

getN4

int getN4()

Gets the number of elements in 4th dimension of this array.

Returns:

the number of elements in 4th dimension.

get1

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

get2

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

get3

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

get4

void get4(int m4,
        int j1,
        int j2,
        int j3,
        int j4,
        float[] s)

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

Parameters:

m4 - 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.

j4 - index of first element in 4th dimension of subarray.

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

get12

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

get13

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

get14

void get14(int m1,
         int m4,
         int j1,
         int j2,
         int j3,
         int j4,
         float[][] s)

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

Parameters:

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

m4 - 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.

j4 - index of first element in 4th dimension of subarray.

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

get23

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

get24

void get24(int m2,
         int m4,
         int j1,
         int j2,
         int j3,
         int j4,
         float[][] s)

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

Parameters:

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

m4 - 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.

j4 - index of first element in 4th dimension of subarray.

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

get123

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

get124

void get124(int m1,
          int m2,
          int m4,
          int j1,
          int j2,
          int j3,
          int j4,
          float[][][] s)

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

Parameters:

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

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

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

get134

void get134(int m1,
          int m3,
          int m4,
          int j1,
          int j2,
          int j3,
          int j4,
          float[][][] s)

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

Parameters:

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

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

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

get234

void get234(int m2,
          int m3,
          int m4,
          int j1,
          int j2,
          int j3,
          int j4,
          float[][][] s)

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

Parameters:

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

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

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

get1234

void get1234(int m1,
           int m2,
           int m3,
           int m4,
           int j1,
           int j2,
           int j3,
           int j4,
           float[][][][] s)

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

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.

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

get1234

void get1234(int m1,
           int m2,
           int m3,
           int m4,
           int j1,
           int j2,
           int j3,
           int j4,
           float[] s)

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

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.

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

set1

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

set2

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

set3

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

set4

void set4(int m4,
        int j1,
        int j2,
        int j3,
        int j4,
        float[] s)

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

Parameters:

m4 - 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.

j4 - index of first element in 4th dimension of subarray.

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

set12

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

set13

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

set14

void set14(int m1,
         int m4,
         int j1,
         int j2,
         int j3,
         int j4,
         float[][] s)

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

Parameters:

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

m4 - 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.

j4 - index of first element in 4th dimension of subarray.

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

set23

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

set24

void set24(int m2,
         int m4,
         int j1,
         int j2,
         int j3,
         int j4,
         float[][] s)

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

Parameters:

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

m4 - 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.

j4 - index of first element in 4th dimension of subarray.

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

set123

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

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

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.

j4 - index of first element in 4th dimension of subarray.

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

set124

void set124(int m1,
          int m2,
          int m4,
          int j1,
          int j2,
          int j3,
          int j4,
          float[][][] s)

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

Parameters:

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

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

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

set134

void set134(int m1,
          int m3,
          int m4,
          int j1,
          int j2,
          int j3,
          int j4,
          float[][][] s)

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

Parameters:

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

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

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

set234

void set234(int m2,
          int m3,
          int m4,
          int j1,
          int j2,
          int j3,
          int j4,
          float[][][] s)

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

Parameters:

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

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

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

set1234

void set1234(int m1,
           int m2,
           int m3,
           int m4,
           int j1,
           int j2,
           int j3,
           int j4,
           float[][][][] s)

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

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.

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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

set1234

void set1234(int m1,
           int m2,
           int m3,
           int m4,
           int j1,
           int j2,
           int j3,
           int j4,
           float[] s)

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

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.

m4 - number of elements in 4th 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.

j4 - index of first element in 4th dimension of subarray.

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