//                                               -*- C++ -*-
/**
 *  @brief ProcessSample Class
 *
 *  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/>.
 *
 */

#include "openturns/ProcessSample.hxx"

BEGIN_NAMESPACE_OPENTURNS

CLASSNAMEINIT(ProcessSample)

ProcessSample::ProcessSample()
  : TypedInterfaceObject<ProcessSampleImplementation>(new ProcessSampleImplementation)
{
  // Nothing to do
}

/* Default constructor */
ProcessSample::ProcessSample(const UnsignedInteger size,
                             const Field & field)
  : TypedInterfaceObject<ProcessSampleImplementation>(new ProcessSampleImplementation(size, field))
{
  // Nothing to do
}

ProcessSample::ProcessSample(const Mesh & mesh,
                             const UnsignedInteger size,
                             const UnsignedInteger dimension)
  : TypedInterfaceObject<ProcessSampleImplementation>(new ProcessSampleImplementation(mesh, size, dimension))
{
  // Nothing to do
}

ProcessSample::ProcessSample(const Mesh & mesh,
                             const SampleCollection & collection)
  : TypedInterfaceObject<ProcessSampleImplementation>(new ProcessSampleImplementation(mesh, collection))
{
  // Nothing to do
}

/* Parameters constructor */
ProcessSample::ProcessSample(const ProcessSampleImplementation & implementation)
  : TypedInterfaceObject<ProcessSampleImplementation>(implementation.clone())
{
  // Nothing to do
}

/* Constructor from implementation */
ProcessSample::ProcessSample(const Implementation & p_implementation)
  : TypedInterfaceObject<ProcessSampleImplementation>(p_implementation)
{
  // Nothing to do
}

/* Constructor from implementation pointer */
ProcessSample::ProcessSample(ProcessSampleImplementation * p_implementation)
  : TypedInterfaceObject<ProcessSampleImplementation>(p_implementation)
{
  // Nothing to do
}

/* String converter */
String ProcessSample::__repr__() const
{
  return getImplementation()->__repr__();
}

String ProcessSample::__str__(const String & offset) const
{
  return getImplementation()->__str__(offset);
}

/* Partial copy constructor */
void ProcessSample::add(const Field & field)
{
  copyOnWrite();
  getImplementation()->add(field);
}

void ProcessSample::add(const Sample & values)
{
  copyOnWrite();
  getImplementation()->add(values);
}

void ProcessSample::erase(const UnsignedInteger index)
{
  copyOnWrite();
  getImplementation()->erase(index, index + 1);
}

void ProcessSample::erase(const UnsignedInteger first, const UnsignedInteger last)
{
  copyOnWrite();
  getImplementation()->erase(first, last);
}

void ProcessSample::clear()
{
  copyOnWrite();
  getImplementation()->clear();
}


/* Operators accessors */
Field ProcessSample::getField(const UnsignedInteger index) const
{
  return getImplementation()->getField(index);
}

void ProcessSample::setField(const Field & field,
                             const UnsignedInteger index)
{
  copyOnWrite();
  getImplementation()->setField(field, index);
}

Sample & ProcessSample::operator[] (const UnsignedInteger index)
{
  copyOnWrite();
  return getImplementation()->operator[](index);
}

const Sample & ProcessSample::operator[] (const UnsignedInteger index) const
{
  return getImplementation()->operator[](index);
}

/* Time grid accessors */
RegularGrid ProcessSample::getTimeGrid() const
{
  return getImplementation()->getTimeGrid();
}

/* Mesh accessors */
Mesh ProcessSample::getMesh() const
{
  return getImplementation()->getMesh();
}

/* Dimension accessors */
UnsignedInteger ProcessSample::getDimension() const
{
  return getImplementation()->getDimension();
}

/* Dimension accessors */
UnsignedInteger ProcessSample::getSize() const
{
  return getImplementation()->getSize();
}

/* Mean accessor */
Field ProcessSample::computeMean() const
{
  return getImplementation()->computeMean();
}

/* Compute the sample of spatial means of each field */
Sample ProcessSample::computeTemporalMean() const
{
  return getImplementation()->computeTemporalMean();
}

/* Compute the sample of spatial means of each field */
Sample ProcessSample::computeSpatialMean() const
{
  return getImplementation()->computeSpatialMean();
}

/* Standard deviation accessor */
Field ProcessSample::computeStandardDeviation() const
{
  return getImplementation()->computeStandardDeviation();
}

/* Gives the range of the sample (by component) */
Field ProcessSample::computeRange() const
{
  return getImplementation()->computeRange();
}

/* Gives the median of the sample (by component) */
Field ProcessSample::computeMedian() const
{
  return getImplementation()->computeMedian();
}

/* Gives the variance of the sample (by component) */
Field ProcessSample::computeVariance() const
{
  return getImplementation()->computeVariance();
}

/* Gives the skewness of the sample (by component) */
Field ProcessSample::computeSkewness() const
{
  return getImplementation()->computeSkewness();
}

/* Gives the kurtosis of the sample (by component) */
Field ProcessSample::computeKurtosis() const
{
  return getImplementation()->computeKurtosis();
}

/* Gives the central moment of order k of the sample (by component) */
Field ProcessSample::computeCentralMoment(const UnsignedInteger k) const
{
  return getImplementation()->computeCentralMoment(k);
}

/* Gives the raw moment of order k of the sample (by component) */
Field ProcessSample::computeRawMoment(const UnsignedInteger k) const
{
  return getImplementation()->computeRawMoment(k);
}

/* Get the empirical CDF of the sample */
Field ProcessSample::computeEmpiricalCDF(const Point & point,
    const Bool tail) const
{
  return getImplementation()->computeEmpiricalCDF(point, tail);
}

/* Maximum accessor */
Field ProcessSample::getMax() const
{
  return getImplementation()->getMax();
}

/* Minimum accessor */
Field ProcessSample::getMin() const
{
  return getImplementation()->getMin();
}

/* Method computeQuantilePerComponent() gives the quantile per component of the sample */
Field ProcessSample::computeQuantilePerComponent(const Scalar prob) const
{
  return getImplementation()->computeQuantilePerComponent(prob);
}

ProcessSample ProcessSample::computeQuantilePerComponent(const Point & prob) const
{
  return getImplementation()->computeQuantilePerComponent(prob);
}

/* Get the i-th marginal process sample */
ProcessSample ProcessSample::getMarginal(const UnsignedInteger index) const
{
  return getImplementation()->getMarginal(index);
}

/* Get the marginal field corresponding to indices dimensions */
ProcessSample ProcessSample::getMarginal(const Indices & indices) const
{
  return getImplementation()->getMarginal(indices);
}

/* Draw a marginal */
Graph ProcessSample::drawMarginal(const UnsignedInteger index,
                                  const Bool interpolate) const
{
  return getImplementation()->drawMarginal(index, interpolate);
}

/* Draw all marginals */
GridLayout ProcessSample::draw(const Bool interpolate) const
{
  return getImplementation()->draw(interpolate);
}

/* Draw correlation between 2 marginals */
Graph ProcessSample::drawMarginalCorrelation(const UnsignedInteger i,
    const UnsignedInteger j) const
{
  return getImplementation()->drawMarginalCorrelation(i, j);
}

/* Draw correlation between all marginals */
GridLayout ProcessSample::drawCorrelation() const
{
  return getImplementation()->drawCorrelation();
}

/* Comparison operator */
Bool ProcessSample::operator ==(const ProcessSample & other) const
{
  return *getImplementation() == *(other.getImplementation());
}

/* In place sum operator between process sample and sample */
ProcessSample & ProcessSample::operator += (const Sample & translation)
{
  copyOnWrite();
  getImplementation()->operator +=(translation);
  return *this;
}

/* In place difference operator between process sample and sample */
ProcessSample & ProcessSample::operator -= (const Sample & translation)
{
  copyOnWrite();
  getImplementation()->operator -=(translation);
  return *this;
}

/* In place sum operator between process sample and point */
ProcessSample & ProcessSample::operator += (const Point & translation)
{
  copyOnWrite();
  getImplementation()->operator +=(translation);
  return *this;
}

/* In place difference operator between process sample and point */
ProcessSample & ProcessSample::operator -= (const Point & translation)
{
  copyOnWrite();
  getImplementation()->operator -=(translation);
  return *this;
}

/* In place sum operator between process sample and process sample */
ProcessSample & ProcessSample::operator += (const ProcessSample & translation)
{
  copyOnWrite();
  getImplementation()->operator +=(*translation.getImplementation());
  return *this;
}

/* In place difference operator between process sample and process sample */
ProcessSample & ProcessSample::operator -= (const ProcessSample & translation)
{
  copyOnWrite();
  getImplementation()->operator -=(*translation.getImplementation());
  return *this;
}

/* Sum operator between process sample and sample */
ProcessSample ProcessSample::operator + (const Sample & translation) const
{
  ProcessSample processSample(getImplementation());
  processSample += translation;
  return processSample;
}

/* Difference operator between process sample and sample */
ProcessSample ProcessSample::operator - (const Sample & translation) const
{
  ProcessSample processSample(getImplementation());
  processSample -= translation;
  return processSample;
}

/* Sum operator between process sample and point */
ProcessSample ProcessSample::operator + (const Point & translation) const
{
  ProcessSample processSample(getImplementation());
  processSample += translation;
  return processSample;
}

/* Difference operator between process sample and point */
ProcessSample ProcessSample::operator - (const Point & translation) const
{
  ProcessSample processSample(getImplementation());
  processSample -= translation;
  return processSample;
}

/* Sum operator between process sample and process sample */
ProcessSample ProcessSample::operator + (const ProcessSample & translation) const
{
  ProcessSample processSample(getImplementation());
  processSample += translation;
  return processSample;
}

/* Difference operator between process sample and process sample */
ProcessSample ProcessSample::operator - (const ProcessSample & translation) const
{
  ProcessSample processSample(getImplementation());
  processSample -= translation;
  return processSample;
}


Sample ProcessSample::getSampleAtVertex(const UnsignedInteger index) const
{
  return getImplementation()->getSampleAtVertex(index);
}

END_NAMESPACE_OPENTURNS
