//                                               -*- C++ -*-
/**
 *  @brief This class acts like a (possibly truncated) KernelMixture factory, implementing density estimation
 *         using the kernel smoothing method. It uses Silverman's rule for product kernel.
 *
 *  Copyright 2005-2024 Airbus-EDF-IMACS-ONERA-Phimeca
 *
 *  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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef OPENTURNS_KERNELSMOOTHING_HXX
#define OPENTURNS_KERNELSMOOTHING_HXX

#include "openturns/DistributionFactoryImplementation.hxx"
#include "openturns/Distribution.hxx"
#include "openturns/KernelMixture.hxx"
#include "openturns/Mixture.hxx"
#include "openturns/TruncatedDistribution.hxx"
#include "openturns/Sample.hxx"

BEGIN_NAMESPACE_OPENTURNS

/**
 * @class KernelSmoothing
 *
 * The class describes the probabilistic concept of KernelSmoothing.
 */
class OT_API KernelSmoothing
  : public DistributionFactoryImplementation
{
  CLASSNAME
public:

  enum BoundingOption { NONE = 0, LOWER, UPPER, BOTH };

  /** Default constructor */
  KernelSmoothing();

  /** Parameter constructor */
  explicit KernelSmoothing(const Distribution & kernel,
                           const Bool binned = true,
                           const UnsignedInteger binNumber = ResourceMap::GetAsUnsignedInteger("KernelSmoothing-BinNumber"),
                           const Bool boundaryCorrection = false);

  /** Virtual constructor */
  KernelSmoothing * clone() const override;

  /** Build a Normal kernel mixture based on the given sample. If no bandwidth has already been set, Silverman's rule is used */
  using DistributionFactoryImplementation::build;
  Distribution build(const Sample & sample) const override;

  /** Build a (possibly truncated) kernel mixture based on the given sample and bandwidth */
  Distribution build(const Sample & sample, const Point & bandwidth) const;

  KernelMixture buildAsKernelMixture(const Sample & sample, const Point & bandwidth) const;

  Mixture buildAsMixture(const Sample & sample, const Point & bandwidth) const;

  TruncatedDistribution buildAsTruncatedDistribution(const Sample & sample, const Point & bandwidth) const;

  /** Bandwidth accessor */
  Point getBandwidth() const;

  /** Kernel accessor */
  Distribution getKernel() const;

  /* Boundary correction accessor, shortcut for setBoundingOption(NONE) or setBoundingOption(BOTH) */
  void setBoundaryCorrection(const Bool boundaryCorrection);

  /* Boundary correction accessor */
  void setBoundingOption(const BoundingOption boundingOption);

  /* Boundary accessor */
  void setLowerBound(const Scalar lowerBound);
  void setUpperBound(const Scalar upperBound);

  /* Automatic boundary accessor */
  void setAutomaticLowerBound(const Bool automaticLowerBound);
  void setAutomaticUpperBound(const Bool automaticUpperBound);

  /** Compute the bandwidth according to Silverman's rule */
  Point computeSilvermanBandwidth(const Sample & sample) const;

  /** Compute the bandwidth according to the plugin rule. Warning!
   * it can take a lot of time for large samples, as the cost is
   * quadratic with the sample size
   */
  Point computePluginBandwidth(const Sample & sample) const;

  /** Compute the bandwidth according to a mixed rule:
   * simply use the plugin rule for small sample, and
   * estimate the ratio between the plugin rule and
   * the Silverman rule on a small sample, then
   * scale the Silverman bandwidth computed on the full
   * sample with this ratio
   */
  Point computeMixedBandwidth(const Sample & sample) const;

  /** Method save() stores the object through the StorageManager */
  void save(Advocate & adv) const override;

  /** Method load() reloads the object from the StorageManager */
  void load(Advocate & adv) override;

private:

  void setBandwidth(const Point & bandwidth) const;

  // Bandwidth of the smoothing
  mutable Point bandwidth_;

  // 1D kernel for kernel product
  Distribution kernel_;

  // Flag to tell if we compute a binned version of the estimator
  Bool binned_;

  // Number of bins in each dimension
  UnsignedInteger binNumber_;

  // Direction of the boundary treatment
  BoundingOption boundingOption_;

  // Known bounds
  Scalar lowerBound_;
  Bool automaticLowerBound_;
  Scalar upperBound_;
  Bool automaticUpperBound_;

}; /* class KernelSmoothing */


END_NAMESPACE_OPENTURNS

#endif /* OPENTURNS_KERNELSMOOTHING_HXX */
