ca.nengo.model.impl

Class NoiseFactory.NoiseImplFunction

java.lang.Object

ca.nengo.model.impl.NoiseFactory.NoiseImplFunction

All Implemented Interfaces:

Noise, Resettable, java.io.Serializable, java.lang.Cloneable

Enclosing class:

NoiseFactory

public static class NoiseFactory.NoiseImplFunction
extends java.lang.Object
implements Noise

Note: there are no public setters here for the same reason as in NoiseImplPDF.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ca.nengo.model.Noise

Noise.Noisy

Field Summary

Fields inherited from interface ca.nengo.model.Noise

DIMENSION_PROPERTY

Constructor Summary

Constructors

Constructor and Description
NoiseFactory.NoiseImplFunction() Default zero noise.
NoiseFactory.NoiseImplFunction(Function function)

Method Summary

Methods

Modifier and Type	Method and Description
Noise	clone()
Function	getFunction()
float	getValue(float startTime, float endTime, float input)
void	reset(boolean randomize)

Methods inherited from class java.lang.Object

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

Constructor Detail

NoiseFactory.NoiseImplFunction

public NoiseFactory.NoiseImplFunction(Function function)

Parameters:

function - A function of time that explicitly defines the noise

NoiseFactory.NoiseImplFunction

public NoiseFactory.NoiseImplFunction()

Default zero noise.

Method Detail

getFunction

public Function getFunction()

Returns:

The function of time that explicitly defines the noise

getValue

public float getValue(float startTime,
             float endTime,
             float input)

Specified by:

getValue in interface Noise

Parameters:

startTime - Simulation time at which step starts

endTime - Simulation time at which step ends

input - Value which is to be corrupted by noise

Returns:

The noisy values (inputs corrupted by noise)

See Also:

Noise.getValue(float, float, float)

clone

public Noise clone()

Specified by:

clone in interface Noise

Overrides:

clone in class java.lang.Object

Returns:

Valid clone

reset

public void reset(boolean randomize)

Specified by:

reset in interface Resettable

Parameters:

randomize - True indicates that the object should be reset to a randomly selected initial state (the object must be aware of the distribution from which to draw from). False indicates that the object should be reset to a fixed initial state (which it must also know). Some objects may not support randomization of the initial state, in which case a fixed state will be used in either case.

See Also:

Resettable.reset(boolean)