﻿// Accord Statistics Library
// The Accord.NET Framework
// http://accord-framework.net
//
// Copyright © César Souza, 2009-2014
// cesarsouza at gmail.com
//
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//
//    This library 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
//    Lesser General Public License for more details.
//
//    You should have received a copy of the GNU Lesser General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//

namespace Accord.Statistics.Distributions.Fitting
{
    using System;
    using Accord.Statistics.Distributions.Univariate;

    /// <summary>
    ///   Estimation options for <see cref="Accord.Statistics.Distributions.Univariate.EmpiricalDistribution">
    ///   Empirical distributions</see>. 
    /// </summary>
    /// 
    [Serializable]
    public class EmpiricalOptions : IFittingOptions
    {
        /// <summary>
        ///   Gets or sets the smoothing rule used to compute the smoothing
        ///   parameter in the <see cref="EmpiricalDistribution"/>. Default
        ///   is to use the <see cref="EmpiricalDistribution.SmoothingRule">
        ///   normal distribution bandwidth approximation</see>.
        /// </summary>
        /// 
        public Func<double[], double> SmoothingRule { get; set; }

        /// <summary>
        ///   Initializes a new instance of the <see cref="NormalOptions"/> class.
        /// </summary>
        /// 
        public EmpiricalOptions()
        {
            SmoothingRule = EmpiricalDistribution.SmoothingRule;
        }
    }
}
