Package adams.data.matlab.multimatrixoperation

Class Combine

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.matlab.multimatrixoperation.AbstractMultiMatrixOperation

adams.data.matlab.multimatrixoperation.Combine

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class Combine
extends AbstractMultiMatrixOperation

Combines the matrices into single one with additional dimension.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayElementType	m_ElementType	the element type.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Combine()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected us.hebi.matlab.mat.types.Matrix[]	doProcess(us.hebi.matlab.mat.types.Matrix[] matrices)	Performs the actual processing of the matrices.
String	elementTypeTipText()	Returns the tip text for this property.
ArrayElementType	getElementType()	Returns the type of the element in the array.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
int	maxNumMatricesRequired()	Returns the maximum number of matrices that are required for the operation.
int	minNumMatricesRequired()	Returns the minimum number of matrices that are required for the operation.
void	setElementType(ArrayElementType value)	Sets the type of the element in the array.

Methods inherited from class adams.data.matlab.multimatrixoperation.AbstractMultiMatrixOperation

check, checkSameDimensions, checkSameDimensions, process

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ElementType

protected ArrayElementType m_ElementType

the element type.

Constructor Detail

Combine

public Combine()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setElementType

public void setElementType(ArrayElementType value)

Sets the type of the element in the array.

Parameters:

value - the type

getElementType

public ArrayElementType getElementType()

Returns the type of the element in the array.

Returns:

the type

elementTypeTipText

public String elementTypeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractMultiMatrixOperation

Returns:

null if no info available, otherwise short string

minNumMatricesRequired

public int minNumMatricesRequired()

Returns the minimum number of matrices that are required for the operation.

Specified by:

minNumMatricesRequired in class AbstractMultiMatrixOperation

Returns:

the number of matrices that are required, <= 0 means no lower limit

maxNumMatricesRequired

public int maxNumMatricesRequired()

Returns the maximum number of matrices that are required for the operation.

Specified by:

maxNumMatricesRequired in class AbstractMultiMatrixOperation

Returns:

the number of matrices that are required, <= 0 means no upper limit

doProcess

protected us.hebi.matlab.mat.types.Matrix[] doProcess(us.hebi.matlab.mat.types.Matrix[] matrices)

Performs the actual processing of the matrices.

Specified by:

doProcess in class AbstractMultiMatrixOperation

Parameters:

matrices - the matrices to process

Returns:

the generated array(s)