MOEAFramework-2.10.src.org.moeaframework.util.tree.Equals Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of moeaframework Show documentation

The MOEA Framework Maven Distribution

There is a newer version: 4.4

/* Copyright 2009-2016 David Hadka
 *
 * This file is part of the MOEA Framework.
 *
 * The MOEA Framework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * The MOEA Framework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the MOEA Framework.  If not, see .
 */
package org.moeaframework.util.tree;

/**
 * The node for comparing two numbers for equality.  The inputs and
 * outputs to this node are shown below:
 * 
 * 
 *   
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *   
 * Name Type Description
Argument 1 Number The first number
Argument 2 Number The second number
Return Value Boolean {@code true} if the two numbers equals; {@code false} otherwise
 */
public class Equals extends Node {
	
	/**
	 * Constructs a new node for comparing two numbers for equality.
	 */
	public Equals() {
		super(Boolean.class, Number.class, Number.class);
	}

	@Override
	public Equals copyNode() {
		return new Equals();
	}

	@Override
	public Boolean evaluate(Environment environment) {
		return NumberArithmetic.equals(
				(Number)getArgument(0).evaluate(environment),
				(Number)getArgument(1).evaluate(environment));
	}

}

Name	Type	Description
Argument 1	Number	The first number
Argument 2	Number	The second number
Return Value	Boolean	{@code true} if the two numbers equals; {@code false} otherwise