Click or drag to resize

NMFact Class

Class NMFact performs non-negative matrix factorization.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CoreNMFact

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.4
Syntax
[SerializableAttribute]
public class NMFact : ICloneable

The NMFact type exposes the following members.

Constructors
  NameDescription
Public methodNMFact
Creates an NMFact object with default settings for cost at each step, update algorithm, and number of iterations.
Public methodNMFact(Boolean)
Constructs an NMFact using the default number of iterations and update algorithm with the specified cost at each step.
Public methodNMFact(Int32)
Constructs an NMFact object that uses the default cost at each step and update algorithm with the given number of iterations.
Public methodNMFact(INMFUpdateAlgorithm)
Constructs an NMFact object with the given update algorithm and the default number of iterations.
Public methodNMFact(Boolean, Int32)
Constructs an NMFact with the default update algorithm and the given cost at each step and number of iterations.
Public methodNMFact(Int32, INMFUpdateAlgorithm)
Constructs an NMFact object which uses the given update algorithm to update the factors and the given number of iterations.
Public methodNMFact(Boolean, Int32, INMFUpdateAlgorithm)
Constructs an NMFact object with the given parameters for cost at each step, number of iterations and the update algorithm.
Top
Properties
  NameDescription
Public propertyComputeCostAtEachStep
If true, the error of the approximation will be computed at each iteration step. If false, only the final error will be computed.
Public propertyCost
Returns the error in the factorization in the last call to Factor. The error is computed using the Cost function in the INMFUpdateAlgorithm.
Public propertyStatic memberDefaultCostAtEachStep
Whether, by default, the cost is evaluated at each step.
Public propertyStatic memberDefaultNumIterations
Gets and sets the default number of iterations.
Public propertyStatic memberDefaultUpdateAlgorithm
Gets and sets the default update algorithm.
Public propertyH
Returns the second factor in the factorization of V = WH.
Public propertyNumIterations
Gets and sets the number of iterations to perform.
Public propertyStepCost
A DoubleVector containing the error at each iteration step if ComputeCostAtEachStep is true. Otherwise it is a vector of length one containing only the final error.
Public propertyUpdateAlgorithm
Gets and sets the algorithm used by this factorization object.
Public propertyV
Returns the matrix being factored.
Public propertyW
Returns the first factor in the factorization of V = WH.
Top
Methods
  NameDescription
Public methodClone
Creates a deep copy of this NMFact.
Public methodFactor(DataFrame, Int32)
Factors the matrix contained in data into the product WH using an iterative method. The initial values for WH are random.
Public methodFactor(DoubleMatrix, Int32)
Factors the matrix contained in data into the product WH using an iterative method. The initial values for WH are random.
Public methodFactor(DataFrame, Int32, DoubleMatrix, DoubleMatrix)
Factors the matrix contained in data into the product WH using an iterative method. The provided W and H are used as starting points for the iteration.
Public methodFactor(DoubleMatrix, Int32, DoubleMatrix, DoubleMatrix)
Factors the matrix contained in data into the product WH using an iterative method. The provided W and H are used as starting points for the iteration.
Public methodPercentExplainedVarianceFactors
Variance importance percent by factors.
Public methodPercentExplainedVarianceFullModel
Percentage of variance explained by the full model.
Top
Fields
  NameDescription
Protected fieldcomputeCostAtEachStep_
If true, the error in the approximation will be computed after each iteration step. If false, only the final error will be computed.
Protected fieldcost_
Cost.
Protected fieldH_
H.
Protected fieldnumIterations_
Number of iterations.
Protected fieldstepCost_
Step cost.
Protected fieldupdateAlgorithm_
The update algorithm.
Protected fieldV_
V.
Protected fieldW_
W.
Top
Remarks
Users can choose the number of iterations, whether the cost is computed at each step, and the update algorithm.
See Also