// Copyright (C) Stichting Deltares 2018. All rights reserved.
//
// This file is part of the Dam Engine.
//
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

namespace Deltares.DamEngine.Data.Standard
{
    /// <summary>
    /// Static class GeneralMathRoutines
    /// </summary>
    public static class GeneralMathRoutines
    {
        /// <summary>
        /// Perform linear interpolation between two values.
        /// </summary>
        /// <param name="v0">First value.</param>
        /// <param name="v1">Second value.</param>
        /// <param name="fraction">The fraction in the range [0.0, 1.0].</param>
        /// <returns>Returns <paramref name="v0"/> if <paramref name="fraction"/> is 0.0,
        /// returns <paramref name="v1"/> when it's 1.0, otherwise returns the linearly 
        /// interpolated value of the two given values.</returns>
        public static double LinearInterpolate(double v0, double v1, double fraction)
        {
            return (1.0 - fraction)*v0 + fraction*v1;
        }                       
    }
}