org.simbrain.network.neuron_update_rules.interfaces

Interface ClippableUpdateRule

All Known Implementing Classes:

DecayRule, IACRule, LinearRule, LogisticRule

public interface ClippableUpdateRule

Interface for update rules which can clip their values above and below upper and lower bounds (clipping can be turned on or off). Thus ClippableUpdateRules are always BoundedUpdateRules (but some BoundedUpdateRules, like sigmoidal, are not Clippable, since they have intrinsic bounds).

Author:

Zach Tosi, Jeff Yoshimi

Method Summary

Modifier and Type	Method and Description
double	clip(double val) Clip the current activation.
boolean	isClipped() Is clipping turned on or not.
void	setClipped(boolean clipping) Turn clipping on and off.

Method Detail

clip

double clip(double val)

Clip the current activation.

Parameters:

val - the value to clip

Returns:

the clipped value

isClipped

boolean isClipped()

Is clipping turned on or not.

Returns:

true if clipping is on; false if it's turned off

setClipped

void setClipped(boolean clipping)

Turn clipping on and off.

Parameters:

clipping - true if clipping should be on; false otherwise