Package org.carrot2.math.matrix
Class IterativeMatrixFactorizationFactory
java.lang.Object
org.carrot2.attrs.AttrComposite
org.carrot2.math.matrix.IterativeMatrixFactorizationFactory
- All Implemented Interfaces:
AcceptingVisitor
,MatrixFactorizationFactory
- Direct Known Subclasses:
KMeansMatrixFactorizationFactory
,LocalNonnegativeMatrixFactorizationFactory
,NonnegativeMatrixFactorizationEDFactory
,NonnegativeMatrixFactorizationKLFactory
public abstract class IterativeMatrixFactorizationFactory
extends AttrComposite
implements MatrixFactorizationFactory
A factory for
MatrixFactorization
s.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final int
The default number of base vectorsprotected static final int
The default number of maximum iterationsprotected static final boolean
protected static final SeedingStrategyFactory
Default matrix seeding strategy factoryprotected static final double
The default stop thresholdfinal AttrEnum
<FactorizationQuality> Number of iterations of matrix factorization to perform.protected int
The number of base vectorsprotected int
The maximum number of iterations the algorithm is allowed to completeprotected boolean
Order base vectors according to their 'activity'protected SeedingStrategyFactory
Matrix seeding strategy factoryprotected double
The algorithm's stop thresholdFields inherited from class org.carrot2.attrs.AttrComposite
attributes
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected SeedingStrategy
void
estimateIterationsNumber
(int dimensions, org.carrot2.math.mahout.matrix.DoubleMatrix2D termDocumentMatrix) int
getK()
Returns the number of base vectors k .int
Returns the maximum number of iterations used by this factory.Returns theSeedingStrategyFactory
used by this factory.double
Returns the stop threshold used by this factory.boolean
Returnstrue
when the factorization is set to generate an ordered basis.void
setK
(int k) Sets the number of base vectors k .void
setMaxIterations
(int maxIterations) Sets the maximum number of iterations to be used by this factory.void
setOrdered
(boolean ordered) Set totrue
to generate an ordered basis.void
setSeedingFactory
(SeedingStrategyFactory seedingFactory) Sets theSeedingStrategyFactory
to be used by this factory.void
setStopThreshold
(double stopThreshold) Sets the stop threshold to be used by this factory.Methods inherited from class org.carrot2.attrs.AttrComposite
accept
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.carrot2.attrs.AcceptingVisitor
accept
Methods inherited from interface org.carrot2.math.matrix.MatrixFactorizationFactory
factorize
-
Field Details
-
factorizationQuality
Number of iterations of matrix factorization to perform. The higher the required quality, the more time-consuming clustering. -
k
protected int kThe number of base vectors -
DEFAULT_K
protected static final int DEFAULT_KThe default number of base vectors- See Also:
-
maxIterations
protected int maxIterationsThe maximum number of iterations the algorithm is allowed to complete -
DEFAULT_MAX_ITERATIONS
protected static final int DEFAULT_MAX_ITERATIONSThe default number of maximum iterations- See Also:
-
stopThreshold
protected double stopThresholdThe algorithm's stop threshold -
DEFAULT_STOP_THRESHOLD
protected static final double DEFAULT_STOP_THRESHOLDThe default stop threshold- See Also:
-
seedingFactory
Matrix seeding strategy factory -
DEFAULT_SEEDING_FACTORY
Default matrix seeding strategy factory -
ordered
protected boolean orderedOrder base vectors according to their 'activity' -
DEFAULT_ORDERED
protected static final boolean DEFAULT_ORDERED- See Also:
-
-
Constructor Details
-
IterativeMatrixFactorizationFactory
public IterativeMatrixFactorizationFactory()
-
-
Method Details
-
setK
public void setK(int k) Sets the number of base vectors k .- Parameters:
k
- the number of base vectors
-
getK
public int getK()Returns the number of base vectors k . -
createSeedingStrategy
-
getMaxIterations
public int getMaxIterations()Returns the maximum number of iterations used by this factory. -
setMaxIterations
public void setMaxIterations(int maxIterations) Sets the maximum number of iterations to be used by this factory. -
getStopThreshold
public double getStopThreshold()Returns the stop threshold used by this factory. -
setStopThreshold
public void setStopThreshold(double stopThreshold) Sets the stop threshold to be used by this factory. -
getSeedingFactory
Returns theSeedingStrategyFactory
used by this factory. -
setSeedingFactory
Sets theSeedingStrategyFactory
to be used by this factory. -
isOrdered
public boolean isOrdered()Returnstrue
when the factorization is set to generate an ordered basis. -
setOrdered
public void setOrdered(boolean ordered) Set totrue
to generate an ordered basis. -
estimateIterationsNumber
public void estimateIterationsNumber(int dimensions, org.carrot2.math.mahout.matrix.DoubleMatrix2D termDocumentMatrix)
-