namespace Chernobyl.Calculator
{
    /// <summary>
    /// Provides a base class for classes that can do
    /// calculations on types. This class was created to
    /// get around C#'s generic operator problem.
    /// </summary>
    /// <typeparam name="T">The type having calculations done on it.</typeparam>
    public interface ICalculator<T>
    {
        /// <summary>
        /// Adds one object to another.
        /// </summary>
        /// <param name="left">The left side of the addition operation.</param>
        /// <param name="right">The right side of the addition operation.</param>
        /// <returns>The result of the addition.</returns>
        T Add(T left, T right);

        /// <summary>
        /// Subtracts one object from another.
        /// </summary>
        /// <param name="left">The left side of the subtraction operation.</param>
        /// <param name="right">The right side of the subtraction operation.</param>
        /// <returns>The result of the subtraction.</returns>
        T Subtract(T left, T right);

        /// <summary>
        /// Divides two objects.
        /// </summary>
        /// <param name="dividend">The dividend.</param>
        /// <param name="divisor">The divisor.</param>
        /// <returns>The result of the divide.</returns>
        T Divide(T dividend, T divisor);

        /// <summary>
        /// Multiplies two objects together.
        /// </summary>
        /// <param name="left">The left side of the multiplication operation.</param>
        /// <param name="right">The right side of the multiplication operation.</param>
        /// <returns>The result of the multiplication.</returns>
        T Multiply(T left, T right);

        /// <summary>
        /// Negates an object.
        /// </summary>
        /// <param name="item">The item to negate.</param>
        /// <returns>The result of the negation.</returns>
        T Negate(T item);

        /// <summary>
        /// Compares two objects.
        /// </summary>
        /// <param name="left">The left side of the comparison operation.</param>
        /// <param name="right">The right side of the comparison operation.</param>
        /// <returns>True if the two are the same, false if otherwise.</returns>
        bool Compare(T left, T right);
    }
}