oracle.dmt.odm.settings.algorithm
Class NMFAlgorithmSettings

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.settings.algorithm.MiningAlgorithmSettings
              |
              +--oracle.dmt.odm.settings.algorithm.FeatureExtractionAlgorithmSettings
                    |
                    +--oracle.dmt.odm.settings.algorithm.NMFAlgorithmSettings

All Implemented Interfaces:

java.io.Serializable

public class NMFAlgorithmSettings

extends FeatureExtractionAlgorithmSettings

An instance of NMFAlgorithmSettings is used to specify settings for the NMF Feature Extraction algorithm. It allows a knowledgeable user to fine tune algorithm parameters. Generally, not all parameters must be specified, however, those specified are taken into account by the underlying DMS

Since:

10.1.0

See Also:

Serialized Form

Constructor Summary

NMFAlgorithmSettings()
Creates an instance of NMFAlgorithmSettings object with default settings: maximum number of iterations is set to 50 minimum convergence tolerance is set 0.5

NMFAlgorithmSettings(float minConvergenceTolerance)
Creates an instance of NMFAlgorithmSettings object with default settings: maximum number of iterations is set to 50

NMFAlgorithmSettings(int maxNumberOfIterations)
Creates an instance of NMFAlgorithmSettings object with default settings: minimum convergence tolerance is set 0.5

NMFAlgorithmSettings(int maxNumberOfIterations, float minConvergenceTolerance)
Creates an instance of NMFAlgorithmSettings object.

Method Summary

int	getMaxNumberOfIterations() Retrieves the associated maximum number of iterations value.
float	getMinimumConvergenceTolerance() Retrieves the associated minimum convergence tolerance value.
int	getRandomSeedSetting() Retrieves the associated random seed settings value.
void	setMaxNumberOfIterations(int maxNumberOfIterations) Sets the maximum number of iterations value.
void	setMinimumConvergenceTolerance(float minConvergenceTolerance) Sets the minimum convergence tolerance value.
void	setRandomSeedSetting(int randomSeedSetting) Sets the random seed settings value.
void	validate() Validate an instance of NMFAlgorithmSettings object.

Methods inherited from class oracle.dmt.odm.settings.algorithm.MiningAlgorithmSettings

getMiningAlgorithm, getMiningAlgorithmName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NMFAlgorithmSettings

public NMFAlgorithmSettings()

Creates an instance of NMFAlgorithmSettings object with default settings:

• maximum number of iterations is set to 50
• minimum convergence tolerance is set 0.5

NMFAlgorithmSettings

public NMFAlgorithmSettings(int maxNumberOfIterations)
                     throws MiningObjectException

Creates an instance of NMFAlgorithmSettings object with default settings:

• minimum convergence tolerance is set 0.5

Throws:

MiningObjectException - if maxNumberOfIterations < 1 or maxNumberOfIterations > 500

NMFAlgorithmSettings

public NMFAlgorithmSettings(float minConvergenceTolerance)
                     throws MiningObjectException

Creates an instance of NMFAlgorithmSettings object with default settings:

• maximum number of iterations is set to 50

Throws:

MiningObjectException - if minConvergenceTolerance < 0.001 or minConvergenceTolerance > 1.0

NMFAlgorithmSettings

public NMFAlgorithmSettings(int maxNumberOfIterations,
                            float minConvergenceTolerance)
                     throws MiningObjectException

Creates an instance of NMFAlgorithmSettings object.

Throws:

MiningObjectException -

• if maxNumberOfIterations < 1 or maxNumberOfIterations > 500
• if minConvergenceTolerance < 0.001 or minConvergenceTolerance > 1.0

Method Detail

getRandomSeedSetting

public int getRandomSeedSetting()

Retrieves the associated random seed settings value.

setRandomSeedSetting

public void setRandomSeedSetting(int randomSeedSetting)

Sets the random seed settings value.

Parameters:

randomSeedSetting - the random seed settings value

getMaxNumberOfIterations

public int getMaxNumberOfIterations()

Retrieves the associated maximum number of iterations value.

setMaxNumberOfIterations

public void setMaxNumberOfIterations(int maxNumberOfIterations)

Sets the maximum number of iterations value.

Parameters:

maxNumberOfIterations - the maximum number of iterations value

getMinimumConvergenceTolerance

public float getMinimumConvergenceTolerance()

Retrieves the associated minimum convergence tolerance value.

setMinimumConvergenceTolerance

public void setMinimumConvergenceTolerance(float minConvergenceTolerance)

Sets the minimum convergence tolerance value.

Parameters:

minConvergenceTolerance - the minimum convergence tolerance value

validate

public void validate()
              throws MiningObjectException

Validate an instance of NMFAlgorithmSettings object.

Overrides:

validate in class MiningAlgorithmSettings

Throws:

MiningObjectException -

• if m_maxNumberOfIterations < 1 or m_maxNumberOfIterations > 500
• if m_minConvergenceTolerance < 0.001 or m_minConvergenceTolerance> 1.0