Package org.dulab.javanmf.updaterules

Class RegularizationUpdateRule

java.lang.Object
org.dulab.javanmf.updaterules.UpdateRule
org.dulab.javanmf.updaterules.RegularizationUpdateRule
Direct Known Subclasses:
MUpdateRule
public abstract class RegularizationUpdateRule
extends UpdateRule
Provides a template for updating matrix H in the direction of minimizing the distance D(X, WH) with regularization
Author:
Du-Lab Team dulab.binf@gmail.com

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected double lambda
    l1-regularization coefficient
    protected double mu
    l2-regularization coefficient

    Fields inherited from class org.dulab.javanmf.updaterules.UpdateRule

    measure

  • Constructor Summary

    Constructors 
    Constructor Description
    RegularizationUpdateRule​(Measure measure, double lambda, double mu)
    Creates an instance of RegularizationUpdateRule with given regularization coefficients

  • Method Summary

    Methods inherited from class org.dulab.javanmf.updaterules.UpdateRule

    update

    Methods inherited from class java.lang.Object

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

  • Field Details

    • lambda

      protected final double lambda
      l1-regularization coefficient

    • mu

      protected final double mu
      l2-regularization coefficient

  • Constructor Details

    • RegularizationUpdateRule

      public RegularizationUpdateRule​(@Nonnull Measure measure, double lambda, double mu) throws java.lang.IllegalArgumentException
      Creates an instance of RegularizationUpdateRule with given regularization coefficients
      Parameters:
      measure - distance measure associated with the update rule
      lambda - l1-regularization coefficient
      mu - l2-regularization coefficient
      Throws:
      java.lang.IllegalArgumentException - If at least one of the regularization coefficients is negative