nuroko.module

Class Operator

java.lang.Object

nuroko.module.AComponent

nuroko.module.Operator

All Implemented Interfaces:

Cloneable, IComponent, IGradientTrainable, IInput, IInputOutput, IInputState, IModule, IOutput, IOutputState, IParameterised, IThinker, ITrainable

public class Operator
extends AComponent

Constructor Summary

Constructors

Constructor and Description
Operator(mikera.vectorz.Op op, int inputLength)

Method Summary

Methods

Modifier and Type	Method and Description
Operator	clone() Creates a clone of a module, including a deep copy of any mutable state.
List<IComponent>	getComponents()
mikera.vectorz.AVector	getGradient() Return an AVector referencing the accumulated gradient in this model
mikera.vectorz.Vector	getInput()
mikera.vectorz.Vector	getInputGradient()
int	getInputLength()
IInputState	getInputState()
mikera.vectorz.Vector	getOutput()
mikera.vectorz.Vector	getOutputGradient()
int	getOutputLength()
mikera.vectorz.AVector	getParameters() Return an AVector referring to the parameters in the model.
boolean	isStochastic()
void	setInput(mikera.vectorz.AVector input)
void	thinkInternal() Thinks within the scope of the component.
void	trainGradient(mikera.vectorz.AVector gradient, double factor) Trains with a output gradient, incrementing inputGradient and accumulated gradient for parameters.
void	trainGradientInternal(double factor)

Methods inherited from class nuroko.module.AComponent

getComponent, getModules, getParameterLength, setOutput, think, think, thinkInternalTraining, topComponent, train, train

Methods inherited from class java.lang.Object

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

Constructor Detail

Operator

public Operator(mikera.vectorz.Op op,
        int inputLength)

Method Detail

thinkInternal

public void thinkInternal()

Description copied from interface: IComponent

Thinks within the scope of the component. Updates component's output.

trainGradient

public void trainGradient(mikera.vectorz.AVector gradient,
                 double factor)

Description copied from interface: IGradientTrainable

Trains with a output gradient, incrementing inputGradient and accumulated gradient for parameters.

factor - TODO

trainGradientInternal

public void trainGradientInternal(double factor)

getComponents

public List<IComponent> getComponents()

getOutputLength

public int getOutputLength()

Specified by:

getOutputLength in interface IOutput

Overrides:

getOutputLength in class AComponent

getGradient

public mikera.vectorz.AVector getGradient()

Description copied from interface: IParameterised

Return an AVector referencing the accumulated gradient in this model

Returns:

getParameters

public mikera.vectorz.AVector getParameters()

Description copied from interface: IParameterised

Return an AVector referring to the parameters in the model. Expected to be mutable.

Returns:

clone

public Operator clone()

Description copied from interface: IModule

Creates a clone of a module, including a deep copy of any mutable state.

Specified by:

clone in interface IComponent

Specified by:

clone in interface IModule

Specified by:

clone in interface IParameterised

Specified by:

clone in interface IThinker

Specified by:

clone in interface ITrainable

Specified by:

clone in class AComponent

Returns:

getInputLength

public int getInputLength()

Specified by:

getInputLength in interface IInput

Overrides:

getInputLength in class AComponent

isStochastic

public boolean isStochastic()

Specified by:

isStochastic in interface IComponent

Overrides:

isStochastic in class AComponent

getInputState

public IInputState getInputState()

Specified by:

getInputState in interface IComponent

Overrides:

getInputState in class AComponent

getInput

public mikera.vectorz.Vector getInput()

getOutput

public mikera.vectorz.Vector getOutput()

getOutputGradient

public mikera.vectorz.Vector getOutputGradient()

setInput

public void setInput(mikera.vectorz.AVector input)

Specified by:

setInput in interface IInputState

Overrides:

setInput in class AComponent

getInputGradient

public mikera.vectorz.Vector getInputGradient()