public interface Frame<P extends FramePosition>
Frame: a pair of the AlgART matrix
and its position
;
in other words, an ndimensional matrix, placed by some way in ndimensional space.
The matrix position is represented by FramePosition
interface and specifies, what area of
ndimensional space corresponds to this matrix. In the simplest case, the position
is just coordinates of the starting element (0,0,...) of the matrix in the space.
See comments to FramePosition
interface for more details.
A set of frames is the basic data structure that is possible to be stitched by this package, i.e. transformed to a united matrix, corresponding to any rectangular area in ndimensional space, probably containing all matrices, placed in the space at their positions.
Implementations of this interface are usually immutable and always threadsafe. All implementations of this interface from this package are immutable.
AlgART Laboratory 2007–2014
Modifier and Type  Method and Description 

int 
dimCount()
The number of space dimensions.

boolean 
equals(java.lang.Object obj)

void 
freeResources()
Calls
Matrix.freeResources(null) for the matrix,
contained in this frame. 
int 
hashCode()
Returns the hash code of this object.

Matrix<? extends PArray> 
matrix()
The matrix, contained in this frame.

P 
position()
The position in ndimensional space, where the given
matrix is placed. 
int dimCount()
Matrix<? extends PArray> matrix()
matrix()
.dimCount()
==thisInstance.dimCount()
.P position()
matrix
is placed.
There is a guarantee that
thisInstance.position()
.area()
.coordCount()
==thisInstance.dimCount()
.matrix
is placed.void freeResources()
Matrix.freeResources(null)
for the matrix,
contained in this frame.int hashCode()
matrix
and the frame position
.hashCode
in class java.lang.Object
boolean equals(java.lang.Object obj)
Frame
,
containg the matrix
and position
, equal to the matrix and position
in this frame.
Note: this method should return true even the class of the passed frame is different than this class. This method checks only the builtin matrices and positions.
equals
in class java.lang.Object
obj
 the object to be compared for equality with this frame.