edu.mines.jtk.util
Interface Float3

All Known Implementing Classes:

SimpleFloat3

public interface Float3

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

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

Version:

2006.05.24

Author:

Dave Hale, Colorado School of Mines

Method Summary

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.

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.

get1

void get1(int m1,
          int j1,
          int j2,
          int j3,
          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.

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

get2

void get2(int m2,
          int j1,
          int j2,
          int j3,
          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.

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

get3

void get3(int m3,
          int j1,
          int j2,
          int j3,
          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.

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

get12

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.

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

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.

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

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.

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

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.

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

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. The length of the array must be at least m1*m2*m3.

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

void set1(int m1,
          int j1,
          int j2,
          int j3,
          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.

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

set2

void set2(int m2,
          int j1,
          int j2,
          int j3,
          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.

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

set3

void set3(int m3,
          int j1,
          int j2,
          int j3,
          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.

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

set12

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.

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

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.

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

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.

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

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.

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

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. The length of the array must be at least m1*m2*m3.

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.