LatAnalyze/lib/XYSampleData.hpp

/*
 * XYSampleData.hpp, part of LatAnalyze 3
 *
 * Copyright (C) 2013 - 2015 Antonin Portelli
 *
 * LatAnalyze 3 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * LatAnalyze 3 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with LatAnalyze 3.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef Latan_XYSampleData_hpp_
#define Latan_XYSampleData_hpp_

#include <LatAnalyze/Global.hpp>
#include <LatAnalyze/FitInterface.hpp>
#include <LatAnalyze/Function.hpp>
#include <LatAnalyze/MatSample.hpp>
#include <LatAnalyze/Minimizer.hpp>
#include <LatAnalyze/XYStatData.hpp>

BEGIN_LATAN_NAMESPACE

/******************************************************************************
 *                            object for fit result                           *
 ******************************************************************************/
class SampleFitResult: public DMatSample
{
    friend class XYSampleData;
public:
    // constructors
    SampleFitResult(void) = default;
    EIGEN_EXPR_CTOR(SampleFitResult, SampleFitResult, DMatSample, ArrayExpr)
    // destructor
    virtual ~SampleFitResult(void) = default;
    // access
    double                       getChi2(const Index s = central) const;
    const DSample &              getChi2(const PlaceHolder ph) const;
    double                       getChi2PerDof(const Index s = central) const;
    DSample                      getChi2PerDof(const PlaceHolder ph) const;
    double                       getNDof(void) const;
    const DoubleFunction &       getModel(const Index s = central,
                                          const Index j = 0) const;
    const DoubleFunctionSample & getModel(const PlaceHolder ph,
                                          const Index j = 0) const;
    FitResult                    getFitResult(const Index s = central) const;
private:
    DSample                           chi2_;
    double                            nDof_{0.};
    std::vector<DoubleFunctionSample> model_;
};

/******************************************************************************
 *                            XYSampleData                                    *
 ******************************************************************************
 * index convention: i: X, j: Y, k: data
 */
class XYSampleData: public FitInterface
{
public:
    typedef DMatSample::Block      SampleBlock;
    typedef DMatSample::ConstBlock ConstSampleBlock;
public:
    // constructors
    XYSampleData(void) = default;
    XYSampleData(const Index nData, const Index xDim, const Index yDim,
                 const Index nSample);
    // destructor
    virtual ~XYSampleData(void) = default;
    // access
    const XYStatData & getData(const Index s = central);
    void             resize(const Index nData, const Index xDim,
                            const Index yDim, const Index nSample);
    SampleBlock      x(const PlaceHolder ph1 = _, const PlaceHolder ph2 = _);
    ConstSampleBlock x(const PlaceHolder ph1 = _,
                       const PlaceHolder ph2 = _) const;
    SampleBlock      x(const Index i, const PlaceHolder ph2 = _);
    ConstSampleBlock x(const Index i, const PlaceHolder ph2 = _) const;
    SampleBlock      x(const PlaceHolder ph1, const Index k);
    ConstSampleBlock x(const PlaceHolder ph1, const Index k) const;
    SampleBlock      x(const Index i, const Index k);
    ConstSampleBlock x(const Index i, const Index k) const;
    SampleBlock      y(const PlaceHolder ph1 = _, const PlaceHolder ph2 = _);
    ConstSampleBlock y(const PlaceHolder ph1 = _,
                       const PlaceHolder ph2 = _) const;
    SampleBlock      y(const Index j, const PlaceHolder ph2 = _);
    ConstSampleBlock y(const Index j, const PlaceHolder ph2 = _) const;
    SampleBlock      y(const PlaceHolder ph1, const Index k);
    ConstSampleBlock y(const PlaceHolder ph1, const Index k) const;
    SampleBlock      y(const Index j, const Index k);
    ConstSampleBlock y(const Index j, const Index k) const;
    // fit
    SampleFitResult fit(Minimizer &minimizer, const DVec &init,
                        const std::vector<const DoubleModel *> &modelVector);
    template <typename... Mods>
    SampleFitResult fit(Minimizer &minimizer, const DVec &init,
                        const DoubleModel &model, const Mods... models);
    // residuals
    XYSampleData getResiduals(const SampleFitResult &fit) const;
    XYSampleData getPartialResiduals(const SampleFitResult &fit, const DVec &x,
                                     const Index j) const;
private:
    void setDataToSample(const Index s);
private:
    bool isCovarianceInit_;
    DMatSample x_, y_;
    XYStatData data_;
};

/******************************************************************************
 *                    XYSampleData template implementation                    *
 ******************************************************************************/
template <typename... Ts>
SampleFitResult XYSampleData::fit(Minimizer &minimizer, const DVec &init,
                                  const DoubleModel &model, const Ts... models)
{
    static_assert(static_or<std::is_assignable<DoubleModel &, Ts>::value...>::value,
                  "model arguments are not compatible with DoubleModel &");
    
    std::vector<const DoubleModel *> modelVector{&model, &models...};
    
    return fit(minimizer, init, modelVector);
}

END_LATAN_NAMESPACE

#endif // Latan_XYSampleData_hpp_