12 changed files with 213 additions and 64 deletions
@ -0,0 +1,103 @@ |
|||
// <copyright file="AbsoluteReturnMeasures.cs" company="Math.NET">
|
|||
// Math.NET Numerics, part of the Math.NET Project
|
|||
// http://numerics.mathdotnet.com
|
|||
// http://github.com/mathnet/mathnet-numerics
|
|||
// http://mathnetnumerics.codeplex.com
|
|||
//
|
|||
// Copyright (c) 2009-2010 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.Financial |
|||
{ |
|||
using System; |
|||
using System.Collections.Generic; |
|||
using System.Linq; |
|||
using System.Text; |
|||
using MathNet.Numerics.Statistics; |
|||
|
|||
public static class AbsoluteReturnMeasures |
|||
{ |
|||
/// <summary>
|
|||
/// Compound Monthly Return or Geometric Return or Annualized Return
|
|||
/// </summary>
|
|||
/// <param name="data"></param>
|
|||
/// <returns></returns>
|
|||
public static double CompoundMonthlyReturn(this IEnumerable<double> data) |
|||
{ |
|||
if (data == null) |
|||
{ |
|||
throw new ArgumentNullException("data"); |
|||
} |
|||
|
|||
var samples = data.Count(); |
|||
if (samples == 0) |
|||
return double.NaN; |
|||
|
|||
double compoundReturn = 1.0; |
|||
foreach (var item in data) |
|||
{ |
|||
compoundReturn *= (1 + item); |
|||
} |
|||
return Math.Pow(compoundReturn, 1.0 / (double)samples) - 1.0; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Average Gain or Gain Mean
|
|||
/// This is a simple average (arithmetic mean) of the periods with a gain. It is calculated by summing the returns for gain periods (return 0)
|
|||
/// and then dividing the total by the number of gain periods.
|
|||
/// </summary>
|
|||
/// <param name="data"></param>
|
|||
/// <returns></returns>
|
|||
/// <remarks>http://www.offshore-library.com/kb/statistics.php</remarks>
|
|||
public static double GainMean(this IEnumerable<double> data) |
|||
{ |
|||
if (data == null) |
|||
{ |
|||
throw new ArgumentNullException("data"); |
|||
} |
|||
|
|||
var gains = data.Where(x => x >= 0); |
|||
return gains.Mean(); |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Average Loss or LossMean
|
|||
/// This is a simple average (arithmetic mean) of the periods with a loss. It is calculated by summing the returns for loss periods (return < 0)
|
|||
/// and then dividing the total by the number of loss periods.
|
|||
/// </summary>
|
|||
/// <param name="data"></param>
|
|||
/// <returns></returns>
|
|||
/// <remarks>http://www.offshore-library.com/kb/statistics.php</remarks>
|
|||
public static double LossMean(this IEnumerable<double> data) |
|||
{ |
|||
if (data == null) |
|||
{ |
|||
throw new ArgumentNullException("data"); |
|||
} |
|||
|
|||
var losses = data.Where(x => x < 0); |
|||
return losses.Mean(); |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,75 @@ |
|||
// <copyright file="CompoundMonthlyReturnTests.cs" company="Math.NET">
|
|||
// Math.NET Numerics, part of the Math.NET Project
|
|||
// http://numerics.mathdotnet.com
|
|||
// http://github.com/mathnet/mathnet-numerics
|
|||
// http://mathnetnumerics.codeplex.com
|
|||
// Copyright (c) 2009-2010 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.UnitTests.FinancialTests |
|||
{ |
|||
using System; |
|||
using System.Collections.Generic; |
|||
using System.Linq; |
|||
using System.Text; |
|||
using MathNet.Numerics.Financial; |
|||
using NUnit.Framework; |
|||
|
|||
[TestFixture] |
|||
[Category("FinancialTests")] |
|||
public class CompoundMonthlyReturnTests |
|||
{ |
|||
[Test] |
|||
[ExpectedException(typeof(ArgumentNullException))] //assert
|
|||
public void throws_when_input_data_is_null() |
|||
{ |
|||
//arrange
|
|||
List<double> inputData = null; |
|||
//act
|
|||
inputData.CompoundMonthlyReturn(); |
|||
} |
|||
|
|||
[Test] |
|||
public void returns_undefined_with_empty_input_data() |
|||
{ |
|||
//arrange
|
|||
List<double> inputData = new List<double>(); |
|||
//act
|
|||
var cmpdReturn = inputData.CompoundMonthlyReturn(); |
|||
//assert
|
|||
Assert.AreEqual(double.NaN, cmpdReturn); |
|||
} |
|||
|
|||
[Test] |
|||
public void calculates_the_compound_monthly_return() |
|||
{ |
|||
//arrange
|
|||
var inputData = new[] { 0.2, 0.06, 0.01 }; |
|||
//act
|
|||
var cmpdReturn = inputData.CompoundMonthlyReturn(); |
|||
//assert
|
|||
AssertHelpers.AlmostEqual(0.0870999982199265, cmpdReturn, 15); |
|||
} |
|||
|
|||
//Definitly need more tests here. Would love to find test data for these stats similar to the .dat files used for other tests.
|
|||
} |
|||
|
|||
} |
|||
Loading…
Reference in new issue