Browse Source

interpolation: ported cubic spline algorithm

Signed-off-by: Christoph Ruegg <git@cdrnet.ch>
pull/2/head
Christoph Ruegg 17 years ago
parent
commit
e46f3ce529
  1. 18
      src/Managed.UnitTests/InterpolationTests/InterpolationTest.cs
  2. 383
      src/Managed/Interpolation/Algorithms/CubicSplineInterpolation.cs
  3. 56
      src/Managed/Interpolation/SplineBoundaryCondition.cs
  4. 2
      src/Managed/Managed.csproj
  5. 6
      src/Native/Native.csproj

18
src/Managed.UnitTests/InterpolationTests/InterpolationTest.cs

@ -89,6 +89,14 @@ namespace MathNet.Numerics.UnitTests.InterpolationTests
NonStandardParameters = true,
};
[VerifyContract]
public readonly IContract CubicHermiteSplineContractTests = new InterpolationContract<CubicHermiteSplineInterpolation>()
{
Factory = (t, x) => new CubicHermiteSplineInterpolation(t, x, CubicSplineInterpolation.EvaluateSplineDerivatives(t, x, SplineBoundaryCondition.Natural, 0.0, SplineBoundaryCondition.Natural, 0.0)),
Order = new[] { 1, 2, 6 },
NonStandardParameters = true,
};
[VerifyContract]
public readonly IContract LinearSplineContractTests = new InterpolationContract<LinearSplineInterpolation>()
{
@ -98,5 +106,15 @@ namespace MathNet.Numerics.UnitTests.InterpolationTests
PolynomialBehavior = false,
RationalBehavior = false
};
[VerifyContract]
public readonly IContract CubicSplineContractTests = new InterpolationContract<CubicSplineInterpolation>()
{
Factory = (t, x) => new CubicSplineInterpolation(t, x),
Order = new[] { 2, 3, 6 },
LinearBehavior = true,
PolynomialBehavior = false,
RationalBehavior = false
};
}
}

383
src/Managed/Interpolation/Algorithms/CubicSplineInterpolation.cs

@ -0,0 +1,383 @@
// <copyright file="CubicSplineInterpolation.cs" company="Math.NET">
// Math.NET Numerics, part of the Math.NET Project
// http://mathnet.opensourcedotnet.info
//
// Copyright (c) 2009 Math.NET
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
namespace MathNet.Numerics.Interpolation.Algorithms
{
using System;
using System.Collections.Generic;
using Properties;
/// <summary>
/// Cubic Spline Interpolation Algorithm with continuous first and second derivatives.
/// </summary>
/// <remarks>
/// This algorithm supports both differentiation and integration.
/// </remarks>
public class CubicSplineInterpolation : IInterpolation
{
/// <summary>
/// Internal Spline Interpolation
/// </summary>
private readonly CubicHermiteSplineInterpolation _spline;
/// <summary>
/// Initializes a new instance of the CubicSplineInterpolation class.
/// </summary>
public CubicSplineInterpolation()
{
_spline = new CubicHermiteSplineInterpolation();
}
/// <summary>
/// Initializes a new instance of the CubicSplineInterpolation class.
/// </summary>
/// <param name="samplePoints">Sample Points t, sorted ascending.</param>
/// <param name="sampleValues">Sample Values x(t)</param>
public CubicSplineInterpolation(
IList<double> samplePoints,
IList<double> sampleValues)
{
_spline = new CubicHermiteSplineInterpolation();
Initialize(samplePoints, sampleValues);
}
/// <summary>
/// Gets a value indicating whether the algorithm supports differentiation (interpolated derivative).
/// </summary>
/// <seealso cref="Differentiate(double)"/>
/// <seealso cref="Differentiate(double, out double, out double)"/>
bool IInterpolation.SupportsDifferentiation
{
get { return true; }
}
/// <summary>
/// Gets a value indicating whether the algorithm supports integration (interpolated quadrature).
/// </summary>
/// <seealso cref="Integrate"/>
bool IInterpolation.SupportsIntegration
{
get { return true; }
}
/// <summary>
/// Initialize the interpolation method with the given spline coefficients (sorted by the sample points t).
/// </summary>
/// <param name="samplePoints">Sample Points t, sorted ascending.</param>
/// <param name="sampleValues">Sample Values x(t)</param>
public void Initialize(
IList<double> samplePoints,
IList<double> sampleValues)
{
double[] derivatives = EvaluateSplineDerivatives(
samplePoints,
sampleValues,
SplineBoundaryCondition.SecondDerivative,
0.0,
SplineBoundaryCondition.SecondDerivative,
0.0);
_spline.Initialize(samplePoints, sampleValues, derivatives);
}
/// <summary>
/// Initialize the interpolation method with the given spline coefficients (sorted by the sample points t).
/// </summary>
/// <param name="samplePoints">Sample Points t, sorted ascending.</param>
/// <param name="sampleValues">Sample Values x(t)</param>
/// <param name="leftBoundaryCondition">Condition of the left boundary.</param>
/// <param name="leftBoundary">Left boundary value. Ignored in the parabolic case.</param>
/// <param name="rightBoundaryCondition">Condition of the right boundary.</param>
/// <param name="rightBoundary">Right boundary value. Ignored in the parabolic case.</param>
public void Initialize(
IList<double> samplePoints,
IList<double> sampleValues,
SplineBoundaryCondition leftBoundaryCondition,
double leftBoundary,
SplineBoundaryCondition rightBoundaryCondition,
double rightBoundary)
{
double[] derivatives = EvaluateSplineDerivatives(
samplePoints,
sampleValues,
leftBoundaryCondition,
leftBoundary,
rightBoundaryCondition,
rightBoundary);
_spline.Initialize(samplePoints, sampleValues, derivatives);
}
/// <summary>
/// Evaluate the spline derivatives as used
/// internally by this interpolation algorithm.
/// </summary>
/// <param name="samplePoints">Sample Points t, sorted ascending.</param>
/// <param name="sampleValues">Sample Values x(t)</param>
/// <param name="leftBoundaryCondition">Condition of the left boundary.</param>
/// <param name="leftBoundary">Left boundary value. Ignored in the parabolic case.</param>
/// <param name="rightBoundaryCondition">Condition of the right boundary.</param>
/// <param name="rightBoundary">Right boundary value. Ignored in the parabolic case.</param>
/// <returns>Spline Derivative Vector</returns>
public static double[] EvaluateSplineDerivatives(
IList<double> samplePoints,
IList<double> sampleValues,
SplineBoundaryCondition leftBoundaryCondition,
double leftBoundary,
SplineBoundaryCondition rightBoundaryCondition,
double rightBoundary)
{
if (null == samplePoints)
{
throw new ArgumentNullException("samplePoints");
}
if (null == sampleValues)
{
throw new ArgumentNullException("sampleValues");
}
if (samplePoints.Count < 2)
{
throw new ArgumentOutOfRangeException("samplePoints");
}
if (samplePoints.Count != sampleValues.Count)
{
throw new ArgumentException(Resources.ArgumentVectorsSameLengths);
}
int n = samplePoints.Count;
// normalize special cases
if ((n == 2)
&& (leftBoundaryCondition == SplineBoundaryCondition.ParabolicallyTerminated)
&& (rightBoundaryCondition == SplineBoundaryCondition.ParabolicallyTerminated))
{
leftBoundaryCondition = SplineBoundaryCondition.SecondDerivative;
leftBoundary = 0d;
rightBoundaryCondition = SplineBoundaryCondition.SecondDerivative;
rightBoundary = 0d;
}
if (leftBoundaryCondition == SplineBoundaryCondition.Natural)
{
leftBoundaryCondition = SplineBoundaryCondition.SecondDerivative;
leftBoundary = 0d;
}
if (rightBoundaryCondition == SplineBoundaryCondition.Natural)
{
rightBoundaryCondition = SplineBoundaryCondition.SecondDerivative;
rightBoundary = 0d;
}
double[] a1 = new double[n];
double[] a2 = new double[n];
double[] a3 = new double[n];
double[] b = new double[n];
// Left Boundary
switch (leftBoundaryCondition)
{
case SplineBoundaryCondition.ParabolicallyTerminated:
a1[0] = 0;
a2[0] = 1;
a3[0] = 1;
b[0] = 2 * (sampleValues[1] - sampleValues[0]) / (samplePoints[1] - samplePoints[0]);
break;
case SplineBoundaryCondition.FirstDerivative:
a1[0] = 0;
a2[0] = 1;
a3[0] = 0;
b[0] = leftBoundary;
break;
case SplineBoundaryCondition.SecondDerivative:
a1[0] = 0;
a2[0] = 2;
a3[0] = 1;
b[0] = (3 * ((sampleValues[1] - sampleValues[0]) / (samplePoints[1] - samplePoints[0]))) - (0.5 * leftBoundary * (samplePoints[1] - samplePoints[0]));
break;
default:
throw new NotSupportedException(Resources.InvalidLeftBoundaryCondition);
}
// Central Conditions
for (int i = 1; i < samplePoints.Count - 1; i++)
{
a1[i] = samplePoints[i + 1] - samplePoints[i];
a2[i] = 2 * (samplePoints[i + 1] - samplePoints[i - 1]);
a3[i] = samplePoints[i] - samplePoints[i - 1];
b[i] = (3 * (sampleValues[i] - sampleValues[i - 1]) / (samplePoints[i] - samplePoints[i - 1]) * (samplePoints[i + 1] - samplePoints[i])) + (3 * (sampleValues[i + 1] - sampleValues[i]) / (samplePoints[i + 1] - samplePoints[i]) * (samplePoints[i] - samplePoints[i - 1]));
}
// Right Boundary
switch (rightBoundaryCondition)
{
case SplineBoundaryCondition.ParabolicallyTerminated:
a1[n - 1] = 1;
a2[n - 1] = 1;
a3[n - 1] = 0;
b[n - 1] = 2 * (sampleValues[n - 1] - sampleValues[n - 2]) / (samplePoints[n - 1] - samplePoints[n - 2]);
break;
case SplineBoundaryCondition.FirstDerivative:
a1[n - 1] = 0;
a2[n - 1] = 1;
a3[n - 1] = 0;
b[n - 1] = rightBoundary;
break;
case SplineBoundaryCondition.SecondDerivative:
a1[n - 1] = 1;
a2[n - 1] = 2;
a3[n - 1] = 0;
b[n - 1] = (3 * (sampleValues[n - 1] - sampleValues[n - 2]) / (samplePoints[n - 1] - samplePoints[n - 2])) + (0.5 * rightBoundary * (samplePoints[n - 1] - samplePoints[n - 2]));
break;
default:
throw new NotSupportedException(Resources.InvalidRightBoundaryCondition);
}
// Build Spline
return SolveTridiagonal(a1, a2, a3, b);
}
/// <summary>
/// Evaluate the spline coefficients as used
/// internally by this interpolation algorithm.
/// </summary>
/// <param name="samplePoints">Sample Points t, sorted ascending.</param>
/// <param name="sampleValues">Sample Values x(t)</param>
/// <param name="leftBoundaryCondition">Condition of the left boundary.</param>
/// <param name="leftBoundary">Left boundary value. Ignored in the parabolic case.</param>
/// <param name="rightBoundaryCondition">Condition of the right boundary.</param>
/// <param name="rightBoundary">Right boundary value. Ignored in the parabolic case.</param>
/// <returns>Spline Coefficient Vector</returns>
public static double[] EvaluateSplineCoefficients(
IList<double> samplePoints,
IList<double> sampleValues,
SplineBoundaryCondition leftBoundaryCondition,
double leftBoundary,
SplineBoundaryCondition rightBoundaryCondition,
double rightBoundary)
{
double[] derivatives = EvaluateSplineDerivatives(
samplePoints,
sampleValues,
leftBoundaryCondition,
leftBoundary,
rightBoundaryCondition,
rightBoundary);
return CubicHermiteSplineInterpolation.EvaluateSplineCoefficients(
samplePoints,
sampleValues,
derivatives);
}
/// <summary>
/// Tridiagonal Solve Helper.
/// </summary>
/// <param name="a">The a-vector[n].</param>
/// <param name="b">The b-vector[n], will be modified by this function.</param>
/// <param name="c">The c-vector[n].</param>
/// <param name="d">The d-vector[n], will be modified by this function.</param>
/// <returns>The x-vector[n]</returns>
private static double[] SolveTridiagonal(
double[] a,
double[] b,
double[] c,
double[] d)
{
double[] x = new double[a.Length];
for (int k = 1; k < a.Length; k++)
{
double t = a[k] / b[k - 1];
b[k] = b[k] - (t * c[k - 1]);
d[k] = d[k] - (t * d[k - 1]);
}
x[x.Length - 1] = d[d.Length - 1] / b[b.Length - 1];
for (int k = x.Length - 2; k >= 0; k--)
{
x[k] = (d[k] - (c[k] * x[k + 1])) / b[k];
}
return x;
}
/// <summary>
/// Interpolate at point t.
/// </summary>
/// <param name="t">Point t to interpolate at.</param>
/// <returns>Interpolated value x(t).</returns>
public double Interpolate(double t)
{
return _spline.Interpolate(t);
}
/// <summary>
/// Differentiate at point t.
/// </summary>
/// <param name="t">Point t to interpolate at.</param>
/// <returns>Interpolated first derivative at point t.</returns>
/// <seealso cref="IInterpolation.SupportsDifferentiation"/>
/// <seealso cref="Differentiate(double, out double, out double)"/>
public double Differentiate(double t)
{
return _spline.Differentiate(t);
}
/// <summary>
/// Differentiate at point t.
/// </summary>
/// <param name="t">Point t to interpolate at.</param>
/// <param name="interpolatedValue">Interpolated value x(t)</param>
/// <param name="secondDerivative">Interpolated second derivative at point t.</param>
/// <returns>Interpolated first derivative at point t.</returns>
/// <seealso cref="IInterpolation.SupportsDifferentiation"/>
/// <seealso cref="Differentiate(double)"/>
public double Differentiate(
double t,
out double interpolatedValue,
out double secondDerivative)
{
return _spline.Differentiate(t, out interpolatedValue, out secondDerivative);
}
/// <summary>
/// Integrate up to point t.
/// </summary>
/// <param name="t">Right bound of the integration interval [a,t].</param>
/// <returns>Interpolated definite integral over the interval [a,t].</returns>
/// <seealso cref="IInterpolation.SupportsIntegration"/>
public double Integrate(double t)
{
return _spline.Integrate(t);
}
}
}

56
src/Managed/Interpolation/SplineBoundaryCondition.cs

@ -0,0 +1,56 @@
// <copyright file="SplineBoundaryCondition.cs" company="Math.NET">
// Math.NET Numerics, part of the Math.NET Project
// http://mathnet.opensourcedotnet.info
//
// Copyright (c) 2009 Math.NET
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
namespace MathNet.Numerics.Interpolation
{
/// <summary>
/// Left and right boundary conditions.
/// </summary>
public enum SplineBoundaryCondition
{
/// <summary>
/// Natural Boundary (Zero second derivative).
/// </summary>
Natural = 0,
/// <summary>
/// Parabolically Terminated boundary.
/// </summary>
ParabolicallyTerminated,
/// <summary>
/// Fixed first derivative at the boundary.
/// </summary>
FirstDerivative,
/// <summary>
/// Fixed second derivative at the boundary.
/// </summary>
SecondDerivative
}
}

2
src/Managed/Managed.csproj

@ -56,6 +56,7 @@
<Compile Include="Distributions\IDistribution.cs" />
<Compile Include="Interpolation\Algorithms\BarycentricInterpolation.cs" />
<Compile Include="Interpolation\Algorithms\BulirschStoerRationalInterpolation.cs" />
<Compile Include="Interpolation\Algorithms\CubicSplineInterpolation.cs" />
<Compile Include="Interpolation\Algorithms\CubicHermiteSplineInterpolation.cs" />
<Compile Include="Interpolation\Algorithms\FloaterHormannRationalInterpolation.cs" />
<Compile Include="Interpolation\Algorithms\LinearSplineInterpolation.cs" />
@ -63,6 +64,7 @@
<Compile Include="Interpolation\Algorithms\SplineInterpolation.cs" />
<Compile Include="Interpolation\IInterpolation.cs" />
<Compile Include="Interpolation\Interpolate.cs" />
<Compile Include="Interpolation\SplineBoundaryCondition.cs" />
<Compile Include="Precision.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="Properties\Resources.Designer.cs">

6
src/Native/Native.csproj

@ -80,6 +80,9 @@
<Compile Include="..\Managed\Interpolation\Algorithms\CubicHermiteSplineInterpolation.cs">
<Link>Interpolation\Algorithms\CubicHermiteSplineInterpolation.cs</Link>
</Compile>
<Compile Include="..\Managed\Interpolation\Algorithms\CubicSplineInterpolation.cs">
<Link>Interpolation\Algorithms\CubicSplineInterpolation.cs</Link>
</Compile>
<Compile Include="..\Managed\Interpolation\Algorithms\FloaterHormannRationalInterpolation.cs">
<Link>Interpolation\Algorithms\FloaterHormannRationalInterpolation.cs</Link>
</Compile>
@ -98,6 +101,9 @@
<Compile Include="..\Managed\Interpolation\Interpolate.cs">
<Link>Interpolation\Interpolate.cs</Link>
</Compile>
<Compile Include="..\Managed\Interpolation\SplineBoundaryCondition.cs">
<Link>Interpolation\SplineBoundaryCondition.cs</Link>
</Compile>
<Compile Include="..\Managed\Precision.cs">
<Link>Precision.cs</Link>
</Compile>

Loading…
Cancel
Save