GenericPLSMatrixAccess (adams-pom 24.12.0-SNAPSHOT API)

All Known Implementing Classes:

AbstractMultiClassPLS, AbstractPLS, AbstractSingleClassPLS, DIPLS, KernelPLS, MultiPLS, NIPALS, OPLS, PLS, PLS1, PLSWeighted, PRM, SIMPLS, SparsePLS, VCPLS
```
public interface GenericPLSMatrixAccess
```
For classes that allow access to PLS matrices.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`weka.core.matrix.Matrix`	`getLoadings()`	Returns the loadings, if available.
`weka.core.matrix.Matrix`	`getMatrix(String name)`	Returns the matrix with the specified name.
`String[]`	`getMatrixNames()`	Returns the all the available matrices.
`boolean`	`hasLoadings()`	Whether the algorithm supports return of loadings.

- Method Detail
  - getMatrixNames
```
String[] getMatrixNames()
```
    Returns the all the available matrices.
    
    Returns:
    
    the names of the matrices
  - getMatrix
```
weka.core.matrix.Matrix getMatrix(String name)
```
    Returns the matrix with the specified name.
    
    Parameters:
    
    name - the name of the matrix
    
    Returns:
    
    the matrix, null if not available
  - hasLoadings
```
boolean hasLoadings()
```
    Whether the algorithm supports return of loadings.
    
    Returns:
    
    true if supported
    
    See Also:
    
    getLoadings()
  - getLoadings
```
weka.core.matrix.Matrix getLoadings()
```
    Returns the loadings, if available.
    
    Returns:
    
    the loadings, null if not available