com.thesett.aima.logic.fol.DoubleLiteral Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aima Show documentation
Library of code developed from 'Artificial Intelligence a Modern Approach', Prentice Hall.
There is a newer version: 0.8.3
/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.thesett.aima.logic.fol;

/**
 * Defines the basic double type.
 *
 * 
 * CRC Card Responsibilities  Collaborations
 * 
 Define the basic double type.
 * 
 *
 * @author Rupert Smith
 */
public class DoubleLiteral extends RealType
{
    /** Holds the value of the number. */
    private double value;

    /**
     * Creates a new number with the specified value.
     *
     * @param value The value of the number.
     */
    public DoubleLiteral(double value)
    {
        this.value = value;
    }

    /**
     * Determines whether a number is of basic type double.
     *
     * @return true if a number is a double, false otherwise.
     */
    public boolean isDouble()
    {
        return true;
    }

    /**
     * Gets the value of the number converted to an int.
     *
     * @return The value of the number as int.
     */
    public int intValue()
    {
        return (int) value;
    }

    /**
     * Gets the value of the number converted to a long.
     *
     * @return The value of the number as long.
     */
    public long longValue()
    {
        return (long) value;
    }

    /**
     * Gets the value of the number converted to a float.
     *
     * @return The value of the number as float.
     */
    public float floatValue()
    {
        return (float) value;
    }

    /**
     * Gets the value of the number converted to a double.
     *
     * @return The value of the number as double.
     */
    public double doubleValue()
    {
        return value;
    }

    /**
     * Determines if this number is equal to another.
     *
     * @param  comparator The object to compare to.
     *
     * @return true if the comparator is a number equal in value to this one, false otherwise.
     */
    public boolean equals(Object comparator)
    {
        if (this == comparator)
        {
            return true;
        }

        if ((comparator == null) || !(comparator instanceof NumericType))
        {
            return false;
        }

        NumericType comparatorNumber = (NumericType) comparator;

        return value == comparatorNumber.doubleValue();
    }

    /**
     * Computes a hash code based on the value of this number.
     *
     * @return A hash code based on the value of this number.
     */
    public int hashCode()
    {
        long temp = (value != +0.0d) ? java.lang.Double.doubleToLongBits(value) : 0L;

        return (int) (temp ^ (temp >>> 32));
    }

    /**
     * Pretty prints the value of this number, mostly for debugging purposes.
     *
     * @return The value of this number as a string.
     */
    public String toString()
    {
        return "DoubleLiteral: [ value = " + value + " ]";
    }

    /** {@inheritDoc} */
    public String toString(VariableAndFunctorInterner interner, boolean printVarName, boolean printBindings)
    {
        return Double.toString(value);
    }
}