Interface Matrix3D<R,C,S,V>
-
- All Known Implementing Classes:
AbstractMatrix3D
,DenseDouble3dMatrix
,DenseObject3DMatrix
,DoubleMatrix3D
public interface Matrix3D<R,C,S,V>
- Author:
- ?
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addColumnName(C s, int index)
Add a column name associated with an index.void
addRowName(R s, int index)
Add a row name associated with a row index.void
addSliceName(S s, int index)
Add a slice nameint
columns()
Get the number of columns the matrix has.boolean
containsColumnName(C columnName)
Check if the matrix contains a column nameboolean
containsRowName(R rowName)
Check if the matrix contains a row nameboolean
containsSliceName(S sliceName)
Check if the matrix contains a slice nameint
getColIndexByName(C s)
Get the index of a column by name.C
getColName(int i)
Get the column name for an index.Iterator<C>
getColNameIterator()
List<C>
getColNames()
V
getObject(int slice, int row, int column)
int
getRowIndexByName(R s)
Get the index of a row by name.R
getRowName(int i)
Get the row name for an indexIterator<R>
getRowNameIterator()
List<R>
getRowNames()
int
getSliceIndexByName(S s)
Get a slice indexS
getSliceName(int i)
Get a slice nameIterator<S>
getSliceNameIterator()
List<S>
getSliceNames()
boolean
hasColNames()
Check if this matrix has a valid set of column names.boolean
hasRow(R r)
boolean
hasRowNames()
boolean
hasSliceNames()
boolean
isMissing(int slice, int row, int column)
Check if the value at a given index is missing.int
numMissing()
Return the number of missing values in the matrix.int
rows()
Get the number of rows the matrix hasvoid
setColumnNames(List<C> v)
void
setRowNames(List<R> v)
void
setSliceNames(List<S> v)
int
slices()
-
-
-
Method Detail
-
addColumnName
void addColumnName(C s, int index)
Add a column name associated with an index.- Parameters:
s
- a column nameindex
- int the column index associated with this name
-
addRowName
void addRowName(R s, int index)
Add a row name associated with a row index.- Parameters:
s
- row nameindex
-
-
addSliceName
void addSliceName(S s, int index)
Add a slice name- Parameters:
s
- name of the sliceindex
-
-
columns
int columns()
Get the number of columns the matrix has.- Returns:
- int
-
containsColumnName
boolean containsColumnName(C columnName)
Check if the matrix contains a column name- Parameters:
colName
-- Returns:
- true if the matrix contains the column name
-
containsRowName
boolean containsRowName(R rowName)
Check if the matrix contains a row name- Parameters:
rowName
-- Returns:
- true if the matrix contains the row name
-
containsSliceName
boolean containsSliceName(S sliceName)
Check if the matrix contains a slice name- Parameters:
stripeName
-- Returns:
- true if the matrix contains the slice name
-
getColIndexByName
int getColIndexByName(C s)
Get the index of a column by name.- Parameters:
s
- name- Returns:
- column index
-
getColName
C getColName(int i)
Get the column name for an index.- Parameters:
i
- column index- Returns:
- column name
-
getObject
V getObject(int slice, int row, int column)
-
getRowIndexByName
int getRowIndexByName(R s)
Get the index of a row by name.- Parameters:
s
- name- Returns:
- row index
-
getRowName
R getRowName(int i)
Get the row name for an index- Parameters:
i
- row index- Returns:
- name of the row
-
getSliceIndexByName
int getSliceIndexByName(S s)
Get a slice index- Parameters:
s
- name- Returns:
- slice index
-
getSliceName
S getSliceName(int i)
Get a slice name- Parameters:
i
- index- Returns:
- slice name
-
hasColNames
boolean hasColNames()
Check if this matrix has a valid set of column names.- Returns:
- boolean
-
hasRow
boolean hasRow(R r)
- Parameters:
r
- row name- Returns:
- whether the row exists
-
hasRowNames
boolean hasRowNames()
- Returns:
- boolean
-
hasSliceNames
boolean hasSliceNames()
-
isMissing
boolean isMissing(int slice, int row, int column)
Check if the value at a given index is missing.- Parameters:
slice
-row
-column
-- Returns:
- true if the value is missing, false otherwise.
-
numMissing
int numMissing()
Return the number of missing values in the matrix.- Returns:
- number missing
-
rows
int rows()
Get the number of rows the matrix has- Returns:
- int
-
slices
int slices()
-
-