org.cognity.math.functions

Class BipolarStep

java.lang.Object

org.cognity.math.functions.BipolarStep

All Implemented Interfaces:

Serializable, Function

public final class BipolarStep
extends Object
implements Function, Serializable

Implements the bipolar step function. This function is defined as follows:

It is also known as the Heaviside step function.

Author:

Artur Markiewicz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BipolarStep()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Two functions are equal if they return the same values for all possible arguments.
double	getDeriv(double arg) Returns a value of the first derivative of the function for the given argument.
double	getValue(double arg) Returns a value of the function for the given argument.
boolean	hasDeriv() Returns true if the function is differentiable.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BipolarStep

public BipolarStep()

Method Detail

getValue

public double getValue(double arg)

Description copied from interface: Function

Returns a value of the function for the given argument.

Specified by:

getValue in interface Function

Parameters:

arg - the argument

Returns:

the value of the function for the given argument

getDeriv

public double getDeriv(double arg)

Description copied from interface: Function

Returns a value of the first derivative of the function for the given argument.

Specified by:

getDeriv in interface Function

Parameters:

arg - the argument

Returns:

the value of the first derivative of the function for the given argument

hasDeriv

public boolean hasDeriv()

Description copied from interface: Function

Returns true if the function is differentiable.

Specified by:

hasDeriv in interface Function

Returns:

• true - if the function has a first derivative
• false - if the function hasn't a first derivative

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Two functions are equal if they return the same values for all possible arguments.

Overrides:

equals in class Object

Parameters:

obj - the object to compare

Returns:

true if objects are equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object