SigmoidFunction

java.lang.Object

mgui.interfaces.AbstractInterfaceObject

mgui.models.dynamic.functions.Function

mgui.models.dynamic.functions.SigmoidFunction

All Implemented Interfaces:: AttributeObject, InterfaceObject, NamedObject, TreeObject, CleanableObject

public class SigmoidFunction
extends Function

As the name suggests... :P Evaluates:

y = (1 - e^-kx) / (1 + e^-kx)

where k is a constant determining the shape, and evaluate(0) = 0

Author:: Andrew Reid

Field Summary

Fields inherited from class mgui.models.dynamic.functions.Function
attributes, isDestroyed

Fields inherited from class mgui.interfaces.AbstractInterfaceObject
tree_nodes
Constructor Summary

Constructors

Constructor Description

SigmoidFunction()

SigmoidFunction(double k)

Method Summary

Modifier and Type	Method	Description
`double`	`evaluate(double d)`	Evaluate function with a single parameter d
`double[]`	`evaluate(double[] d)`	Evaluate function with multiple parameters d
`double`	`getK()`
`protected void`	`init()`
`void`	`setK(double k)`
`java.lang.String`	`toString()`

Methods inherited from class mgui.models.dynamic.functions.Function

clone, destroy, getAttribute, getAttributes, getAttributeValue, getTreeNodeCopy, isDestroyed, setAttribute, setAttributes, setTreeNode

Methods inherited from class mgui.interfaces.AbstractInterfaceObject

clean, getName, getTreeLabel, issueTreeNode, setName, updateTreeNodes

Methods inherited from class java.lang.Object

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

Methods inherited from interface mgui.interfaces.NamedObject

getName, setName

Constructor Details
- SigmoidFunction
  
  public SigmoidFunction()
- SigmoidFunction
  
  public SigmoidFunction(double k)
Method Details
- init
  
  protected void init()
  
  Overrides:
  
  init in class Function
- getK
  
  public double getK()
- setK
  
  public void setK(double k)
- evaluate
  
  public double evaluate(double d)
  
  Description copied from class: Function
  
  Evaluate function with a single parameter d
  
  Specified by:
  
  evaluate in class Function
  
  Returns:
  
  result of the evaluation
- evaluate
  
  public double[] evaluate(double[] d)
  
  Description copied from class: Function
  
  Evaluate function with multiple parameters d
  
  Specified by:
  
  evaluate in class Function
  
  Returns:
  
  result of the evaluation
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class Function