Package org.dulab.javanmf.updaterules

Class UpdateRule

java.lang.Object

org.dulab.javanmf.updaterules.UpdateRule

Direct Known Subclasses:

RegularizationUpdateRule

public abstract class UpdateRule
extends java.lang.Object

Provides a template for updating matrix H in the direction of minimizing the distance D(X, WH)

Author:

Du-Lab Team dulab.binf@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
Measure	measure	Instance of Measure associated with this update rule

Constructor Summary

Constructors

Constructor	Description
UpdateRule(Measure measure)	Creates an instance of UpdateRule

Method Summary

Modifier and Type	Method	Description
abstract double	update(org.ejml.data.DMatrixRMaj x, org.ejml.data.DMatrixRMaj w, org.ejml.data.DMatrixRMaj h)	Updates matrix H to minimize distance between X and WH

Methods inherited from class java.lang.Object

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

Field Details

measure

public final Measure measure

Instance of Measure associated with this update rule

Constructor Details

UpdateRule

public UpdateRule(@Nonnull Measure measure)

Creates an instance of UpdateRule

Parameters:

measure - instance of Measure associated with the update rule

Method Details

update

public abstract double update(@Nonnull org.ejml.data.DMatrixRMaj x, @Nonnull org.ejml.data.DMatrixRMaj w, @Nonnull org.ejml.data.DMatrixRMaj h)

Updates matrix H to minimize distance between X and WH

Parameters:

x - matrix of shape [N_points, N_vectors]

w - matrix of shape [N_points, N_components]

h - matrix of shape [N_components, N_vectors]

Returns:

increment of |H|