Package adams.flow.transformer

Enum WekaExtractPLSMatrix.MatrixType

java.lang.Object

java.lang.Enum<WekaExtractPLSMatrix.MatrixType>

adams.flow.transformer.WekaExtractPLSMatrix.MatrixType

All Implemented Interfaces:

Serializable, Comparable<WekaExtractPLSMatrix.MatrixType>

Enclosing class:

WekaExtractPLSMatrix

public static enum WekaExtractPLSMatrix.MatrixType
extends Enum<WekaExtractPLSMatrix.MatrixType>

The type of PLS matrix to extract (either PLS1 or SIMPLS ones will be available).

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
PLS1_B_HAT	the b-hat vector for PLS1
PLS1_P	the P matrix for PLS1
PLS1_REGVECTOR	the regression vector "r-hat" for PLS1
PLS1_W	the W matrix for PLS1
SIMPLS_B	the B matrix for SIMPLS (used for prediction)
SIMPLS_W	the W matrix for SIMPLS

Method Summary

Modifier and Type	Method	Description
static WekaExtractPLSMatrix.MatrixType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WekaExtractPLSMatrix.MatrixType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLS1_REGVECTOR

public static final WekaExtractPLSMatrix.MatrixType PLS1_REGVECTOR

the regression vector "r-hat" for PLS1

PLS1_P

public static final WekaExtractPLSMatrix.MatrixType PLS1_P

the P matrix for PLS1

PLS1_W

public static final WekaExtractPLSMatrix.MatrixType PLS1_W

the W matrix for PLS1

PLS1_B_HAT

public static final WekaExtractPLSMatrix.MatrixType PLS1_B_HAT

the b-hat vector for PLS1

SIMPLS_W

public static final WekaExtractPLSMatrix.MatrixType SIMPLS_W

the W matrix for SIMPLS

SIMPLS_B

public static final WekaExtractPLSMatrix.MatrixType SIMPLS_B

the B matrix for SIMPLS (used for prediction)

Method Detail

values

public static WekaExtractPLSMatrix.MatrixType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WekaExtractPLSMatrix.MatrixType c : WekaExtractPLSMatrix.MatrixType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WekaExtractPLSMatrix.MatrixType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null