NMFStrategy: Factory Method for NMFStrategy Objects

In renozao/NMF: Algorithms and Framework for Nonnegative Matrix Factorization (NMF)

Description

Creates NMFStrategy objects that wraps implementation of NMF algorithms into a unified interface.

Usage

NMFStrategy(name, method, ...)

## S4 method for signature 'character,'function''
NMFStrategy(name, method, ...)

## S4 method for signature 'character,NMFStrategy'
NMFStrategy(name, method, ...)

## S4 method for signature 'NMFStrategy,missing'
NMFStrategy(name, method, ...)

## S4 method for signature 'missing,character'
NMFStrategy(name, method, ...)

## S4 method for signature ''NULL',NMFStrategy'
NMFStrategy(name, method, ...)

## S4 method for signature 'character,character'
NMFStrategy(name, method, ...)

## S4 method for signature ''NULL',character'
NMFStrategy(name, method, ...)

## S4 method for signature 'character,missing'
NMFStrategy(name, method, ...)

Arguments

name	name/key of an NMF algorithm.
method	definition of the algorithm
...	extra arguments passed to new.

Methods (by generic)

nmfFormals:

• nmfFormals(NMFStrategy): Returns the extra arguments that can be passed to an algorithm encapsulated in an NMFStrategy object.

  Arguments that have default values defined by the strategy are set accordingly.

NMFStrategy:

• NMFStrategy(name = character,method = function): Creates an NMFStrategyFunction object that wraps the function method into a unified interface.

  method must be a function with signature (y="matrix", x="NMFfit", ...), and return an object of class NMFfit.

• NMFStrategy(name = character,method = NMFStrategy): Creates an NMFStrategy object based on a template object (Constructor-Copy).

• NMFStrategy(name = NMFStrategy,method = missing): Creates an NMFStrategy based on a template object (Constructor-Copy), in particular it uses the same name.

• NMFStrategy(name = missing,method = character): Creates an NMFStrategy based on a registered NMF algorithm that is used as a template (Constructor-Copy), in particular it uses the same name.

  It is a shortcut for NMFStrategy(nmfAlgorithm(method, exact=TRUE), ...).

• NMFStrategy(name = NULL,method = NMFStrategy): Creates an NMFStrategy based on a template object (Constructor-Copy) but using a randomly generated name.

• NMFStrategy(name = character,method = character): Creates an NMFStrategy based on a registered NMF algorithm that is used as a template.

• NMFStrategy(name = NULL,method = character): Creates an NMFStrategy based on a registered NMF algorithm (Constructor-Copy) using a randomly generated name.

  It is a shortcut for NMFStrategy(NULL, nmfAlgorithm(method), ...).

• NMFStrategy(name = character,method = missing): Creates an NMFStrategy, determining its type from the extra arguments passed in ...: if there is an argument named Update then an NMFStrategyIterative is created, or if there is an argument named algorithm then an NMFStrategyFunction is created. Calls other than these generates an error.

renozao/NMF documentation built on June 14, 2020, 9:35 p.m.