org.oakgp.function.compare

Class Equal

java.lang.Object

org.oakgp.function.compare.Equal

All Implemented Interfaces:

Function

public final class Equal
extends Object

Determines if two objects are equal.

Note: Equality is checked using Comparable#compareTo(Object) rather than Object#equals(Object).

Constructor Summary

Constructors

Constructor and Description
Equal(Type type) Constructs a function that compares two arguments of the specified type.

Method Summary

Modifier and Type	Method and Description
Object	evaluate(Arguments arguments, Assignments assignments) Returns the result of applying this operation to the specified Arguments and Assignments.
protected boolean	evaluate(int diff)
String	getDisplayName() Returns the String value to use in the textual representation of this function.
Signature	getSignature() Returns the return type and argument types associated with this function.
Node	simplify(Arguments arguments) Attempts to find a simplified alternative to applying this function to the specified arguments.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oakgp.function.Function

isPure

Constructor Detail

Equal

public Equal(Type type)

Constructs a function that compares two arguments of the specified type.

Method Detail

evaluate

protected boolean evaluate(int diff)

simplify

public Node simplify(Arguments arguments)

Description copied from interface: Function

Attempts to find a simplified alternative to applying this function to the specified arguments.

Simplification can occur by replacing expressions with constant values (e.g. replacing (+ 1 1) with 2) or removing redundant branches (e.g. replacing (if (< 2 3) (+ v0 v1) (* v0 v1)) with (+ v0 v1).

Specified by:

simplify in interface Function

Parameters:

arguments - the arguments to be applied to (i.e. evaluated by) this function

Returns:

a simplified version of applying this function to the specified arguments, or null if unable to simplify.

See Also:

NodeSimplifier

getDisplayName

public String getDisplayName()

Description copied from interface: Function

Returns the String value to use in the textual representation of this function.

evaluate

public final Object evaluate(Arguments arguments,
                             Assignments assignments)

Description copied from interface: Function

Returns the result of applying this operation to the specified Arguments and Assignments.

Specified by:

evaluate in interface Function

Parameters:

arguments - represents the arguments to apply to the operation

assignments - represents values assigned to variables belonging to arguments

Returns:

the result of applying this operation to the arguments and assignments

getSignature

public final Signature getSignature()

Description copied from interface: Function

Returns the return type and argument types associated with this function.

Specified by:

getSignature in interface Function